sockfile.cpp 213 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521
  1. /*##############################################################################
  2. HPCC SYSTEMS software Copyright (C) 2012 HPCC Systems®.
  3. Licensed under the Apache License, Version 2.0 (the "License");
  4. you may not use this file except in compliance with the License.
  5. You may obtain a copy of the License at
  6. http://www.apache.org/licenses/LICENSE-2.0
  7. Unless required by applicable law or agreed to in writing, software
  8. distributed under the License is distributed on an "AS IS" BASIS,
  9. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  10. See the License for the specific language governing permissions and
  11. limitations under the License.
  12. ############################################################################## */
  13. // todo look at IRemoteFileServer stop
  14. #include "platform.h"
  15. #include "limits.h"
  16. #include "jlib.hpp"
  17. #include "jio.hpp"
  18. #include "jmutex.hpp"
  19. #include "jfile.hpp"
  20. #include "jmisc.hpp"
  21. #include "jthread.hpp"
  22. #include "jqueue.tpp"
  23. #include "securesocket.hpp"
  24. #include "sockfile.hpp"
  25. #include "portlist.h"
  26. #include "jsocket.hpp"
  27. #include "jencrypt.hpp"
  28. #include "jset.hpp"
  29. #include "jhtree.hpp"
  30. #include "remoteerr.hpp"
  31. #include <atomic>
  32. #define SOCKET_CACHE_MAX 500
  33. #define MIN_KEYFILTSUPPORT_VERSION 20
  34. #ifdef _DEBUG
  35. //#define SIMULATE_PACKETLOSS 1
  36. #endif
  37. #define TREECOPYTIMEOUT (60*60*1000) // 1Hr (I guess could take longer for big file but at least will stagger)
  38. #define TREECOPYPOLLTIME (60*1000*5) // for tracing that delayed
  39. #define TREECOPYPRUNETIME (24*60*60*1000) // 1 day
  40. #if SIMULATE_PACKETLOSS
  41. #define TESTING_FAILURE_RATE_LOST_SEND 10 // per 1000
  42. #define TESTING_FAILURE_RATE_LOST_RECV 10 // per 1000
  43. #define DUMMY_TIMEOUT_MAX (1000*10)
  44. static bool errorSimulationOn = true;
  45. static ISocket *timeoutreadsock = NULL; // used to trigger
  46. struct dummyReadWrite
  47. {
  48. class X
  49. {
  50. dummyReadWrite *parent;
  51. public:
  52. X(dummyReadWrite *_parent)
  53. {
  54. parent = _parent;
  55. }
  56. ~X()
  57. {
  58. delete parent;
  59. }
  60. };
  61. class TimeoutSocketException: public CInterface, public IJSOCK_Exception
  62. {
  63. public:
  64. IMPLEMENT_IINTERFACE;
  65. TimeoutSocketException()
  66. {
  67. }
  68. virtual ~TimeoutSocketException()
  69. {
  70. }
  71. int errorCode() const { return JSOCKERR_timeout_expired; }
  72. StringBuffer & errorMessage(StringBuffer &str) const
  73. {
  74. return str.append("timeout expired");
  75. }
  76. MessageAudience errorAudience() const
  77. {
  78. return MSGAUD_user;
  79. }
  80. };
  81. ISocket *sock;
  82. dummyReadWrite(ISocket *_sock)
  83. {
  84. sock = _sock;
  85. }
  86. void readtms(void* buf, size32_t min_size, size32_t max_size, size32_t &size_read, time_t timeout)
  87. {
  88. X x(this);
  89. unsigned t = msTick();
  90. unsigned r = getRandom();
  91. bool timeoutread = (timeoutreadsock==sock);
  92. timeoutreadsock=NULL;
  93. if (!timeoutread)
  94. sock->readtms(buf, min_size, max_size, size_read, timeout);
  95. if (timeoutread||(errorSimulationOn&&(TESTING_FAILURE_RATE_LOST_RECV>0)&&(r%1000<TESTING_FAILURE_RATE_LOST_RECV))) {
  96. PrintStackReport();
  97. if (timeoutread)
  98. PROGLOG("** Simulate timeout");
  99. else
  100. PROGLOG("** Simulate Packet loss (size %d,%d)",min_size,max_size);
  101. if (timeout>DUMMY_TIMEOUT_MAX)
  102. timeout = DUMMY_TIMEOUT_MAX;
  103. t = msTick()-t;
  104. if (t<timeout)
  105. Sleep(timeout-t);
  106. IJSOCK_Exception *e = new TimeoutSocketException;
  107. throw e;
  108. }
  109. }
  110. size32_t write(void const* buf, size32_t size)
  111. {
  112. X x(this);
  113. timeoutreadsock=NULL;
  114. unsigned r = getRandom();
  115. if (errorSimulationOn&&(TESTING_FAILURE_RATE_LOST_SEND>0)&&(r%1000<TESTING_FAILURE_RATE_LOST_SEND)) {
  116. PrintStackReport();
  117. PROGLOG("** Simulate Packet loss (size %d)",size);
  118. timeoutreadsock=sock;
  119. return size;
  120. }
  121. return sock->write(buf,size);
  122. }
  123. };
  124. #define SOCKWRITE(sock) (new dummyReadWrite(sock))->write
  125. #define SOCKREADTMS(sock) (new dummyReadWrite(sock))->readtms
  126. #else
  127. #define SOCKWRITE(sock) sock->write
  128. #define SOCKREADTMS(sock) sock->readtms
  129. #endif
  130. // backward compatible modes
  131. typedef enum { compatIFSHnone, compatIFSHread, compatIFSHwrite, compatIFSHexec, compatIFSHall} compatIFSHmode;
  132. static const char *VERSTRING= "DS V2.1" // dont forget FILESRV_VERSION in header
  133. #ifdef _WIN32
  134. "Windows ";
  135. #else
  136. "Linux ";
  137. #endif
  138. typedef unsigned char RemoteFileCommandType;
  139. typedef int RemoteFileIOHandle;
  140. static unsigned maxConnectTime = 0;
  141. static unsigned maxReceiveTime = 0;
  142. //Security and default port attributes
  143. static class _securitySettings
  144. {
  145. public:
  146. SSLCfg useSSL;
  147. unsigned short daFileSrvPort;
  148. unsigned short daFileSrvSSLPort;
  149. const char * certificate;
  150. const char * privateKey;
  151. const char * passPhrase;
  152. _securitySettings()
  153. {
  154. queryDafsSecSettings(&useSSL, &daFileSrvPort, &daFileSrvSSLPort, &certificate, &privateKey, &passPhrase);
  155. }
  156. } securitySettings;
  157. static CriticalSection secureContextCrit;
  158. static Owned<ISecureSocketContext> secureContext;
  159. #ifdef _USE_OPENSSL
  160. static ISecureSocket *createSecureSocket(ISocket *sock,SecureSocketType type)
  161. {
  162. {
  163. CriticalBlock b(secureContextCrit);
  164. if (!secureContext)
  165. {
  166. if (securitySettings.certificate)
  167. secureContext.setown(createSecureSocketContextEx(securitySettings.certificate, securitySettings.privateKey, securitySettings.passPhrase, type));
  168. else
  169. secureContext.setown(createSecureSocketContext(type));
  170. }
  171. }
  172. #ifdef _DEBUG
  173. return secureContext->createSecureSocket(sock, SSLogMax);
  174. #else
  175. return secureContext->createSecureSocket(sock);
  176. #endif
  177. }
  178. #endif
  179. void clientSetRemoteFileTimeouts(unsigned maxconnecttime,unsigned maxreadtime)
  180. {
  181. maxConnectTime = maxconnecttime;
  182. maxReceiveTime = maxreadtime;
  183. }
  184. struct sRFTM
  185. {
  186. CTimeMon *timemon;
  187. sRFTM(unsigned limit) { timemon = limit ? new CTimeMon(limit) : NULL; }
  188. ~sRFTM() { delete timemon; }
  189. };
  190. const char *remoteServerVersionString() { return VERSTRING; }
  191. static bool AuthenticationEnabled = true;
  192. bool enableDafsAuthentication(bool on)
  193. {
  194. bool ret = AuthenticationEnabled;
  195. AuthenticationEnabled = on;
  196. return ret;
  197. }
  198. #define CLIENT_TIMEOUT (1000*60*60*12) // long timeout in case zombies
  199. #define CLIENT_INACTIVEWARNING_TIMEOUT (1000*60*60*12) // time between logging inactive clients
  200. #define SERVER_TIMEOUT (1000*60*5) // timeout when waiting for dafilesrv to reply after command
  201. // (increased when waiting for large block)
  202. #define DAFS_CONNECT_FAIL_RETRY_TIME (1000*60*15)
  203. #ifdef SIMULATE_PACKETLOSS
  204. #define NORMAL_RETRIES (1)
  205. #define LENGTHY_RETRIES (1)
  206. #else
  207. #define NORMAL_RETRIES (3)
  208. #define LENGTHY_RETRIES (12)
  209. #endif
  210. #ifdef _DEBUG
  211. static byte traceFlags=0x30;
  212. #else
  213. static byte traceFlags=0x20;
  214. #endif
  215. #define TF_TRACE (traceFlags&1)
  216. #define TF_TRACE_PRE_IO (traceFlags&2)
  217. #define TF_TRACE_FULL (traceFlags&4)
  218. #define TF_TRACE_CLIENT_CONN (traceFlags&8)
  219. #define TF_TRACE_TREE_COPY (traceFlags&0x10)
  220. #define TF_TRACE_CLIENT_STATS (traceFlags&0x20)
  221. enum {
  222. RFCopenIO, // 0
  223. RFCcloseIO,
  224. RFCread,
  225. RFCwrite,
  226. RFCsize,
  227. RFCexists,
  228. RFCremove,
  229. RFCrename,
  230. RFCgetver,
  231. RFCisfile,
  232. RFCisdirectory, // 10
  233. RFCisreadonly,
  234. RFCsetreadonly,
  235. RFCgettime,
  236. RFCsettime,
  237. RFCcreatedir,
  238. RFCgetdir,
  239. RFCstop,
  240. RFCexec, // legacy cmd removed
  241. RFCdummy1, // legacy placeholder
  242. RFCredeploy, // 20
  243. RFCgetcrc,
  244. RFCmove,
  245. // 1.5 features below
  246. RFCsetsize,
  247. RFCextractblobelements,
  248. RFCcopy,
  249. RFCappend,
  250. RFCmonitordir,
  251. RFCsettrace,
  252. RFCgetinfo,
  253. RFCfirewall, // not used currently // 30
  254. RFCunlock,
  255. RFCunlockreply,
  256. RFCinvalid,
  257. RFCcopysection,
  258. // 1.7e
  259. RFCtreecopy,
  260. // 1.7e - 1
  261. RFCtreecopytmp,
  262. // 1.8
  263. RFCsetthrottle, // legacy version
  264. // 1.9
  265. RFCsetthrottle2,
  266. RFCsetfileperms,
  267. // 2.0
  268. RFCreadfilteredindex,
  269. RFCreadfilteredindexcount,
  270. RFCreadfilteredindexblob,
  271. RFCmax,
  272. RFCunknown = 255 // 0 would have been more sensible, but can't break backward compatibility
  273. };
  274. #define RFCText(cmd) #cmd
  275. const char *RFCStrings[] =
  276. {
  277. RFCText(RFCopenIO),
  278. RFCText(RFCcloseIO),
  279. RFCText(RFCread),
  280. RFCText(RFCwrite),
  281. RFCText(RFCsize),
  282. RFCText(RFCexists),
  283. RFCText(RFCremove),
  284. RFCText(RFCrename),
  285. RFCText(RFCgetver),
  286. RFCText(RFCisfile),
  287. RFCText(RFCisdirectory),
  288. RFCText(RFCisreadonly),
  289. RFCText(RFCsetreadonly),
  290. RFCText(RFCgettime),
  291. RFCText(RFCsettime),
  292. RFCText(RFCcreatedir),
  293. RFCText(RFCgetdir),
  294. RFCText(RFCstop),
  295. RFCText(RFCexec),
  296. RFCText(RFCdummy1),
  297. RFCText(RFCredeploy),
  298. RFCText(RFCgetcrc),
  299. RFCText(RFCmove),
  300. RFCText(RFCsetsize),
  301. RFCText(RFCextractblobelements),
  302. RFCText(RFCcopy),
  303. RFCText(RFCappend),
  304. RFCText(RFCmonitordir),
  305. RFCText(RFCsettrace),
  306. RFCText(RFCgetinfo),
  307. RFCText(RFCfirewall),
  308. RFCText(RFCunlock),
  309. RFCText(RFCunlockreply),
  310. RFCText(RFCinvalid),
  311. RFCText(RFCcopysection),
  312. RFCText(RFCtreecopy),
  313. RFCText(RFCtreecopytmp),
  314. RFCText(RFCsetthrottle), // legacy version
  315. RFCText(RFCsetthrottle2),
  316. RFCText(RFCsetfileperms),
  317. RFCText(RFCreadfilteredindex),
  318. RFCText(RFCreadfilteredcount),
  319. RFCText(RFCreadfilteredblob),
  320. RFCText(RFCunknown),
  321. };
  322. static const char *getRFCText(RemoteFileCommandType cmd)
  323. {
  324. if (cmd > RFCmax)
  325. cmd = RFCmax;
  326. return RFCStrings[cmd];
  327. }
  328. static const char *getRFSERRText(unsigned err)
  329. {
  330. switch (err)
  331. {
  332. case RFSERR_InvalidCommand:
  333. return "RFSERR_InvalidCommand";
  334. case RFSERR_NullFileIOHandle:
  335. return "RFSERR_NullFileIOHandle";
  336. case RFSERR_InvalidFileIOHandle:
  337. return "RFSERR_InvalidFileIOHandle";
  338. case RFSERR_TimeoutFileIOHandle:
  339. return "RFSERR_TimeoutFileIOHandle";
  340. case RFSERR_OpenFailed:
  341. return "RFSERR_OpenFailed";
  342. case RFSERR_ReadFailed:
  343. return "RFSERR_ReadFailed";
  344. case RFSERR_WriteFailed:
  345. return "RFSERR_WriteFailed";
  346. case RFSERR_RenameFailed:
  347. return "RFSERR_RenameFailed";
  348. case RFSERR_ExistsFailed:
  349. return "RFSERR_ExistsFailed";
  350. case RFSERR_RemoveFailed:
  351. return "RFSERR_RemoveFailed";
  352. case RFSERR_CloseFailed:
  353. return "RFSERR_CloseFailed";
  354. case RFSERR_IsFileFailed:
  355. return "RFSERR_IsFileFailed";
  356. case RFSERR_IsDirectoryFailed:
  357. return "RFSERR_IsDirectoryFailed";
  358. case RFSERR_IsReadOnlyFailed:
  359. return "RFSERR_IsReadOnlyFailed";
  360. case RFSERR_SetReadOnlyFailed:
  361. return "RFSERR_SetReadOnlyFailed";
  362. case RFSERR_GetTimeFailed:
  363. return "RFSERR_GetTimeFailed";
  364. case RFSERR_SetTimeFailed:
  365. return "RFSERR_SetTimeFailed";
  366. case RFSERR_CreateDirFailed:
  367. return "RFSERR_CreateDirFailed";
  368. case RFSERR_GetDirFailed:
  369. return "RFSERR_GetDirFailed";
  370. case RFSERR_GetCrcFailed:
  371. return "RFSERR_GetCrcFailed";
  372. case RFSERR_MoveFailed:
  373. return "RFSERR_MoveFailed";
  374. case RFSERR_ExtractBlobElementsFailed:
  375. return "RFSERR_ExtractBlobElementsFailed";
  376. case RFSERR_CopyFailed:
  377. return "RFSERR_CopyFailed";
  378. case RFSERR_AppendFailed:
  379. return "RFSERR_AppendFailed";
  380. case RFSERR_AuthenticateFailed:
  381. return "RFSERR_AuthenticateFailed";
  382. case RFSERR_CopySectionFailed:
  383. return "RFSERR_CopySectionFailed";
  384. case RFSERR_TreeCopyFailed:
  385. return "RFSERR_TreeCopyFailed";
  386. case RAERR_InvalidUsernamePassword:
  387. return "RAERR_InvalidUsernamePassword";
  388. case RFSERR_MasterSeemsToHaveDied:
  389. return "RFSERR_MasterSeemsToHaveDied";
  390. case RFSERR_TimeoutWaitSlave:
  391. return "RFSERR_TimeoutWaitSlave";
  392. case RFSERR_TimeoutWaitConnect:
  393. return "RFSERR_TimeoutWaitConnect";
  394. case RFSERR_TimeoutWaitMaster:
  395. return "RFSERR_TimeoutWaitMaster";
  396. case RFSERR_NoConnectSlave:
  397. return "RFSERR_NoConnectSlave";
  398. case RFSERR_NoConnectSlaveXY:
  399. return "RFSERR_NoConnectSlaveXY";
  400. case RFSERR_VersionMismatch:
  401. return "RFSERR_VersionMismatch";
  402. case RFSERR_SetThrottleFailed:
  403. return "RFSERR_SetThrottleFailed";
  404. case RFSERR_MaxQueueRequests:
  405. return "RFSERR_MaxQueueRequests";
  406. case RFSERR_KeyIndexFailed:
  407. return "RFSERR_MaxQueueRequests";
  408. }
  409. return "RFSERR_Unknown";
  410. }
  411. #define ThrottleText(throttleClass) #throttleClass
  412. const char *ThrottleStrings[] =
  413. {
  414. ThrottleText(ThrottleStd),
  415. ThrottleText(ThrottleSlow),
  416. };
  417. // very high upper limits that configure can't exceed
  418. #define THROTTLE_MAX_LIMIT 1000000
  419. #define THROTTLE_MAX_DELAYMS 3600000
  420. #define THROTTLE_MAX_CPUTHRESHOLD 100
  421. #define THROTTLE_MAX_QUEUELIMIT 10000000
  422. static const char *getThrottleClassText(ThrottleClass throttleClass) { return ThrottleStrings[throttleClass]; }
  423. typedef enum { ACScontinue, ACSdone, ACSerror} AsyncCommandStatus;
  424. typedef byte OnceKey[16];
  425. static void genOnce(OnceKey &key)
  426. {
  427. static __int64 inc=0;
  428. *(unsigned *)&key[0] = getRandom();
  429. *(__int64 *)&key[4] = ++inc;
  430. *(unsigned *)&key[12] = getRandom();
  431. }
  432. static void mergeOnce(OnceKey &key,size32_t sz,const void *data)
  433. {
  434. assertex(sz<=sizeof(OnceKey));
  435. const byte *p = (const byte *)data;
  436. while (sz)
  437. key[--sz] ^= *(p++);
  438. }
  439. //---------------------------------------------------------------------------
  440. class DECL_EXCEPTION CDafsException: public IDAFS_Exception, public CInterface
  441. {
  442. int errcode;
  443. StringAttr msg;
  444. public:
  445. IMPLEMENT_IINTERFACE;
  446. CDafsException(int code,const char *_msg)
  447. : errcode(code), msg(_msg)
  448. {
  449. };
  450. int errorCode() const
  451. {
  452. return errcode;
  453. }
  454. StringBuffer & errorMessage(StringBuffer &str) const
  455. {
  456. return str.append(msg);
  457. }
  458. MessageAudience errorAudience() const
  459. {
  460. return MSGAUD_user;
  461. }
  462. };
  463. static IDAFS_Exception *createDafsException(int code,const char *msg)
  464. {
  465. return new CDafsException(code,msg);
  466. }
  467. void setDafsEndpointPort(SocketEndpoint &ep)
  468. {
  469. // odd kludge (don't do this at home)
  470. byte ipb[4];
  471. if (ep.getNetAddress(sizeof(ipb),&ipb)==sizeof(ipb)) {
  472. if ((ipb[0]==255)&&(ipb[1]==255)) {
  473. ep.port = (((unsigned)ipb[2])<<8)+ipb[3];
  474. ep.ipset(queryLocalIP());
  475. }
  476. }
  477. if (ep.port==0)
  478. {
  479. if ( (securitySettings.useSSL == SSLNone) || (securitySettings.useSSL == UnsecureFirst) )
  480. ep.port = securitySettings.daFileSrvPort;
  481. else
  482. ep.port = securitySettings.daFileSrvSSLPort;
  483. }
  484. }
  485. inline MemoryBuffer & initSendBuffer(MemoryBuffer & buff)
  486. {
  487. buff.setEndian(__BIG_ENDIAN); // transfer as big endian...
  488. buff.append((unsigned)0); // reserve space for length prefix
  489. return buff;
  490. }
  491. inline void sendBuffer(ISocket * socket, MemoryBuffer & src)
  492. {
  493. unsigned length = src.length() - sizeof(unsigned);
  494. byte * buffer = (byte *)src.toByteArray();
  495. if (TF_TRACE_FULL)
  496. PROGLOG("sendBuffer size %d, data = %d %d %d %d",length, (int)buffer[4],(int)buffer[5],(int)buffer[6],(int)buffer[7]);
  497. _WINCPYREV(buffer, &length, sizeof(unsigned));
  498. SOCKWRITE(socket)(buffer, src.length());
  499. }
  500. inline size32_t receiveBufferSize(ISocket * socket, unsigned numtries=NORMAL_RETRIES,CTimeMon *timemon=NULL)
  501. {
  502. unsigned timeout = SERVER_TIMEOUT;
  503. if (numtries==0) {
  504. numtries = 1;
  505. timeout = 10*1000; // 10s
  506. }
  507. while (numtries--) {
  508. try {
  509. if (timemon) {
  510. unsigned remaining;
  511. if (timemon->timedout(&remaining)||(remaining<10))
  512. remaining = 10;
  513. if (remaining<timeout)
  514. timeout = remaining;
  515. }
  516. size32_t szread;
  517. size32_t gotLength;
  518. SOCKREADTMS(socket)(&gotLength, sizeof(gotLength), sizeof(gotLength), szread, timeout);
  519. _WINREV(gotLength);
  520. if (TF_TRACE_FULL)
  521. PROGLOG("receiveBufferSized %d",gotLength);
  522. return gotLength;
  523. }
  524. catch (IJSOCK_Exception *e) {
  525. if ((numtries==0)||(e->errorCode()!=JSOCKERR_timeout_expired)||(timemon&&timemon->timedout())) {
  526. throw;
  527. }
  528. StringBuffer err;
  529. char peername[256];
  530. socket->peer_name(peername,sizeof(peername)-1);
  531. WARNLOG("Remote connection %s: %s",peername,e->errorMessage(err).str()); // why no peername
  532. e->Release();
  533. Sleep(500+getRandom()%1000); // ~1s
  534. }
  535. }
  536. return 0;
  537. }
  538. static void flush(ISocket *socket)
  539. {
  540. MemoryBuffer sendbuf;
  541. initSendBuffer(sendbuf);
  542. sendbuf.append((RemoteFileCommandType)RFCgetver);
  543. sendbuf.append((unsigned)RFCgetver);
  544. MemoryBuffer reply;
  545. size32_t totread=0;
  546. try {
  547. sendBuffer(socket, sendbuf);
  548. char buf[1024];
  549. for (;;) {
  550. Sleep(1000); // breathe
  551. size32_t szread;
  552. SOCKREADTMS(socket)(buf, 1, sizeof(buf), szread, 1000*60);
  553. totread += szread;
  554. }
  555. }
  556. catch (IJSOCK_Exception *e) {
  557. if (totread)
  558. PROGLOG("%d bytes discarded",totread);
  559. if (e->errorCode()!=JSOCKERR_timeout_expired)
  560. EXCLOG(e,"flush");
  561. e->Release();
  562. }
  563. }
  564. inline void receiveBuffer(ISocket * socket, MemoryBuffer & tgt, unsigned numtries=1, size32_t maxsz=0x7fffffff)
  565. // maxsz is a guess at a resonable upper max to catch where protocol error
  566. {
  567. sRFTM tm(maxReceiveTime);
  568. size32_t gotLength = receiveBufferSize(socket, numtries,tm.timemon);
  569. if (gotLength) {
  570. size32_t origlen = tgt.length();
  571. try {
  572. if (gotLength>maxsz) {
  573. StringBuffer msg;
  574. msg.appendf("receiveBuffer maximum block size exceeded %d/%d",gotLength,maxsz);
  575. PrintStackReport();
  576. throw createDafsException(DAFSERR_protocol_failure,msg.str());
  577. }
  578. unsigned timeout = SERVER_TIMEOUT*(numtries?numtries:1);
  579. if (tm.timemon) {
  580. unsigned remaining;
  581. if (tm.timemon->timedout(&remaining)||(remaining<10))
  582. remaining = 10;
  583. if (remaining<timeout)
  584. timeout = remaining;
  585. }
  586. size32_t szread;
  587. SOCKREADTMS(socket)((gotLength<4000)?tgt.reserve(gotLength):tgt.reserveTruncate(gotLength), gotLength, gotLength, szread, timeout);
  588. }
  589. catch (IJSOCK_Exception *e) {
  590. if (e->errorCode()!=JSOCKERR_timeout_expired) {
  591. EXCLOG(e,"receiveBuffer(1)");
  592. PrintStackReport();
  593. if (!tm.timemon||!tm.timemon->timedout())
  594. flush(socket);
  595. }
  596. else {
  597. EXCLOG(e,"receiveBuffer");
  598. PrintStackReport();
  599. }
  600. tgt.setLength(origlen);
  601. throw;
  602. }
  603. catch (IException *e) {
  604. EXCLOG(e,"receiveBuffer(2)");
  605. PrintStackReport();
  606. if (!tm.timemon||!tm.timemon->timedout())
  607. flush(socket);
  608. tgt.setLength(origlen);
  609. throw;
  610. }
  611. }
  612. tgt.setEndian(__BIG_ENDIAN);
  613. }
  614. struct CConnectionRec
  615. {
  616. SocketEndpoint ep;
  617. unsigned tick;
  618. IArrayOf<ISocket> socks; // relies on isShared
  619. };
  620. //---------------------------------------------------------------------------
  621. // Local mount redirect
  622. struct CLocalMountRec: public CInterface
  623. {
  624. IpAddress ip;
  625. StringAttr dir; // dir path on remote ip
  626. StringAttr local; // local dir path
  627. };
  628. static CIArrayOf<CLocalMountRec> localMounts;
  629. static CriticalSection localMountCrit;
  630. void setDafsLocalMountRedirect(const IpAddress &ip,const char *dir,const char *mountdir)
  631. {
  632. CriticalBlock block(localMountCrit);
  633. ForEachItemInRev(i,localMounts) {
  634. CLocalMountRec &mount = localMounts.item(i);
  635. if (dir==NULL) { // remove all matching mount
  636. if (!mountdir)
  637. return;
  638. if (strcmp(mount.local,mountdir)==0)
  639. localMounts.remove(i);
  640. }
  641. else if (mount.ip.ipequals(ip)&&(strcmp(mount.dir,dir)==0)) {
  642. if (mountdir) {
  643. mount.local.set(mountdir);
  644. return;
  645. }
  646. else
  647. localMounts.remove(i);
  648. }
  649. }
  650. if (dir&&mountdir) {
  651. CLocalMountRec &mount = *new CLocalMountRec;
  652. mount.ip.ipset(ip);
  653. mount.dir.set(dir);
  654. mount.local.set(mountdir);
  655. localMounts.append(mount);
  656. }
  657. }
  658. IFile *createFileLocalMount(const IpAddress &ip, const char * filename)
  659. {
  660. CriticalBlock block(localMountCrit);
  661. ForEachItemInRev(i,localMounts) {
  662. CLocalMountRec &mount = localMounts.item(i);
  663. if (mount.ip.ipequals(ip)) {
  664. size32_t bl = mount.dir.length();
  665. if (isPathSepChar(mount.dir[bl-1]))
  666. bl--;
  667. if ((memcmp((void *)filename,(void *)mount.dir.get(),bl)==0)&&(isPathSepChar(filename[bl])||!filename[bl])) { // match
  668. StringBuffer locpath(mount.local);
  669. if (filename[bl])
  670. addPathSepChar(locpath).append(filename+bl+1);
  671. locpath.replace((PATHSEPCHAR=='\\')?'/':'\\',PATHSEPCHAR);
  672. return createIFile(locpath.str());
  673. }
  674. }
  675. }
  676. return NULL;
  677. }
  678. //---------------------------------------------------------------------------
  679. static class CConnectionTable: public SuperHashTableOf<CConnectionRec,SocketEndpoint>
  680. {
  681. void onAdd(void *) {}
  682. void onRemove(void *e)
  683. {
  684. CConnectionRec *r=(CConnectionRec *)e;
  685. delete r;
  686. }
  687. unsigned getHashFromElement(const void *e) const
  688. {
  689. const CConnectionRec &elem=*(const CConnectionRec *)e;
  690. return elem.ep.hash(0);
  691. }
  692. unsigned getHashFromFindParam(const void *fp) const
  693. {
  694. return ((const SocketEndpoint *)fp)->hash(0);
  695. }
  696. const void * getFindParam(const void *p) const
  697. {
  698. const CConnectionRec &elem=*(const CConnectionRec *)p;
  699. return (void *)&elem.ep;
  700. }
  701. bool matchesFindParam(const void * et, const void *fp, unsigned) const
  702. {
  703. return ((CConnectionRec *)et)->ep.equals(*(SocketEndpoint *)fp);
  704. }
  705. IMPLEMENT_SUPERHASHTABLEOF_REF_FIND(CConnectionRec,SocketEndpoint);
  706. unsigned numsockets;
  707. public:
  708. static CriticalSection crit;
  709. CConnectionTable()
  710. {
  711. numsockets = 0;
  712. }
  713. ~CConnectionTable() {
  714. _releaseAll();
  715. }
  716. ISocket *lookup(const SocketEndpoint &ep)
  717. {
  718. // always called from crit block
  719. CConnectionRec *r = SuperHashTableOf<CConnectionRec,SocketEndpoint>::find(&ep);
  720. if (r) {
  721. ForEachItemIn(i,r->socks) {
  722. ISocket *s = &r->socks.item(i);
  723. if (!QUERYINTERFACE(s, CInterface)->IsShared()) {
  724. r->tick = msTick();
  725. s->Link();
  726. return s;
  727. }
  728. }
  729. }
  730. return NULL;
  731. }
  732. void addLink(SocketEndpoint &ep,ISocket *sock)
  733. {
  734. // always called from crit block
  735. while (numsockets>=SOCKET_CACHE_MAX) {
  736. // find oldest
  737. CConnectionRec *c = NULL;
  738. unsigned oldest = 0;
  739. CConnectionRec *old = NULL;
  740. unsigned oldi;
  741. unsigned now = msTick();
  742. for (;;) {
  743. c = (CConnectionRec *)SuperHashTableOf<CConnectionRec,SocketEndpoint>::next(c);
  744. if (!c)
  745. break;
  746. ForEachItemIn(i,c->socks) {
  747. ISocket *s = &c->socks.item(i);
  748. if (!QUERYINTERFACE(s, CInterface)->IsShared()) { // candidate to remove
  749. unsigned t = now-c->tick;
  750. if (t>oldest) {
  751. oldest = t;
  752. old = c;
  753. oldi = i;
  754. }
  755. }
  756. }
  757. }
  758. if (!old)
  759. return;
  760. old->socks.remove(oldi);
  761. numsockets--;
  762. }
  763. CConnectionRec *r = SuperHashTableOf<CConnectionRec,SocketEndpoint>::find(&ep);
  764. if (!r) {
  765. r = new CConnectionRec;
  766. r->ep = ep;
  767. SuperHashTableOf<CConnectionRec,SocketEndpoint>::add(*r);
  768. }
  769. sock->Link();
  770. r->socks.append(*sock);
  771. numsockets++;
  772. r->tick = msTick();
  773. }
  774. void remove(SocketEndpoint &ep,ISocket *sock)
  775. {
  776. // always called from crit block
  777. CConnectionRec *r = SuperHashTableOf<CConnectionRec,SocketEndpoint>::find(&ep);
  778. if (r)
  779. if (r->socks.zap(*sock)&&numsockets)
  780. numsockets--;
  781. }
  782. } *ConnectionTable = NULL;
  783. CriticalSection CConnectionTable::crit;
  784. void clientSetDaliServixSocketCaching(bool on)
  785. {
  786. CriticalBlock block(CConnectionTable::crit);
  787. if (on) {
  788. if (!ConnectionTable)
  789. ConnectionTable = new CConnectionTable;
  790. }
  791. else {
  792. delete ConnectionTable;
  793. ConnectionTable = NULL;
  794. }
  795. }
  796. //---------------------------------------------------------------------------
  797. // TreeCopy
  798. #define TREECOPY_CACHE_SIZE 50
  799. struct CTreeCopyItem: public CInterface
  800. {
  801. StringAttr net;
  802. StringAttr mask;
  803. offset_t sz; // original size
  804. CDateTime dt; // original date
  805. RemoteFilenameArray loc; // locations for file - 0 is original
  806. Owned<IBitSet> busy;
  807. unsigned lastused;
  808. CTreeCopyItem(RemoteFilename &orig, const char *_net, const char *_mask, offset_t _sz, CDateTime &_dt)
  809. : net(_net), mask(_mask)
  810. {
  811. loc.append(orig);
  812. dt.set(_dt);
  813. sz = _sz;
  814. busy.setown(createThreadSafeBitSet());
  815. lastused = msTick();
  816. }
  817. bool equals(const RemoteFilename &orig, const char *_net, const char *_mask, offset_t _sz, CDateTime &_dt)
  818. {
  819. if (!orig.equals(loc.item(0)))
  820. return false;
  821. if (strcmp(_net,net)!=0)
  822. return false;
  823. if (strcmp(_mask,mask)!=0)
  824. return false;
  825. if (sz!=_sz)
  826. return false;
  827. return (dt.equals(_dt,false));
  828. }
  829. };
  830. static CIArrayOf<CTreeCopyItem> treeCopyArray;
  831. static CriticalSection treeCopyCrit;
  832. static unsigned treeCopyWaiting=0;
  833. static Semaphore treeCopySem;
  834. #define DEBUGSAMEIP false
  835. //---------------------------------------------------------------------------
  836. class CRemoteBase: public CInterface
  837. {
  838. Owned<ISocket> socket;
  839. static SocketEndpoint lastfailep;
  840. static unsigned lastfailtime;
  841. SSLCfg useSSL;
  842. void connectSocket(SocketEndpoint &ep, unsigned localConnectTime=0, unsigned localRetries=0)
  843. {
  844. unsigned retries = 3;
  845. if (localConnectTime)
  846. {
  847. if (localRetries)
  848. retries = localRetries;
  849. if (localConnectTime > maxConnectTime)
  850. localConnectTime = maxConnectTime;
  851. }
  852. else
  853. localConnectTime = maxConnectTime;
  854. sRFTM tm(localConnectTime);
  855. // called in CConnectionTable::crit
  856. if (ep.equals(lastfailep)) {
  857. if (msTick()-lastfailtime<DAFS_CONNECT_FAIL_RETRY_TIME) {
  858. StringBuffer msg("Failed to connect (host marked down) to dafilesrv/daliservix on ");
  859. ep.getUrlStr(msg);
  860. throw createDafsException(DAFSERR_connection_failed,msg.str());
  861. }
  862. lastfailep.set(NULL);
  863. retries = 1; // on probation
  864. }
  865. while(retries--) {
  866. CriticalUnblock unblock(CConnectionTable::crit); // allow others to connect
  867. StringBuffer eps;
  868. if (TF_TRACE_CLIENT_CONN) {
  869. ep.getUrlStr(eps);
  870. if (ep.port == securitySettings.daFileSrvSSLPort)
  871. PROGLOG("Connecting SECURE to %s", eps.str());
  872. else
  873. PROGLOG("Connecting to %s", eps.str());
  874. //PrintStackReport();
  875. }
  876. bool ok = true;
  877. try {
  878. if (tm.timemon) {
  879. unsigned remaining;
  880. tm.timemon->timedout(&remaining);
  881. socket.setown(ISocket::connect_timeout(ep,remaining));
  882. }
  883. else
  884. socket.setown(ISocket::connect(ep));
  885. if (ep.port == securitySettings.daFileSrvSSLPort)
  886. {
  887. #ifdef _USE_OPENSSL
  888. Owned<ISecureSocket> ssock = createSecureSocket(socket.getClear(), ClientSocket);
  889. int status = ssock->secure_connect();
  890. if (status < 0)
  891. throw createDafsException(DAFSERR_connection_failed,"Failure to establish secure connection");
  892. socket.setown(ssock.getLink());
  893. #else
  894. throw createDafsException(DAFSERR_connection_failed,"Failure to establish secure connection: OpenSSL disabled in build");
  895. #endif
  896. }
  897. }
  898. catch (IJSOCK_Exception *e) {
  899. ok = false;
  900. if (!retries||(tm.timemon&&tm.timemon->timedout())) {
  901. if (e->errorCode()==JSOCKERR_connection_failed) {
  902. lastfailep.set(ep);
  903. lastfailtime = msTick();
  904. e->Release();
  905. StringBuffer msg("Failed to connect (setting host down) to dafilesrv/daliservix on ");
  906. ep.getUrlStr(msg);
  907. throw createDafsException(DAFSERR_connection_failed,msg.str());
  908. }
  909. throw;
  910. }
  911. StringBuffer err;
  912. WARNLOG("Remote file connect %s",e->errorMessage(err).str());
  913. e->Release();
  914. }
  915. if (ok) {
  916. if (TF_TRACE_CLIENT_CONN) {
  917. PROGLOG("Connected to %s",eps.str());
  918. }
  919. if (AuthenticationEnabled) {
  920. try {
  921. sendAuthentication(ep); // this will log error
  922. break;
  923. }
  924. catch (IJSOCK_Exception *e) {
  925. StringBuffer err;
  926. WARNLOG("Remote file authenticate %s for %s ",e->errorMessage(err).str(),ep.getUrlStr(eps.clear()).str());
  927. e->Release();
  928. if (!retries)
  929. break;
  930. }
  931. }
  932. else
  933. break;
  934. }
  935. unsigned sleeptime = getRandom()%3000+1000;
  936. if (tm.timemon) {
  937. unsigned remaining;
  938. tm.timemon->timedout(&remaining);
  939. if (remaining/2<sleeptime)
  940. sleeptime = remaining/2;
  941. }
  942. Sleep(sleeptime); // prevent multiple retries beating
  943. if (ep.port == securitySettings.daFileSrvSSLPort)
  944. PROGLOG("Retrying SECURE connect");
  945. else
  946. PROGLOG("Retrying connect");
  947. }
  948. if (ConnectionTable)
  949. ConnectionTable->addLink(ep,socket);
  950. }
  951. void killSocket(SocketEndpoint &tep)
  952. {
  953. CriticalBlock block2(CConnectionTable::crit); // this is nested with crit
  954. if (socket) {
  955. try {
  956. Owned<ISocket> s = socket.getClear();
  957. if (ConnectionTable)
  958. ConnectionTable->remove(tep,s);
  959. }
  960. catch (IJSOCK_Exception *e) {
  961. e->Release(); // ignore errors closing
  962. }
  963. Sleep(getRandom()%1000*5+500); // prevent multiple beating
  964. }
  965. }
  966. protected: friend class CRemoteFileIO;
  967. StringAttr filename;
  968. CriticalSection crit;
  969. SocketEndpoint ep;
  970. void sendRemoteCommand(MemoryBuffer & src, MemoryBuffer & reply, bool retry=true, bool lengthy=false, bool handleErrCode=true)
  971. {
  972. CriticalBlock block(crit); // serialize commands on same file
  973. SocketEndpoint tep(ep);
  974. setDafsEndpointPort(tep);
  975. unsigned nretries = retry?3:0;
  976. Owned<IJSOCK_Exception> firstexc; // when retrying return first error if fails
  977. for (;;) {
  978. try {
  979. if (socket) {
  980. sendBuffer(socket, src);
  981. receiveBuffer(socket, reply, lengthy?LENGTHY_RETRIES:NORMAL_RETRIES);
  982. break;
  983. }
  984. }
  985. catch (IJSOCK_Exception *e) {
  986. if (!nretries--) {
  987. if (firstexc) {
  988. e->Release();
  989. e = firstexc.getClear();
  990. }
  991. killSocket(tep);
  992. throw e;
  993. }
  994. StringBuffer str;
  995. e->errorMessage(str);
  996. WARNLOG("Remote File: %s, retrying (%d)",str.str(),nretries);
  997. if (firstexc)
  998. e->Release();
  999. else
  1000. firstexc.setown(e);
  1001. killSocket(tep);
  1002. }
  1003. CriticalBlock block2(CConnectionTable::crit); // this is nested with crit
  1004. if (ConnectionTable) {
  1005. socket.setown(ConnectionTable->lookup(tep));
  1006. if (socket) {
  1007. // validate existing socket by sending an 'exists' command with short time out
  1008. // (use exists for backward compatibility)
  1009. bool ok = false;
  1010. try {
  1011. MemoryBuffer sendbuf;
  1012. initSendBuffer(sendbuf);
  1013. MemoryBuffer replybuf;
  1014. sendbuf.append((RemoteFileCommandType)RFCexists).append(filename);
  1015. sendBuffer(socket, sendbuf);
  1016. receiveBuffer(socket, replybuf, 0, 1024);
  1017. ok = true;
  1018. }
  1019. catch (IException *e) {
  1020. e->Release();
  1021. }
  1022. if (!ok)
  1023. killSocket(tep);
  1024. }
  1025. }
  1026. if (!socket)
  1027. {
  1028. bool doConnect = true;
  1029. if (useSSL == SSLFirst || useSSL == UnsecureFirst)
  1030. {
  1031. // MCK - could maintain a list of 100 or so previous endpoints and if connection failed
  1032. // then mark port down for a delay (like 15 min above) to avoid having to try every time ...
  1033. try
  1034. {
  1035. connectSocket(tep, 5000, 1);
  1036. doConnect = false;
  1037. }
  1038. catch (IDAFS_Exception *e)
  1039. {
  1040. if (e->errorCode() == DAFSERR_connection_failed)
  1041. {
  1042. unsigned prevPort = tep.port;
  1043. if (prevPort == securitySettings.daFileSrvSSLPort)
  1044. tep.port = securitySettings.daFileSrvPort;
  1045. else
  1046. tep.port = securitySettings.daFileSrvSSLPort;
  1047. WARNLOG("Connect failed on port %d, retrying on port %d", prevPort, tep.port);
  1048. doConnect = true;
  1049. e->Release();
  1050. }
  1051. else
  1052. throw e;
  1053. }
  1054. }
  1055. if (doConnect)
  1056. connectSocket(tep);
  1057. }
  1058. }
  1059. if (!handleErrCode)
  1060. return;
  1061. unsigned errCode;
  1062. reply.read(errCode);
  1063. if (errCode) {
  1064. StringBuffer msg;
  1065. if (filename.get())
  1066. msg.append(filename);
  1067. ep.getUrlStr(msg.append('[')).append("] ");
  1068. size32_t pos = reply.getPos();
  1069. if (pos<reply.length()) {
  1070. size32_t len = reply.length()-pos;
  1071. const byte *rest = reply.readDirect(len);
  1072. if (errCode==RFSERR_InvalidCommand) {
  1073. const char *s = (const char *)rest;
  1074. const char *e = (const char *)rest+len;
  1075. while (*s&&(s!=e))
  1076. s++;
  1077. msg.append(s-(const char *)rest,(const char *)rest);
  1078. }
  1079. else if (len&&(rest[len-1]==0))
  1080. msg.append((const char *)rest);
  1081. else {
  1082. msg.appendf("extra data[%d]",len);
  1083. for (unsigned i=0;(i<16)&&(i<len);i++)
  1084. msg.appendf(" %2x",(int)rest[i]);
  1085. }
  1086. }
  1087. else if(errCode == 8209)
  1088. msg.append("Failed to open directory.");
  1089. else
  1090. msg.append("ERROR #").append(errCode);
  1091. #ifdef _DEBUG
  1092. ERRLOG("%s",msg.str());
  1093. PrintStackReport();
  1094. #endif
  1095. throw createDafsException(errCode,msg.str());
  1096. }
  1097. }
  1098. void sendRemoteCommand(MemoryBuffer & src, bool retry)
  1099. {
  1100. MemoryBuffer reply;
  1101. sendRemoteCommand(src, reply, retry);
  1102. }
  1103. void throwUnauthenticated(const IpAddress &ip,const char *user,unsigned err=0)
  1104. {
  1105. if (err==0)
  1106. err = RFSERR_AuthenticateFailed;
  1107. StringBuffer msg;
  1108. msg.appendf("Authentication for %s on ",user);
  1109. ip.getIpText(msg);
  1110. msg.append(" failed");
  1111. throw createDafsException(err, msg.str());
  1112. }
  1113. void sendAuthentication(const IpAddress &serverip)
  1114. {
  1115. // send my sig
  1116. // first send my sig which if stream unencrypted will get returned as a bad command
  1117. OnceKey oncekey;
  1118. genOnce(oncekey);
  1119. MemoryBuffer sendbuf;
  1120. initSendBuffer(sendbuf);
  1121. MemoryBuffer replybuf;
  1122. MemoryBuffer encbuf; // because aesEncrypt clears input
  1123. sendbuf.append((RemoteFileCommandType)RFCunlock).append(sizeof(oncekey),&oncekey);
  1124. try {
  1125. sendBuffer(socket, sendbuf);
  1126. receiveBuffer(socket, replybuf, NORMAL_RETRIES, 1024);
  1127. }
  1128. catch (IException *e)
  1129. {
  1130. EXCLOG(e,"Remote file - sendAuthentication(1)");
  1131. throw;
  1132. }
  1133. unsigned errCode;
  1134. replybuf.read(errCode);
  1135. if (errCode!=0) // no authentication required
  1136. return;
  1137. SocketEndpoint ep;
  1138. ep.setLocalHost(0);
  1139. byte ipdata[16];
  1140. size32_t ipds = ep.getNetAddress(sizeof(ipdata),&ipdata);
  1141. mergeOnce(oncekey,ipds,&ipdata);
  1142. StringBuffer username;
  1143. StringBuffer password;
  1144. IPasswordProvider * pp = queryPasswordProvider();
  1145. if (pp)
  1146. pp->getPassword(serverip, username, password);
  1147. if (!username.length())
  1148. username.append("sds_system"); // default account (note if exists should have restricted access!)
  1149. if (!password.length())
  1150. password.append("sds_man");
  1151. if (replybuf.remaining()<=sizeof(size32_t))
  1152. throwUnauthenticated(serverip,username.str());
  1153. size32_t bs;
  1154. replybuf.read(bs);
  1155. if (replybuf.remaining()<bs)
  1156. throwUnauthenticated(serverip,username.str());
  1157. MemoryBuffer skeybuf;
  1158. aesDecrypt(&oncekey,sizeof(oncekey),replybuf.readDirect(bs),bs,skeybuf);
  1159. if (skeybuf.remaining()<sizeof(OnceKey))
  1160. throwUnauthenticated(serverip,username.str());
  1161. OnceKey sokey;
  1162. skeybuf.read(sizeof(OnceKey),&sokey);
  1163. // now we have the key to use to send user/password
  1164. MemoryBuffer tosend;
  1165. tosend.append((byte)2).append(username).append(password);
  1166. initSendBuffer(sendbuf.clear());
  1167. sendbuf.append((RemoteFileCommandType)RFCunlockreply);
  1168. aesEncrypt(&sokey, sizeof(oncekey), tosend.toByteArray(), tosend.length(), encbuf);
  1169. sendbuf.append(encbuf.length());
  1170. sendbuf.append(encbuf);
  1171. try {
  1172. sendBuffer(socket, sendbuf);
  1173. receiveBuffer(socket, replybuf.clear(), NORMAL_RETRIES, 1024);
  1174. }
  1175. catch (IException *e)
  1176. {
  1177. EXCLOG(e,"Remote file - sendAuthentication(2)");
  1178. throw;
  1179. }
  1180. replybuf.read(errCode);
  1181. if (errCode==0) // suceeded!
  1182. return;
  1183. throwUnauthenticated(serverip,username.str(),errCode);
  1184. }
  1185. public:
  1186. SocketEndpoint &queryEp() { return ep; };
  1187. CRemoteBase(const SocketEndpoint &_ep, const char * _filename)
  1188. : filename(_filename)
  1189. {
  1190. ep = _ep;
  1191. useSSL = securitySettings.useSSL;
  1192. }
  1193. void connect()
  1194. {
  1195. CriticalBlock block(crit);
  1196. CriticalBlock block2(CConnectionTable::crit); // this shouldn't ever block
  1197. if (AuthenticationEnabled) {
  1198. SocketEndpoint tep(ep);
  1199. setDafsEndpointPort(tep);
  1200. connectSocket(tep);
  1201. }
  1202. }
  1203. void disconnect()
  1204. {
  1205. CriticalBlock block(crit);
  1206. CriticalBlock block2(CConnectionTable::crit); // this shouldn't ever block
  1207. if (socket)
  1208. {
  1209. ISocket *s = socket.getClear();
  1210. if (ConnectionTable)
  1211. {
  1212. SocketEndpoint tep(ep);
  1213. setDafsEndpointPort(tep);
  1214. ConnectionTable->remove(tep,s);
  1215. }
  1216. ::Release(s);
  1217. }
  1218. }
  1219. const char *queryLocalName()
  1220. {
  1221. return filename;
  1222. }
  1223. };
  1224. SocketEndpoint CRemoteBase::lastfailep;
  1225. unsigned CRemoteBase::lastfailtime;
  1226. //---------------------------------------------------------------------------
  1227. class CRemoteDirectoryIterator : implements IDirectoryDifferenceIterator, public CInterface
  1228. {
  1229. Owned<IFile> cur;
  1230. bool curvalid;
  1231. bool curisdir;
  1232. StringAttr curname;
  1233. CDateTime curdt;
  1234. __int64 cursize;
  1235. StringAttr dir;
  1236. SocketEndpoint ep;
  1237. byte *flags;
  1238. unsigned numflags;
  1239. unsigned curidx;
  1240. unsigned mask;
  1241. MemoryBuffer buf;
  1242. public:
  1243. static CriticalSection crit;
  1244. CRemoteDirectoryIterator(SocketEndpoint &_ep,const char *_dir)
  1245. : dir(_dir)
  1246. {
  1247. // an extended difference iterator starts with 2 (for bwd compatibility)
  1248. ep = _ep;
  1249. curisdir = false;
  1250. curvalid = false;
  1251. cursize = 0;
  1252. curidx = (unsigned)-1;
  1253. mask = 0;
  1254. numflags = 0;
  1255. flags = NULL;
  1256. }
  1257. bool appendBuf(MemoryBuffer &_buf)
  1258. {
  1259. buf.setSwapEndian(_buf.needSwapEndian());
  1260. byte hdr;
  1261. _buf.read(hdr);
  1262. if (hdr==2) {
  1263. _buf.read(numflags);
  1264. flags = (byte *)malloc(numflags);
  1265. _buf.read(numflags,flags);
  1266. }
  1267. else {
  1268. buf.append(hdr);
  1269. flags = NULL;
  1270. numflags = 0;
  1271. }
  1272. size32_t rest = _buf.length()-_buf.getPos();
  1273. const byte *rb = (const byte *)_buf.readDirect(rest);
  1274. bool ret = true;
  1275. // At the last byte of the rb (rb[rest-1]) is the stream live flag
  1276. // True if the stream has more data
  1277. // False at the end of stream
  1278. // The previous byte (rb[rest-2]) is the flag to signal there are more
  1279. // valid entries in this block
  1280. // True if there are valid directory entry follows this flag
  1281. // False if there are no more valid entry in this block aka end of block
  1282. // If there is more data in the stream, the end of block flag should be removed
  1283. if (rest&&(rb[rest-1]!=0))
  1284. {
  1285. rest--; // remove stream live flag
  1286. if(rest && (0 == rb[rest-1]))
  1287. rest--; //Remove end of block flag
  1288. ret = false; // continuation
  1289. }
  1290. buf.append(rest,rb);
  1291. return ret;
  1292. }
  1293. ~CRemoteDirectoryIterator()
  1294. {
  1295. free(flags);
  1296. }
  1297. IMPLEMENT_IINTERFACE
  1298. bool first()
  1299. {
  1300. curidx = (unsigned)-1;
  1301. buf.reset();
  1302. return next();
  1303. }
  1304. bool next()
  1305. {
  1306. for (;;) {
  1307. curidx++;
  1308. cur.clear();
  1309. curdt.clear();
  1310. curname.clear();
  1311. cursize = 0;
  1312. curisdir = false;
  1313. if (buf.getPos()>=buf.length())
  1314. return false;
  1315. byte isValidEntry;
  1316. buf.read(isValidEntry);
  1317. curvalid = isValidEntry!=0;
  1318. if (!curvalid)
  1319. return false;
  1320. buf.read(curisdir);
  1321. buf.read(cursize);
  1322. curdt.deserialize(buf);
  1323. buf.read(curname);
  1324. // kludge for bug in old linux jlibs
  1325. if (strchr(curname,'\\')&&(getPathSepChar(dir)=='/')) {
  1326. StringBuffer temp(curname);
  1327. temp.replace('\\','/');
  1328. curname.set(temp.str());
  1329. }
  1330. if ((mask==0)||(getFlags()&mask))
  1331. break;
  1332. }
  1333. return true;
  1334. }
  1335. bool isValid()
  1336. {
  1337. return curvalid;
  1338. }
  1339. IFile & query()
  1340. {
  1341. if (!cur) {
  1342. StringBuffer full(dir);
  1343. addPathSepChar(full).append(curname);
  1344. if (ep.isNull())
  1345. cur.setown(createIFile(full.str()));
  1346. else {
  1347. RemoteFilename rfn;
  1348. rfn.setPath(ep,full.str());
  1349. cur.setown(createIFile(rfn));
  1350. }
  1351. }
  1352. return *cur;
  1353. }
  1354. StringBuffer &getName(StringBuffer &buf)
  1355. {
  1356. return buf.append(curname);
  1357. }
  1358. bool isDir()
  1359. {
  1360. return curisdir;
  1361. }
  1362. __int64 getFileSize()
  1363. {
  1364. if (curisdir)
  1365. return -1;
  1366. return cursize;
  1367. }
  1368. bool getModifiedTime(CDateTime &ret)
  1369. {
  1370. ret = curdt;
  1371. return true;
  1372. }
  1373. void setMask(unsigned _mask)
  1374. {
  1375. mask = _mask;
  1376. }
  1377. virtual unsigned getFlags()
  1378. {
  1379. if (flags&&(curidx<numflags))
  1380. return flags[curidx];
  1381. return 0;
  1382. }
  1383. static bool serialize(MemoryBuffer &mb,IDirectoryIterator *iter, size32_t bufsize, bool first)
  1384. {
  1385. bool ret = true;
  1386. byte b=1;
  1387. StringBuffer tmp;
  1388. if (first ? iter->first() : iter->next()) {
  1389. for (;;) {
  1390. mb.append(b);
  1391. bool isdir = iter->isDir();
  1392. __int64 sz = isdir?0:iter->getFileSize();
  1393. CDateTime dt;
  1394. iter->getModifiedTime(dt);
  1395. iter->getName(tmp.clear());
  1396. mb.append(isdir).append(sz);
  1397. dt.serialize(mb);
  1398. mb.append(tmp.str());
  1399. if (bufsize&&(mb.length()>=bufsize-1)) {
  1400. ret = false;
  1401. break;
  1402. }
  1403. if (!iter->next())
  1404. break;
  1405. }
  1406. }
  1407. b = 0;
  1408. mb.append(b);
  1409. return ret;
  1410. }
  1411. static void serializeDiff(MemoryBuffer &mb,IDirectoryDifferenceIterator *iter)
  1412. {
  1413. // bit slow
  1414. MemoryBuffer flags;
  1415. ForEach(*iter)
  1416. flags.append((byte)iter->getFlags());
  1417. if (flags.length()) {
  1418. byte b = 2;
  1419. mb.append(b).append((unsigned)flags.length()).append(flags);
  1420. }
  1421. serialize(mb,iter,0,true);
  1422. }
  1423. void serialize(MemoryBuffer &mb,bool isdiff)
  1424. {
  1425. byte b;
  1426. if (isdiff&&numflags&&flags) {
  1427. b = 2;
  1428. mb.append(b).append(numflags).append(numflags,flags);
  1429. }
  1430. serialize(mb,this,0,true);
  1431. }
  1432. };
  1433. class CCritTable;
  1434. class CEndpointCS : public CriticalSection, public CInterface
  1435. {
  1436. CCritTable &table;
  1437. const SocketEndpoint ep;
  1438. public:
  1439. CEndpointCS(CCritTable &_table, const SocketEndpoint &_ep) : table(_table), ep(_ep) { }
  1440. const void *queryFindParam() const { return &ep; }
  1441. virtual void beforeDispose();
  1442. };
  1443. class CCritTable : private SimpleHashTableOf<CEndpointCS, const SocketEndpoint>
  1444. {
  1445. typedef SimpleHashTableOf<CEndpointCS, const SocketEndpoint> PARENT;
  1446. CriticalSection crit;
  1447. public:
  1448. CEndpointCS *getCrit(const SocketEndpoint &ep)
  1449. {
  1450. CriticalBlock b(crit);
  1451. Linked<CEndpointCS> clientCrit = find(ep);
  1452. if (!clientCrit || !clientCrit->isAlive()) // if !isAlive(), then it is in the process of being destroyed/removed.
  1453. {
  1454. clientCrit.setown(new CEndpointCS(*this, ep));
  1455. replace(*clientCrit); // NB table doesn't own
  1456. }
  1457. return clientCrit.getClear();
  1458. }
  1459. unsigned getHashFromElement(const void *e) const
  1460. {
  1461. const CEndpointCS &elem=*(const CEndpointCS *)e;
  1462. return getHashFromFindParam(elem.queryFindParam());
  1463. }
  1464. unsigned getHashFromFindParam(const void *fp) const
  1465. {
  1466. return ((const SocketEndpoint *)fp)->hash(0);
  1467. }
  1468. void removeExact(CEndpointCS *clientCrit)
  1469. {
  1470. CriticalBlock b(crit);
  1471. PARENT::removeExact(clientCrit); // NB may not exist, could have been replaced if detected !isAlive() in getCrit()
  1472. }
  1473. } *dirCSTable;
  1474. MODULE_INIT(INIT_PRIORITY_STANDARD)
  1475. {
  1476. dirCSTable = new CCritTable;
  1477. return true;
  1478. }
  1479. MODULE_EXIT()
  1480. {
  1481. delete dirCSTable;
  1482. }
  1483. void CEndpointCS::beforeDispose()
  1484. {
  1485. table.removeExact(this);
  1486. }
  1487. class CRemoteFile : public CRemoteBase, implements IFile
  1488. {
  1489. StringAttr remotefilename;
  1490. unsigned flags;
  1491. public:
  1492. IMPLEMENT_IINTERFACE
  1493. CRemoteFile(const SocketEndpoint &_ep, const char * _filename)
  1494. : CRemoteBase(_ep, _filename)
  1495. {
  1496. flags = ((unsigned)IFSHread)|((S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP|S_IROTH|S_IWOTH)<<16);
  1497. }
  1498. bool exists()
  1499. {
  1500. MemoryBuffer sendBuffer;
  1501. initSendBuffer(sendBuffer);
  1502. MemoryBuffer replyBuffer;
  1503. sendBuffer.append((RemoteFileCommandType)RFCexists).append(filename);
  1504. sendRemoteCommand(sendBuffer, replyBuffer);
  1505. bool ok;
  1506. replyBuffer.read(ok);
  1507. return ok;
  1508. }
  1509. bool getTime(CDateTime * createTime, CDateTime * modifiedTime, CDateTime * accessedTime)
  1510. {
  1511. CDateTime dummyTime;
  1512. if (!createTime)
  1513. createTime = &dummyTime;
  1514. if (!modifiedTime)
  1515. modifiedTime = &dummyTime;
  1516. if (!accessedTime)
  1517. accessedTime = &dummyTime;
  1518. MemoryBuffer sendBuffer;
  1519. initSendBuffer(sendBuffer);
  1520. MemoryBuffer replyBuffer;
  1521. sendBuffer.append((RemoteFileCommandType)RFCgettime).append(filename);
  1522. sendRemoteCommand(sendBuffer, replyBuffer);
  1523. bool ok;
  1524. replyBuffer.read(ok);
  1525. if (ok) {
  1526. createTime->deserialize(replyBuffer);
  1527. modifiedTime->deserialize(replyBuffer);
  1528. accessedTime->deserialize(replyBuffer);
  1529. }
  1530. return ok;
  1531. }
  1532. bool setTime(const CDateTime * createTime, const CDateTime * modifiedTime, const CDateTime * accessedTime)
  1533. {
  1534. MemoryBuffer sendBuffer;
  1535. initSendBuffer(sendBuffer);
  1536. MemoryBuffer replyBuffer;
  1537. sendBuffer.append((RemoteFileCommandType)RFCsettime).append(filename);
  1538. if (createTime) {
  1539. sendBuffer.append((bool)true);
  1540. createTime->serialize(sendBuffer);
  1541. }
  1542. else
  1543. sendBuffer.append((bool)false);
  1544. if (modifiedTime) {
  1545. sendBuffer.append((bool)true);
  1546. modifiedTime->serialize(sendBuffer);
  1547. }
  1548. else
  1549. sendBuffer.append((bool)false);
  1550. if (accessedTime) {
  1551. sendBuffer.append((bool)true);
  1552. accessedTime->serialize(sendBuffer);
  1553. }
  1554. else
  1555. sendBuffer.append((bool)false);
  1556. sendRemoteCommand(sendBuffer, replyBuffer);
  1557. bool ok;
  1558. replyBuffer.read(ok);
  1559. return ok;
  1560. }
  1561. fileBool isDirectory()
  1562. {
  1563. MemoryBuffer sendBuffer;
  1564. initSendBuffer(sendBuffer);
  1565. MemoryBuffer replyBuffer;
  1566. sendBuffer.append((RemoteFileCommandType)RFCisdirectory).append(filename);
  1567. sendRemoteCommand(sendBuffer, replyBuffer);
  1568. unsigned ret;
  1569. replyBuffer.read(ret);
  1570. return (fileBool)ret;
  1571. }
  1572. fileBool isFile()
  1573. {
  1574. MemoryBuffer sendBuffer;
  1575. initSendBuffer(sendBuffer);
  1576. MemoryBuffer replyBuffer;
  1577. sendBuffer.append((RemoteFileCommandType)RFCisfile).append(filename);
  1578. sendRemoteCommand(sendBuffer, replyBuffer);
  1579. unsigned ret;
  1580. replyBuffer.read(ret);
  1581. return (fileBool)ret;
  1582. }
  1583. fileBool isReadOnly()
  1584. {
  1585. MemoryBuffer sendBuffer;
  1586. initSendBuffer(sendBuffer);
  1587. MemoryBuffer replyBuffer;
  1588. sendBuffer.append((RemoteFileCommandType)RFCisreadonly).append(filename);
  1589. sendRemoteCommand(sendBuffer, replyBuffer);
  1590. unsigned ret;
  1591. replyBuffer.read(ret);
  1592. return (fileBool)ret;
  1593. }
  1594. IFileIO * open(IFOmode mode,IFEflags extraFlags=IFEnone);
  1595. IFileIO * openShared(IFOmode mode,IFSHmode shmode,IFEflags extraFlags=IFEnone);
  1596. IFileAsyncIO * openAsync(IFOmode mode) { return NULL; } // not supported
  1597. const char * queryFilename()
  1598. {
  1599. if (remotefilename.isEmpty()) {
  1600. RemoteFilename rfn;
  1601. rfn.setPath(ep,filename);
  1602. StringBuffer path;
  1603. rfn.getRemotePath(path);
  1604. remotefilename.set(path);
  1605. }
  1606. return remotefilename.get();
  1607. }
  1608. void resetLocalFilename(const char *name)
  1609. {
  1610. remotefilename.clear();
  1611. filename.set(name);
  1612. }
  1613. bool remove()
  1614. {
  1615. MemoryBuffer sendBuffer;
  1616. initSendBuffer(sendBuffer);
  1617. MemoryBuffer replyBuffer;
  1618. sendBuffer.append((RemoteFileCommandType)RFCremove).append(filename);
  1619. sendRemoteCommand(sendBuffer, replyBuffer);
  1620. bool ok;
  1621. replyBuffer.read(ok);
  1622. return ok;
  1623. }
  1624. void rename(const char *newname)
  1625. {
  1626. // currently ignores directory on newname (in future versions newname will be required to be tail only and not full path)
  1627. StringBuffer path;
  1628. splitDirTail(filename,path);
  1629. StringBuffer newdir;
  1630. path.append(splitDirTail(newname,newdir));
  1631. if (newdir.length()&&(strcmp(newdir.str(),path.str())!=0))
  1632. WARNLOG("CRemoteFile::rename passed full path '%s' that may not to match original directory '%s'",newname,path.str());
  1633. MemoryBuffer sendBuffer;
  1634. initSendBuffer(sendBuffer);
  1635. MemoryBuffer replyBuffer;
  1636. sendBuffer.append((RemoteFileCommandType)RFCrename).append(filename).append(path);
  1637. sendRemoteCommand(sendBuffer, replyBuffer);
  1638. filename.set(path);
  1639. remotefilename.clear();
  1640. }
  1641. void move(const char *newname)
  1642. {
  1643. // like rename except between directories
  1644. // first create replote path
  1645. if (!newname||!*newname)
  1646. return;
  1647. RemoteFilename destrfn;
  1648. if (isPathSepChar(newname[0])&&isPathSepChar(newname[1])) {
  1649. destrfn.setRemotePath(newname);
  1650. if (!destrfn.queryEndpoint().ipequals(ep)) {
  1651. StringBuffer msg;
  1652. msg.appendf("IFile::move %s to %s, destination node must match source node", queryFilename(), newname);
  1653. throw createDafsException(RFSERR_MoveFailed,msg.str());
  1654. }
  1655. }
  1656. else
  1657. destrfn.setPath(ep,newname);
  1658. StringBuffer dest;
  1659. newname = destrfn.getLocalPath(dest).str();
  1660. MemoryBuffer sendBuffer;
  1661. initSendBuffer(sendBuffer);
  1662. MemoryBuffer replyBuffer;
  1663. StringBuffer path;
  1664. splitDirTail(filename,path);
  1665. StringBuffer newdir;
  1666. const char *newtail = splitDirTail(newname,newdir);
  1667. if (strcmp(newdir.str(),path.str())==0) {
  1668. path.append(newtail);
  1669. newname = path;
  1670. sendBuffer.append((RemoteFileCommandType)RFCrename); // use rename if we can (supported on older dafilesrv)
  1671. }
  1672. else
  1673. sendBuffer.append((RemoteFileCommandType)RFCmove);
  1674. sendBuffer.append(filename).append(newname);
  1675. sendRemoteCommand(sendBuffer, replyBuffer);
  1676. filename.set(newname);
  1677. remotefilename.clear();
  1678. }
  1679. void setReadOnly(bool set)
  1680. {
  1681. MemoryBuffer sendBuffer;
  1682. initSendBuffer(sendBuffer);
  1683. MemoryBuffer replyBuffer;
  1684. sendBuffer.append((RemoteFileCommandType)RFCsetreadonly).append(filename).append(set);
  1685. sendRemoteCommand(sendBuffer, replyBuffer);
  1686. }
  1687. void setFilePermissions(unsigned fPerms)
  1688. {
  1689. MemoryBuffer sendBuffer;
  1690. initSendBuffer(sendBuffer);
  1691. MemoryBuffer replyBuffer;
  1692. sendBuffer.append((RemoteFileCommandType)RFCsetfileperms).append(filename).append(fPerms);
  1693. try
  1694. {
  1695. sendRemoteCommand(sendBuffer, replyBuffer);
  1696. }
  1697. catch (IDAFS_Exception *e)
  1698. {
  1699. if (e->errorCode() == RFSERR_InvalidCommand)
  1700. WARNLOG("umask setFilePermissions (0%o) not supported on remote server", fPerms);
  1701. else
  1702. throw e;
  1703. }
  1704. }
  1705. offset_t size()
  1706. {
  1707. #if 1 // faster method (consistant with IFile)
  1708. // do this by using dir call (could be improved with new function but this not *too* bad)
  1709. if (isSpecialPath(filename))
  1710. return 0; // queries deemed to always exist (though don't know size).
  1711. // if needed to get size I guess could use IFileIO method and cache (bit of pain though)
  1712. StringBuffer dir;
  1713. const char *tail = splitDirTail(filename,dir);
  1714. if (!dir.length())
  1715. return false;
  1716. MemoryBuffer sendBuffer;
  1717. initSendBuffer(sendBuffer);
  1718. MemoryBuffer replyBuffer;
  1719. bool includedirs = true;
  1720. bool sub=false;
  1721. {
  1722. //Could be removed with new dafilesrv change [ (stream != 0) ], since this is not streaming.
  1723. Owned<CEndpointCS> crit = dirCSTable->getCrit(ep); // NB dirCSTable doesn't own, last reference will remove from table
  1724. CriticalBlock block(*crit);
  1725. sendBuffer.append((RemoteFileCommandType)RFCgetdir).append(dir).append(tail).append(includedirs).append(sub);
  1726. sendRemoteCommand(sendBuffer, replyBuffer);
  1727. }
  1728. // now should be 0 or 1 files returned
  1729. Owned<CRemoteDirectoryIterator> iter = new CRemoteDirectoryIterator(ep, dir.str());
  1730. iter->appendBuf(replyBuffer);
  1731. if (!iter->first())
  1732. return (offset_t)-1;
  1733. return (offset_t) iter->getFileSize();
  1734. #else
  1735. IFileIO * io = open(IFOread);
  1736. offset_t length = (offset_t)-1;
  1737. if (io)
  1738. {
  1739. length = io->size();
  1740. io->Release();
  1741. }
  1742. return length;
  1743. #endif
  1744. }
  1745. bool createDirectory()
  1746. {
  1747. MemoryBuffer sendBuffer;
  1748. initSendBuffer(sendBuffer);
  1749. MemoryBuffer replyBuffer;
  1750. sendBuffer.append((RemoteFileCommandType)RFCcreatedir).append(filename);
  1751. sendRemoteCommand(sendBuffer, replyBuffer);
  1752. bool ok;
  1753. replyBuffer.read(ok);
  1754. return ok;
  1755. }
  1756. virtual IDirectoryIterator *directoryFiles(const char *mask,bool sub,bool includedirs)
  1757. {
  1758. if (mask&&!*mask)
  1759. return createDirectoryIterator("",""); // NULL iterator
  1760. CRemoteDirectoryIterator *ret = new CRemoteDirectoryIterator(ep, filename);
  1761. byte stream=1;
  1762. Owned<CEndpointCS> crit = dirCSTable->getCrit(ep); // NB dirCSTable doesn't own, last reference will remove from table
  1763. CriticalBlock block(*crit);
  1764. for (;;) {
  1765. MemoryBuffer sendBuffer;
  1766. initSendBuffer(sendBuffer);
  1767. MemoryBuffer replyBuffer;
  1768. sendBuffer.append((RemoteFileCommandType)RFCgetdir).append(filename).append(mask?mask:"").append(includedirs).append(sub).append(stream);
  1769. sendRemoteCommand(sendBuffer, replyBuffer);
  1770. if (ret->appendBuf(replyBuffer))
  1771. break;
  1772. stream = 2;
  1773. }
  1774. return ret;
  1775. }
  1776. IDirectoryDifferenceIterator *monitorDirectory(
  1777. IDirectoryIterator *prev=NULL, // in (NULL means use current as baseline)
  1778. const char *mask=NULL,
  1779. bool sub=false,
  1780. bool includedirs=false,
  1781. unsigned checkinterval=60*1000,
  1782. unsigned timeout=(unsigned)-1,
  1783. Semaphore *abortsem=NULL) // returns NULL if timed out
  1784. {
  1785. // abortsem not yet supported
  1786. MemoryBuffer sendBuffer;
  1787. initSendBuffer(sendBuffer);
  1788. MemoryBuffer replyBuffer;
  1789. sendBuffer.append((RemoteFileCommandType)RFCmonitordir).append(filename).append(mask?mask:"").append(includedirs).append(sub);
  1790. sendBuffer.append(checkinterval).append(timeout);
  1791. __int64 cancelid=0; // not yet used
  1792. sendBuffer.append(cancelid);
  1793. byte isprev=(prev!=NULL)?1:0;
  1794. sendBuffer.append(isprev);
  1795. if (prev)
  1796. CRemoteDirectoryIterator::serialize(sendBuffer,prev,0,true);
  1797. sendRemoteCommand(sendBuffer, replyBuffer);
  1798. byte status;
  1799. replyBuffer.read(status);
  1800. if (status==1) {
  1801. CRemoteDirectoryIterator *iter = new CRemoteDirectoryIterator(ep, filename);
  1802. iter->appendBuf(replyBuffer);
  1803. return iter;
  1804. }
  1805. return NULL;
  1806. }
  1807. bool getInfo(bool &isdir,offset_t &size,CDateTime &modtime)
  1808. {
  1809. // do this by using dir call (could be improved with new function but this not *too* bad)
  1810. StringBuffer dir;
  1811. const char *tail = splitDirTail(filename,dir);
  1812. if (!dir.length())
  1813. return false;
  1814. MemoryBuffer sendBuffer;
  1815. initSendBuffer(sendBuffer);
  1816. MemoryBuffer replyBuffer;
  1817. bool includedirs = true;
  1818. bool sub=false;
  1819. {
  1820. //Could be removed with new dafilesrv change [ (stream != 0) ], since this is not streaming.
  1821. Owned<CEndpointCS> crit = dirCSTable->getCrit(ep); // NB dirCSTable doesn't own, last reference will remove from table
  1822. CriticalBlock block(*crit);
  1823. sendBuffer.append((RemoteFileCommandType)RFCgetdir).append(dir).append(tail).append(includedirs).append(sub);
  1824. sendRemoteCommand(sendBuffer, replyBuffer);
  1825. }
  1826. // now should be 0 or 1 files returned
  1827. Owned<CRemoteDirectoryIterator> iter = new CRemoteDirectoryIterator(ep, dir.str());
  1828. iter->appendBuf(replyBuffer);
  1829. if (!iter->first())
  1830. return false;
  1831. isdir = iter->isDir();
  1832. size = (offset_t) iter->getFileSize();
  1833. iter->getModifiedTime(modtime);
  1834. return true;
  1835. }
  1836. bool setCompression(bool set)
  1837. {
  1838. assertex(!"Need to implement compress()");
  1839. return false;
  1840. }
  1841. offset_t compressedSize()
  1842. {
  1843. assertex(!"Need to implement actualSize()");
  1844. return (offset_t)-1;
  1845. }
  1846. void serialize(MemoryBuffer &tgt)
  1847. {
  1848. throwUnexpected();
  1849. }
  1850. void deserialize(MemoryBuffer &src)
  1851. {
  1852. throwUnexpected();
  1853. }
  1854. unsigned getCRC()
  1855. {
  1856. MemoryBuffer sendBuffer;
  1857. initSendBuffer(sendBuffer);
  1858. MemoryBuffer replyBuffer;
  1859. sendBuffer.append((RemoteFileCommandType)RFCgetcrc).append(filename);
  1860. sendRemoteCommand(sendBuffer, replyBuffer, true, true);
  1861. unsigned crc;
  1862. replyBuffer.read(crc);
  1863. return crc;
  1864. }
  1865. void setCreateFlags(unsigned short cflags)
  1866. {
  1867. flags &= 0xffff;
  1868. flags |= ((unsigned)cflags<<16);
  1869. }
  1870. unsigned short getCreateFlags()
  1871. {
  1872. return (unsigned short)(flags>>16);
  1873. }
  1874. void setShareMode(IFSHmode shmode)
  1875. {
  1876. flags &= ~(IFSHfull|IFSHread);
  1877. flags |= (unsigned)(shmode&(IFSHfull|IFSHread));
  1878. }
  1879. unsigned short getShareMode()
  1880. {
  1881. return (unsigned short)(flags&0xffff);
  1882. }
  1883. void remoteExtractBlobElements(const char * prefix, ExtractedBlobArray & extracted)
  1884. {
  1885. MemoryBuffer sendBuffer;
  1886. initSendBuffer(sendBuffer);
  1887. sendBuffer.append((RemoteFileCommandType)RFCextractblobelements).append(prefix).append(filename);
  1888. MemoryBuffer replyBuffer;
  1889. sendRemoteCommand(sendBuffer, replyBuffer, true, true); // handles error code
  1890. unsigned n;
  1891. replyBuffer.read(n);
  1892. for (unsigned i=0;i<n;i++) {
  1893. ExtractedBlobInfo *item = new ExtractedBlobInfo;
  1894. item->deserialize(replyBuffer);
  1895. extracted.append(*item);
  1896. }
  1897. }
  1898. bool copySectionAsync(const char *uuid,const RemoteFilename &dest, offset_t toOfs, offset_t fromOfs, offset_t size, ICopyFileProgress *progress, unsigned timeout)
  1899. {
  1900. // now if we get here is it can be assumed the source file is local to where we send the command
  1901. StringBuffer tos;
  1902. dest.getRemotePath(tos);
  1903. MemoryBuffer sendBuffer;
  1904. initSendBuffer(sendBuffer);
  1905. MemoryBuffer replyBuffer;
  1906. sendBuffer.append((RemoteFileCommandType)RFCcopysection).append(uuid).append(queryLocalName()).append(tos).append(toOfs).append(fromOfs).append(size).append(timeout);
  1907. sendRemoteCommand(sendBuffer, replyBuffer);
  1908. unsigned status;
  1909. replyBuffer.read(status);
  1910. if (progress) {
  1911. offset_t sizeDone;
  1912. offset_t totalSize;
  1913. replyBuffer.read(sizeDone).read(totalSize);
  1914. progress->onProgress(sizeDone,totalSize);
  1915. }
  1916. return (AsyncCommandStatus)status!=ACScontinue; // should only otherwise be done as errors raised by exception
  1917. }
  1918. void copySection(const RemoteFilename &dest, offset_t toOfs, offset_t fromOfs, offset_t size, ICopyFileProgress *progress, CFflags copyFlags=CFnone)
  1919. {
  1920. StringBuffer uuid;
  1921. genUUID(uuid,true);
  1922. unsigned timeout = 60*1000; // check every minute
  1923. while(!copySectionAsync(uuid.str(),dest,toOfs,fromOfs,size,progress,timeout));
  1924. }
  1925. void copyTo(IFile *dest, size32_t buffersize, ICopyFileProgress *progress, bool usetmp, CFflags copyFlags=CFnone);
  1926. virtual IMemoryMappedFile *openMemoryMapped(offset_t ofs, memsize_t len, bool write)
  1927. {
  1928. return NULL;
  1929. }
  1930. };
  1931. void clientAddSocketToCache(SocketEndpoint &ep,ISocket *socket)
  1932. {
  1933. CriticalBlock block(CConnectionTable::crit);
  1934. if (ConnectionTable)
  1935. ConnectionTable->addLink(ep,socket);
  1936. }
  1937. IFile * createRemoteFile(SocketEndpoint &ep, const char * filename)
  1938. {
  1939. IFile *ret = createFileLocalMount(ep,filename);
  1940. if (ret)
  1941. return ret;
  1942. return new CRemoteFile(ep, filename);
  1943. }
  1944. void clientDisconnectRemoteFile(IFile *file)
  1945. {
  1946. CRemoteFile *cfile = QUERYINTERFACE(file,CRemoteFile);
  1947. if (cfile)
  1948. cfile->disconnect();
  1949. }
  1950. bool clientResetFilename(IFile *file, const char *newname) // returns false if not remote
  1951. {
  1952. CRemoteFile *cfile = QUERYINTERFACE(file,CRemoteFile);
  1953. if (!cfile)
  1954. return false;
  1955. cfile->resetLocalFilename(newname);
  1956. return true;
  1957. }
  1958. extern bool clientAsyncCopyFileSection(const char *uuid,
  1959. IFile *from, // expected to be remote
  1960. RemoteFilename &to,
  1961. offset_t toOfs, // -1 created file and copies to start
  1962. offset_t fromOfs,
  1963. offset_t size,
  1964. ICopyFileProgress *progress,
  1965. unsigned timeout) // returns true when done
  1966. {
  1967. CRemoteFile *cfile = QUERYINTERFACE(from,CRemoteFile);
  1968. if (!cfile) {
  1969. // local - do sync
  1970. from->copySection(to,toOfs,fromOfs,size,progress);
  1971. return true;
  1972. }
  1973. return cfile->copySectionAsync(uuid,to,toOfs,fromOfs, size, progress, timeout);
  1974. }
  1975. //---------------------------------------------------------------------------
  1976. class CRemoteFileIO : implements IFileIO, public CInterface
  1977. {
  1978. protected:
  1979. Linked<CRemoteFile> parent;
  1980. RemoteFileIOHandle handle;
  1981. std::atomic<cycle_t> ioReadCycles;
  1982. std::atomic<cycle_t> ioWriteCycles;
  1983. std::atomic<__uint64> ioReadBytes;
  1984. std::atomic<__uint64> ioWriteBytes;
  1985. std::atomic<__uint64> ioReads;
  1986. std::atomic<__uint64> ioWrites;
  1987. std::atomic<unsigned> ioRetries;
  1988. IFOmode mode;
  1989. compatIFSHmode compatmode;
  1990. IFEflags extraFlags;
  1991. bool disconnectonexit;
  1992. public:
  1993. IMPLEMENT_IINTERFACE
  1994. CRemoteFileIO(CRemoteFile *_parent)
  1995. : parent(_parent), ioReadCycles(0), ioWriteCycles(0), ioReadBytes(0), ioWriteBytes(0), ioReads(0), ioWrites(0), ioRetries(0)
  1996. {
  1997. handle = 0;
  1998. disconnectonexit = false;
  1999. }
  2000. ~CRemoteFileIO()
  2001. {
  2002. if (handle) {
  2003. try {
  2004. close();
  2005. }
  2006. catch (IException *e) {
  2007. StringBuffer s;
  2008. e->errorMessage(s);
  2009. WARNLOG("CRemoteFileIO close file: %s",s.str());
  2010. e->Release();
  2011. }
  2012. }
  2013. if (disconnectonexit)
  2014. parent->disconnect();
  2015. }
  2016. void close()
  2017. {
  2018. if (handle) {
  2019. try {
  2020. MemoryBuffer sendBuffer;
  2021. initSendBuffer(sendBuffer);
  2022. sendBuffer.append((RemoteFileCommandType)RFCcloseIO).append(handle);
  2023. parent->sendRemoteCommand(sendBuffer,false);
  2024. }
  2025. catch (IDAFS_Exception *e) {
  2026. if ((e->errorCode()!=RFSERR_InvalidFileIOHandle)&&(e->errorCode()!=RFSERR_NullFileIOHandle))
  2027. throw;
  2028. e->Release();
  2029. }
  2030. handle = 0;
  2031. }
  2032. }
  2033. RemoteFileIOHandle getHandle() const { return handle; }
  2034. bool open(IFOmode _mode,compatIFSHmode _compatmode,IFEflags _extraFlags=IFEnone)
  2035. {
  2036. MemoryBuffer sendBuffer;
  2037. initSendBuffer(sendBuffer);
  2038. MemoryBuffer replyBuffer;
  2039. const char *localname = parent->queryLocalName();
  2040. localname = skipSpecialPath(localname);
  2041. // also send _extraFlags
  2042. // then also send sMode, cFlags
  2043. unsigned short sMode = parent->getShareMode();
  2044. unsigned short cFlags = parent->getCreateFlags();
  2045. sendBuffer.append((RemoteFileCommandType)RFCopenIO).append(localname).append((byte)_mode).append((byte)_compatmode).append((byte)_extraFlags).append(sMode).append(cFlags);
  2046. parent->sendRemoteCommand(sendBuffer, replyBuffer);
  2047. replyBuffer.read(handle);
  2048. if (!handle)
  2049. return false;
  2050. switch (_mode) {
  2051. case IFOcreate:
  2052. mode = IFOwrite;
  2053. break;
  2054. case IFOcreaterw:
  2055. mode = IFOreadwrite;
  2056. break;
  2057. default:
  2058. mode = _mode;
  2059. break;
  2060. }
  2061. compatmode = _compatmode;
  2062. extraFlags = _extraFlags;
  2063. return true;
  2064. }
  2065. bool reopen()
  2066. {
  2067. StringBuffer s;
  2068. PROGLOG("Attempting reopen of %s on %s",parent->queryLocalName(),parent->queryEp().getUrlStr(s).str());
  2069. if (open(mode,compatmode,extraFlags)) {
  2070. return true;
  2071. }
  2072. return false;
  2073. }
  2074. offset_t size()
  2075. {
  2076. MemoryBuffer sendBuffer;
  2077. initSendBuffer(sendBuffer);
  2078. MemoryBuffer replyBuffer;
  2079. sendBuffer.append((RemoteFileCommandType)RFCsize).append(handle);
  2080. parent->sendRemoteCommand(sendBuffer, replyBuffer, false);
  2081. // Retry using reopen TBD
  2082. offset_t ret;
  2083. replyBuffer.read(ret);
  2084. return ret;
  2085. }
  2086. virtual unsigned __int64 getStatistic(StatisticKind kind)
  2087. {
  2088. switch (kind)
  2089. {
  2090. case StCycleDiskReadIOCycles:
  2091. return ioReadCycles.load(std::memory_order_relaxed);
  2092. case StCycleDiskWriteIOCycles:
  2093. return ioWriteCycles.load(std::memory_order_relaxed);
  2094. case StTimeDiskReadIO:
  2095. return cycle_to_nanosec(ioReadCycles.load(std::memory_order_relaxed));
  2096. case StTimeDiskWriteIO:
  2097. return cycle_to_nanosec(ioWriteCycles.load(std::memory_order_relaxed));
  2098. case StSizeDiskRead:
  2099. return ioReadBytes.load(std::memory_order_relaxed);
  2100. case StSizeDiskWrite:
  2101. return ioWriteBytes.load(std::memory_order_relaxed);
  2102. case StNumDiskReads:
  2103. return ioReads.load(std::memory_order_relaxed);
  2104. case StNumDiskWrites:
  2105. return ioWrites.load(std::memory_order_relaxed);
  2106. case StNumDiskRetries:
  2107. return ioRetries.load(std::memory_order_relaxed);
  2108. }
  2109. return 0;
  2110. }
  2111. size32_t read(offset_t pos, size32_t len, void * data)
  2112. {
  2113. size32_t got;
  2114. MemoryBuffer replyBuffer;
  2115. CCycleTimer timer;
  2116. const void *b;
  2117. try
  2118. {
  2119. b = doRead(pos,len,replyBuffer,got,data);
  2120. }
  2121. catch (...)
  2122. {
  2123. ioReadCycles.fetch_add(timer.elapsedCycles());
  2124. throw;
  2125. }
  2126. ioReadCycles.fetch_add(timer.elapsedCycles());
  2127. ioReadBytes.fetch_add(got);
  2128. ++ioReads;
  2129. if (b!=data)
  2130. memcpy(data,b,got);
  2131. return got;
  2132. }
  2133. virtual void flush()
  2134. {
  2135. }
  2136. const void *doRead(offset_t pos, size32_t len, MemoryBuffer &replyBuffer, size32_t &got, void *dstbuf)
  2137. {
  2138. unsigned tries=0;
  2139. for (;;) {
  2140. try {
  2141. MemoryBuffer sendBuffer;
  2142. initSendBuffer(sendBuffer);
  2143. replyBuffer.clear();
  2144. sendBuffer.append((RemoteFileCommandType)RFCread).append(handle).append(pos).append(len);
  2145. parent->sendRemoteCommand(sendBuffer, replyBuffer,false);
  2146. // kludge dafilesrv versions <= 1.5e don't return error correctly
  2147. if (replyBuffer.length()>len+sizeof(size32_t)+sizeof(unsigned)) {
  2148. size32_t save = replyBuffer.getPos();
  2149. replyBuffer.reset(len+sizeof(size32_t)+sizeof(unsigned));
  2150. unsigned errCode;
  2151. replyBuffer.read(errCode);
  2152. if (errCode) {
  2153. StringBuffer msg;
  2154. parent->ep.getUrlStr(msg.append('[')).append("] ");
  2155. if (replyBuffer.getPos()<replyBuffer.length()) {
  2156. StringAttr s;
  2157. replyBuffer.read(s);
  2158. msg.append(s);
  2159. }
  2160. else
  2161. msg.append("ERROR #").append(errCode);
  2162. throw createDafsException(errCode, msg.str());
  2163. }
  2164. else
  2165. replyBuffer.reset(save);
  2166. }
  2167. replyBuffer.read(got);
  2168. if ((got>replyBuffer.remaining())||(got>len)) {
  2169. PROGLOG("Read beyond buffer %d,%d,%d",got,replyBuffer.remaining(),len);
  2170. throw createDafsException(RFSERR_ReadFailed, "Read beyond buffer");
  2171. }
  2172. return replyBuffer.readDirect(got);
  2173. }
  2174. catch (IJSOCK_Exception *e) {
  2175. EXCLOG(e,"CRemoteFileIO::read");
  2176. if (++tries > 3)
  2177. {
  2178. ioRetries.fetch_add(tries);
  2179. throw;
  2180. }
  2181. WARNLOG("Retrying read of %s (%d)",parent->queryLocalName(),tries);
  2182. Owned<IException> exc = e;
  2183. if (!reopen())
  2184. {
  2185. ioRetries.fetch_add(tries);
  2186. throw exc.getClear();
  2187. }
  2188. }
  2189. }
  2190. if (tries)
  2191. ioRetries.fetch_add(tries);
  2192. got = 0;
  2193. return NULL;
  2194. }
  2195. size32_t write(offset_t pos, size32_t len, const void * data)
  2196. {
  2197. unsigned tries=0;
  2198. size32_t ret = 0;
  2199. CCycleTimer timer;
  2200. for (;;) {
  2201. try {
  2202. MemoryBuffer replyBuffer;
  2203. MemoryBuffer sendBuffer;
  2204. initSendBuffer(sendBuffer);
  2205. sendBuffer.append((RemoteFileCommandType)RFCwrite).append(handle).append(pos).append(len).append(len, data);
  2206. parent->sendRemoteCommand(sendBuffer, replyBuffer, false, true);
  2207. replyBuffer.read(ret);
  2208. break;
  2209. }
  2210. catch (IJSOCK_Exception *e) {
  2211. EXCLOG(e,"CRemoteFileIO::write");
  2212. if (++tries > 3)
  2213. {
  2214. ioRetries.fetch_add(tries);
  2215. ioWriteCycles.fetch_add(timer.elapsedCycles());
  2216. throw;
  2217. }
  2218. WARNLOG("Retrying write(%" I64F "d,%d) of %s (%d)",pos,len,parent->queryLocalName(),tries);
  2219. Owned<IException> exc = e;
  2220. if (!reopen())
  2221. {
  2222. ioRetries.fetch_add(tries);
  2223. ioWriteCycles.fetch_add(timer.elapsedCycles());
  2224. throw exc.getClear();
  2225. }
  2226. }
  2227. }
  2228. if (tries)
  2229. ioRetries.fetch_add(tries);
  2230. ioWriteCycles.fetch_add(timer.elapsedCycles());
  2231. ioWriteBytes.fetch_add(ret);
  2232. ++ioWrites;
  2233. if ((ret==(size32_t)-1) || (ret < len))
  2234. throw createDafsException(DISK_FULL_EXCEPTION_CODE,"write failed, disk full?");
  2235. return ret;
  2236. }
  2237. offset_t appendFile(IFile *file,offset_t pos,offset_t len)
  2238. {
  2239. MemoryBuffer sendBuffer;
  2240. initSendBuffer(sendBuffer);
  2241. MemoryBuffer replyBuffer;
  2242. const char * fname = file->queryFilename();
  2243. sendBuffer.append((RemoteFileCommandType)RFCappend).append(handle).append(fname).append(pos).append(len);
  2244. parent->sendRemoteCommand(sendBuffer, replyBuffer, false, true); // retry not safe
  2245. offset_t ret;
  2246. replyBuffer.read(ret);
  2247. if ((ret==(offset_t)-1) || ((len != ((offset_t)-1)) && (ret < len)))
  2248. throw createDafsException(DISK_FULL_EXCEPTION_CODE,"append failed, disk full?"); // though could be file missing TBD
  2249. return ret;
  2250. }
  2251. void setSize(offset_t size)
  2252. {
  2253. MemoryBuffer sendBuffer;
  2254. initSendBuffer(sendBuffer);
  2255. MemoryBuffer replyBuffer;
  2256. sendBuffer.append((RemoteFileCommandType)RFCsetsize).append(handle).append(size);
  2257. parent->sendRemoteCommand(sendBuffer, replyBuffer, false, true);
  2258. // retry using reopen TBD
  2259. }
  2260. void setDisconnectOnExit(bool set) { disconnectonexit = set; }
  2261. void sendRemoteCommand(MemoryBuffer & sendBuffer, MemoryBuffer & replyBuffer, bool retry=true, bool lengthy=false, bool handleErrCode=true)
  2262. {
  2263. parent->sendRemoteCommand(sendBuffer, replyBuffer, retry, lengthy, handleErrCode);
  2264. }
  2265. };
  2266. void clientDisconnectRemoteIoOnExit(IFileIO *fileio,bool set)
  2267. {
  2268. CRemoteFileIO *cfileio = QUERYINTERFACE(fileio,CRemoteFileIO);
  2269. if (cfileio)
  2270. cfileio->setDisconnectOnExit(set);
  2271. }
  2272. IFileIO * CRemoteFile::openShared(IFOmode mode,IFSHmode shmode,IFEflags extraFlags)
  2273. {
  2274. assertex(((unsigned)shmode&0xffffffc7)==0);
  2275. compatIFSHmode compatmode;
  2276. unsigned fileflags = (flags>>16) & (S_IRUSR|S_IWUSR|S_IXUSR|S_IRGRP|S_IWGRP|S_IXGRP|S_IROTH|S_IWOTH|S_IXOTH);
  2277. if (fileflags&S_IXUSR) // this is bit hit and miss but backward compatible
  2278. compatmode = compatIFSHexec;
  2279. else if (fileflags&(S_IWGRP|S_IWOTH))
  2280. compatmode = compatIFSHall;
  2281. else if (shmode&IFSHfull)
  2282. compatmode = compatIFSHwrite;
  2283. else if (((shmode&(IFSHread|IFSHfull))==0) && ((fileflags&(S_IRGRP|S_IROTH))==0))
  2284. compatmode = compatIFSHnone;
  2285. else
  2286. compatmode = compatIFSHread;
  2287. Owned<CRemoteFileIO> res = new CRemoteFileIO(this);
  2288. if (res->open(mode,compatmode,extraFlags))
  2289. return res.getClear();
  2290. return NULL;
  2291. }
  2292. IFileIO * CRemoteFile::open(IFOmode mode,IFEflags extraFlags)
  2293. {
  2294. return openShared(mode,(IFSHmode)(flags&(IFSHread|IFSHfull)),extraFlags);
  2295. }
  2296. //---------------------------------------------------------------------------
  2297. void CRemoteFile::copyTo(IFile *dest, size32_t buffersize, ICopyFileProgress *progress, bool usetmp, CFflags copyFlags)
  2298. {
  2299. CRemoteFile *dstfile = QUERYINTERFACE(dest,CRemoteFile);
  2300. if (dstfile&&!dstfile->queryEp().isLocal()) {
  2301. StringBuffer tmpname;
  2302. Owned<IFile> destf;
  2303. RemoteFilename dest;
  2304. if (usetmp) {
  2305. makeTempCopyName(tmpname,dstfile->queryLocalName());
  2306. dest.setPath(dstfile->queryEp(),tmpname.str());
  2307. }
  2308. else
  2309. dest.setPath(dstfile->queryEp(),dstfile->queryLocalName());
  2310. destf.setown(createIFile(dest));
  2311. try {
  2312. // following may fail if new dafilesrv not deployed on src
  2313. copySection(dest,(offset_t)-1,0,(offset_t)-1,progress,copyFlags);
  2314. if (usetmp) {
  2315. StringAttr tail(pathTail(dstfile->queryLocalName()));
  2316. dstfile->remove();
  2317. destf->rename(tail);
  2318. }
  2319. return;
  2320. }
  2321. catch (IException *e)
  2322. {
  2323. StringBuffer s;
  2324. s.appendf("Remote File Copy (%d): ",e->errorCode());
  2325. e->errorMessage(s);
  2326. s.append(", retrying local");
  2327. WARNLOG("%s",s.str());
  2328. e->Release();
  2329. }
  2330. // delete dest
  2331. try {
  2332. destf->remove();
  2333. }
  2334. catch (IException *e)
  2335. {
  2336. EXCLOG(e,"Remote File Copy, Deleting temporary file");
  2337. e->Release();
  2338. }
  2339. }
  2340. // assumption if we get here that source remote, dest local (or equiv)
  2341. class cIntercept: implements ICopyFileIntercept
  2342. {
  2343. MemoryAttr ma;
  2344. MemoryBuffer mb;
  2345. virtual offset_t copy(IFileIO *from, IFileIO *to, offset_t ofs, size32_t sz)
  2346. {
  2347. if (ma.length()<sz)
  2348. ma.allocate(sz); // may be not used
  2349. void *buf = ma.bufferBase();
  2350. size32_t got;
  2351. CRemoteFileIO *srcio = QUERYINTERFACE(from,CRemoteFileIO);
  2352. const void *dst;
  2353. if (srcio)
  2354. dst = srcio->doRead(ofs,sz,mb.clear(),got,buf);
  2355. else {
  2356. // shouldn't ever get here if source remote
  2357. got = from->read(ofs, sz, buf);
  2358. dst = buf;
  2359. }
  2360. if (got != 0)
  2361. to->write(ofs, got, dst);
  2362. return got;
  2363. }
  2364. } intercept;
  2365. doCopyFile(dest,this,buffersize,progress,&intercept,usetmp,copyFlags);
  2366. }
  2367. /////////////////////////
  2368. void checkSocketSecure(ISocket *socket)
  2369. {
  2370. if (!socket)
  2371. return;
  2372. if (securitySettings.useSSL == SSLNone)
  2373. return;
  2374. Owned<ISecureSocket> ssock;
  2375. char pname[256];
  2376. pname[0] = 0;
  2377. int pport = socket->peer_name(pname, sizeof(pname)-1);
  2378. if ( (pport == securitySettings.daFileSrvSSLPort) && (!socket->isSecure()) )
  2379. {
  2380. #ifdef _USE_OPENSSL
  2381. ssock.setown(createSecureSocket(LINK(socket), ClientSocket));
  2382. int status = ssock->secure_connect();
  2383. if (status < 0)
  2384. throw createDafsException(DAFSERR_connection_failed,"Failure to establish secure connection");
  2385. socket = ssock;
  2386. #else
  2387. throw createDafsException(DAFSERR_connection_failed,"Failure to establish secure connection: OpenSSL disabled in build");
  2388. #endif
  2389. }
  2390. }
  2391. ISocket *connectDafs(SocketEndpoint &ep, unsigned timeoutms)
  2392. {
  2393. Owned<ISocket> socket;
  2394. if ( (securitySettings.useSSL == SSLNone) || (securitySettings.useSSL == SSLOnly) )
  2395. {
  2396. socket.setown(ISocket::connect_timeout(ep, timeoutms));
  2397. return socket.getClear();
  2398. }
  2399. unsigned newtimeout = timeoutms;
  2400. if (newtimeout > 5000)
  2401. newtimeout = 5000;
  2402. bool tryAgain = false;
  2403. try
  2404. {
  2405. socket.setown(ISocket::connect_timeout(ep, newtimeout));
  2406. }
  2407. catch (IJSOCK_Exception *e)
  2408. {
  2409. if (e->errorCode() == JSOCKERR_connection_failed)
  2410. {
  2411. unsigned prevPort = ep.port;
  2412. if (prevPort == securitySettings.daFileSrvSSLPort)
  2413. ep.port = securitySettings.daFileSrvPort;
  2414. else
  2415. ep.port = securitySettings.daFileSrvSSLPort;
  2416. WARNLOG("Connect failed on port %d, retrying on port %d", prevPort, ep.port);
  2417. tryAgain = true;
  2418. }
  2419. else
  2420. throw e;
  2421. }
  2422. if (tryAgain)
  2423. socket.setown(ISocket::connect_timeout(ep, timeoutms));
  2424. checkSocketSecure(socket);
  2425. return socket.getClear();
  2426. }
  2427. unsigned getRemoteVersion(CRemoteFileIO &remoteFileIO, StringBuffer &ver)
  2428. {
  2429. unsigned ret;
  2430. MemoryBuffer sendBuffer;
  2431. initSendBuffer(sendBuffer);
  2432. sendBuffer.append((RemoteFileCommandType)RFCgetver);
  2433. sendBuffer.append((unsigned)RFCgetver);
  2434. MemoryBuffer replyBuffer;
  2435. try
  2436. {
  2437. remoteFileIO.sendRemoteCommand(sendBuffer, replyBuffer, true, false, false);
  2438. }
  2439. catch (IException *e)
  2440. {
  2441. EXCLOG(e);
  2442. ::Release(e);
  2443. return 0;
  2444. }
  2445. unsigned errCode;
  2446. replyBuffer.read(errCode);
  2447. if (errCode==RFSERR_InvalidCommand)
  2448. {
  2449. ver.append("DS V1.0");
  2450. return 10;
  2451. }
  2452. else if (errCode==0)
  2453. ret = 11;
  2454. else if (errCode<0x10000)
  2455. return 0;
  2456. else
  2457. ret = errCode-0x10000;
  2458. StringAttr vers;
  2459. replyBuffer.read(vers);
  2460. ver.append(vers);
  2461. return ret;
  2462. }
  2463. unsigned getRemoteVersion(ISocket * socket, StringBuffer &ver)
  2464. {
  2465. // used to have a global critical section here
  2466. if (!socket)
  2467. return 0;
  2468. Owned<ISecureSocket> ssock;
  2469. if ( (securitySettings.useSSL == SSLOnly) || (securitySettings.useSSL == SSLFirst) )
  2470. {
  2471. char pname[256];
  2472. pname[0] = 0;
  2473. int pport = socket->peer_name(pname, sizeof(pname)-1);
  2474. if ( (pport == securitySettings.daFileSrvSSLPort) && (!socket->isSecure()) )
  2475. {
  2476. #ifdef _USE_OPENSSL
  2477. ssock.setown(createSecureSocket(LINK(socket), ClientSocket));
  2478. int status = ssock->secure_connect();
  2479. if (status < 0)
  2480. throw createDafsException(DAFSERR_connection_failed,"Failure to establish secure connection");
  2481. socket = ssock;
  2482. #else
  2483. throw createDafsException(DAFSERR_connection_failed,"Failure to establish secure connection: OpenSSL disabled in build");
  2484. #endif
  2485. }
  2486. }
  2487. unsigned ret;
  2488. MemoryBuffer sendbuf;
  2489. initSendBuffer(sendbuf);
  2490. sendbuf.append((RemoteFileCommandType)RFCgetver);
  2491. sendbuf.append((unsigned)RFCgetver);
  2492. MemoryBuffer reply;
  2493. try {
  2494. sendBuffer(socket, sendbuf);
  2495. receiveBuffer(socket, reply, 1 ,4096);
  2496. unsigned errCode;
  2497. reply.read(errCode);
  2498. if (errCode==RFSERR_InvalidCommand) {
  2499. ver.append("DS V1.0");
  2500. return 10;
  2501. }
  2502. else if (errCode==0)
  2503. ret = 11;
  2504. else if (errCode<0x10000)
  2505. return 0;
  2506. else
  2507. ret = errCode-0x10000;
  2508. }
  2509. catch (IException *e) {
  2510. EXCLOG(e);
  2511. ::Release(e);
  2512. return 0;
  2513. }
  2514. StringAttr vers;
  2515. reply.read(vers);
  2516. ver.append(vers);
  2517. return ret;
  2518. }
  2519. /////////////////////////
  2520. class CRemoteKeyManager : public CSimpleInterfaceOf<IKeyManager>
  2521. {
  2522. StringAttr filename;
  2523. Linked<IDelayedFile> delayedFile;
  2524. SegMonitorList segs;
  2525. size32_t rowDataRemaining = 0;
  2526. MemoryBuffer rowDataBuffer;
  2527. MemoryBuffer keyCursorMb; // used for continuation
  2528. unsigned __int64 totalGot = 0;
  2529. size32_t keySize = 0;
  2530. size32_t currentSize = 0;
  2531. offset_t currentFpos = 0;
  2532. const byte *currentRow = nullptr;
  2533. bool first = true;
  2534. unsigned __int64 chooseNLimit = 0;
  2535. ConstPointerArray activeBlobs;
  2536. unsigned crc = 0;
  2537. mutable bool hasRemoteSupport = false; // must check 1st
  2538. mutable Owned<IKeyManager> directKM; // failover manager if remote key support is unavailable
  2539. CRemoteFileIO *prepKeySend(MemoryBuffer &sendBuffer, RemoteFileCommandType cmd, bool segmentMonitors)
  2540. {
  2541. Owned<IFileIO> iFileIO = delayedFile->getFileIO();
  2542. if (!iFileIO)
  2543. throw MakeStringException(0, "CRemoteKeyManager: Failed to open key file: %s", filename.get());
  2544. Linked<CRemoteFileIO> remoteIO = QUERYINTERFACE(iFileIO.get(), CRemoteFileIO);
  2545. assertex(remoteIO);
  2546. initSendBuffer(sendBuffer);
  2547. sendBuffer.append(cmd).append(remoteIO->getHandle()).append(filename).append(keySize);
  2548. if (segmentMonitors)
  2549. segs.serialize(sendBuffer);
  2550. return remoteIO.getClear();
  2551. }
  2552. bool remoteSupport() const
  2553. {
  2554. if (hasRemoteSupport)
  2555. return true;
  2556. else if (directKM)
  2557. return false;
  2558. Owned<IFileIO> iFileIO = delayedFile->getFileIO();
  2559. if (!iFileIO)
  2560. throw MakeStringException(0, "CRemoteKeyManager: Failed to open key file: %s", filename.get());
  2561. Linked<CRemoteFileIO> remoteIO = QUERYINTERFACE(iFileIO.get(), CRemoteFileIO);
  2562. bool useRemote = nullptr != remoteIO.get();
  2563. if (useRemote)
  2564. {
  2565. StringBuffer verString;
  2566. unsigned ver = getRemoteVersion(*remoteIO, verString);
  2567. if (ver < MIN_KEYFILTSUPPORT_VERSION)
  2568. useRemote = false;
  2569. }
  2570. if (useRemote)
  2571. {
  2572. PROGLOG("Using remote key manager for file: %s", filename.get());
  2573. hasRemoteSupport = true;
  2574. }
  2575. else
  2576. {
  2577. Owned<IKeyIndex> keyIndex = createKeyIndex(filename, crc, *delayedFile, false, false);
  2578. directKM.setown(createLocalKeyManager(keyIndex, keySize, nullptr));
  2579. return false;
  2580. }
  2581. return true;
  2582. }
  2583. unsigned __int64 _checkCount(unsigned __int64 limit)
  2584. {
  2585. MemoryBuffer sendBuffer;
  2586. Owned<CRemoteFileIO> remoteIO = prepKeySend(sendBuffer, RFCreadfilteredindexcount, true);
  2587. sendBuffer.append(limit);
  2588. MemoryBuffer replyBuffer;
  2589. remoteIO->sendRemoteCommand(sendBuffer, replyBuffer);
  2590. unsigned __int64 count;
  2591. replyBuffer.read(count);
  2592. return count;
  2593. }
  2594. public:
  2595. CRemoteKeyManager(const char *_filename, unsigned _keySize, unsigned _crc, IDelayedFile *_delayedFile) : filename(_filename), keySize(_keySize), crc(_crc), delayedFile(_delayedFile)
  2596. {
  2597. }
  2598. ~CRemoteKeyManager()
  2599. {
  2600. releaseBlobs();
  2601. }
  2602. // IKeyManager impl.
  2603. virtual void reset(bool crappyHack = false) override
  2604. {
  2605. if (!remoteSupport())
  2606. {
  2607. directKM->reset(crappyHack);
  2608. return;
  2609. }
  2610. rowDataBuffer.clear();
  2611. rowDataRemaining = 0;
  2612. keyCursorMb.clear();
  2613. currentSize = 0;
  2614. currentFpos = 0;
  2615. currentRow = nullptr;
  2616. first = true;
  2617. totalGot = 0;
  2618. }
  2619. virtual void releaseSegmentMonitors() override
  2620. {
  2621. if (!remoteSupport())
  2622. {
  2623. directKM->releaseSegmentMonitors();
  2624. return;
  2625. }
  2626. segs.reset();
  2627. }
  2628. virtual const byte *queryKeyBuffer(offset_t & fpos) override
  2629. {
  2630. if (!remoteSupport())
  2631. return directKM->queryKeyBuffer(fpos);;
  2632. fpos = currentFpos;
  2633. return currentRow;
  2634. }
  2635. virtual offset_t queryFpos() override
  2636. {
  2637. if (!remoteSupport())
  2638. return directKM->queryFpos();
  2639. return currentFpos;
  2640. }
  2641. virtual unsigned queryRecordSize() override
  2642. {
  2643. if (!remoteSupport())
  2644. return directKM->queryRecordSize();
  2645. return currentSize;
  2646. }
  2647. virtual bool lookup(bool exact) override
  2648. {
  2649. if (!remoteSupport())
  2650. return directKM->lookup(exact);
  2651. while (true)
  2652. {
  2653. if (rowDataRemaining)
  2654. {
  2655. rowDataBuffer.read(currentFpos);
  2656. rowDataBuffer.read(currentSize);
  2657. currentRow = rowDataBuffer.readDirect(currentSize);
  2658. rowDataRemaining -= sizeof(currentFpos) + sizeof(currentSize) + currentSize;
  2659. return true;
  2660. }
  2661. else
  2662. {
  2663. if (!first && (0 == keyCursorMb.length())) // No keyCursor implies there is nothing more to fetch
  2664. return false;
  2665. unsigned maxRecs = 0;
  2666. if (chooseNLimit)
  2667. {
  2668. if (totalGot == chooseNLimit)
  2669. break;
  2670. unsigned __int64 max = chooseNLimit-totalGot;
  2671. if (max > UINT_MAX)
  2672. maxRecs = UINT_MAX;
  2673. else
  2674. maxRecs = (unsigned)max;
  2675. }
  2676. MemoryBuffer sendBuffer;
  2677. Owned<CRemoteFileIO> remoteIO = prepKeySend(sendBuffer, RFCreadfilteredindex, true);
  2678. sendBuffer.append(first).append(maxRecs);
  2679. if (first)
  2680. first = false;
  2681. else
  2682. {
  2683. dbgassertex(keyCursorMb.length());
  2684. sendBuffer.append(keyCursorMb);
  2685. }
  2686. rowDataBuffer.clear();
  2687. remoteIO->sendRemoteCommand(sendBuffer, rowDataBuffer);
  2688. unsigned recsGot;
  2689. rowDataBuffer.read(recsGot);
  2690. if (0 == recsGot)
  2691. {
  2692. keyCursorMb.clear(); // signals no more data if called again.
  2693. break; // end
  2694. }
  2695. totalGot += recsGot;
  2696. rowDataBuffer.read(rowDataRemaining);
  2697. unsigned pos = rowDataBuffer.getPos(); // start of row data
  2698. const void *rowData = rowDataBuffer.readDirect(rowDataRemaining);
  2699. size32_t keyCursorSz;
  2700. rowDataBuffer.read(keyCursorSz);
  2701. keyCursorMb.clear();
  2702. if (keyCursorSz)
  2703. keyCursorMb.append(keyCursorSz, rowDataBuffer.readDirect(keyCursorSz));
  2704. rowDataBuffer.reset(pos); // reposition to start of row data
  2705. }
  2706. }
  2707. return false;
  2708. }
  2709. virtual unsigned __int64 getCount() override
  2710. {
  2711. if (!remoteSupport())
  2712. return directKM->getCount();
  2713. return _checkCount((unsigned __int64)-1);
  2714. }
  2715. virtual unsigned __int64 getCurrentRangeCount(unsigned groupSegCount) override
  2716. {
  2717. if (!remoteSupport())
  2718. return directKM->getCurrentRangeCount(groupSegCount);
  2719. UNIMPLEMENTED;
  2720. }
  2721. virtual bool nextRange(unsigned groupSegCount) override
  2722. {
  2723. if (!remoteSupport())
  2724. return directKM->nextRange(groupSegCount);
  2725. UNIMPLEMENTED;
  2726. }
  2727. virtual void setKey(IKeyIndexBase * _key) override
  2728. {
  2729. if (!remoteSupport())
  2730. {
  2731. directKM->setKey(_key);
  2732. return;
  2733. }
  2734. UNIMPLEMENTED;
  2735. }
  2736. virtual void setChooseNLimit(unsigned __int64 _chooseNLimit) override
  2737. {
  2738. if (!remoteSupport())
  2739. {
  2740. directKM->setChooseNLimit(_chooseNLimit);
  2741. return;
  2742. }
  2743. chooseNLimit = _chooseNLimit;
  2744. }
  2745. virtual unsigned __int64 checkCount(unsigned __int64 limit) override
  2746. {
  2747. if (!remoteSupport())
  2748. directKM->checkCount(limit);
  2749. return _checkCount(limit);
  2750. }
  2751. virtual void serializeCursorPos(MemoryBuffer &mb) override
  2752. {
  2753. if (!remoteSupport())
  2754. {
  2755. directKM->serializeCursorPos(mb);
  2756. return;
  2757. }
  2758. UNIMPLEMENTED;
  2759. }
  2760. virtual void deserializeCursorPos(MemoryBuffer &mb) override
  2761. {
  2762. if (!remoteSupport())
  2763. {
  2764. directKM->deserializeCursorPos(mb);
  2765. return;
  2766. }
  2767. UNIMPLEMENTED;
  2768. }
  2769. virtual unsigned querySeeks() const override
  2770. {
  2771. if (!remoteSupport())
  2772. return directKM->querySeeks();
  2773. return 0;
  2774. }
  2775. virtual unsigned queryScans() const override
  2776. {
  2777. if (!remoteSupport())
  2778. return directKM->queryScans();
  2779. return 0;
  2780. }
  2781. virtual unsigned querySkips() const override
  2782. {
  2783. if (!remoteSupport())
  2784. return directKM->querySkips();
  2785. return 0;
  2786. }
  2787. virtual unsigned queryNullSkips() const override
  2788. {
  2789. if (!remoteSupport())
  2790. return directKM->queryNullSkips();
  2791. return 0;
  2792. }
  2793. virtual const byte *loadBlob(unsigned __int64 blobId, size32_t &blobSize) override
  2794. {
  2795. if (!remoteSupport())
  2796. return directKM->loadBlob(blobId, blobSize);
  2797. MemoryBuffer sendBuffer;
  2798. Owned<CRemoteFileIO> remoteIO = prepKeySend(sendBuffer, RFCreadfilteredindexblob, false);
  2799. sendBuffer.append(blobId);
  2800. MemoryBuffer replyBuffer;
  2801. remoteIO->sendRemoteCommand(sendBuffer, replyBuffer);
  2802. replyBuffer.read(blobSize);
  2803. const byte *blobData = replyBuffer.readDirect(blobSize);
  2804. activeBlobs.append(replyBuffer.detach()); // NB: don't need to retain size, but keep sz+data to avoid copy
  2805. return blobData;
  2806. }
  2807. virtual void releaseBlobs() override
  2808. {
  2809. if (!remoteSupport())
  2810. return directKM->releaseBlobs();
  2811. ForEachItemIn(idx, activeBlobs)
  2812. {
  2813. free((void *) activeBlobs.item(idx));
  2814. }
  2815. activeBlobs.kill();
  2816. }
  2817. virtual void resetCounts() override
  2818. {
  2819. if (!remoteSupport())
  2820. {
  2821. directKM->resetCounts();
  2822. return;
  2823. }
  2824. UNIMPLEMENTED;
  2825. }
  2826. virtual void setLayoutTranslator(IRecordLayoutTranslator * trans) override
  2827. {
  2828. if (!remoteSupport())
  2829. {
  2830. directKM->setLayoutTranslator(trans);
  2831. return;
  2832. }
  2833. UNIMPLEMENTED;
  2834. }
  2835. virtual void setSegmentMonitors(SegMonitorList &segmentMonitors) override
  2836. {
  2837. if (!remoteSupport())
  2838. {
  2839. directKM->setSegmentMonitors(segmentMonitors);
  2840. return;
  2841. }
  2842. segs.swapWith(segmentMonitors);
  2843. }
  2844. virtual void deserializeSegmentMonitors(MemoryBuffer &mb) override
  2845. {
  2846. if (!remoteSupport())
  2847. {
  2848. directKM->deserializeSegmentMonitors(mb);
  2849. return;
  2850. }
  2851. segs.deserialize(mb);
  2852. }
  2853. virtual void finishSegmentMonitors() override
  2854. {
  2855. if (!remoteSupport())
  2856. {
  2857. directKM->finishSegmentMonitors();
  2858. return;
  2859. }
  2860. }
  2861. virtual bool lookupSkip(const void *seek, size32_t seekGEOffset, size32_t seeklen) override
  2862. {
  2863. if (!remoteSupport())
  2864. return directKM->lookupSkip(seek, seekGEOffset, seeklen);
  2865. UNIMPLEMENTED;
  2866. }
  2867. virtual void append(IKeySegmentMonitor *segment) override
  2868. {
  2869. if (!remoteSupport())
  2870. {
  2871. directKM->append(segment);
  2872. return;
  2873. }
  2874. segs.append(segment);
  2875. }
  2876. virtual unsigned ordinality() const override
  2877. {
  2878. if (!remoteSupport())
  2879. return directKM->ordinality();
  2880. return segs.ordinality();
  2881. }
  2882. virtual IKeySegmentMonitor *item(unsigned idx) const override
  2883. {
  2884. if (!remoteSupport())
  2885. return directKM->item(idx);
  2886. return segs.item(idx);
  2887. }
  2888. virtual void setMergeBarrier(unsigned offset) override
  2889. {
  2890. if (!remoteSupport())
  2891. {
  2892. directKM->setMergeBarrier(offset);
  2893. return;
  2894. }
  2895. UNIMPLEMENTED;
  2896. }
  2897. };
  2898. IKeyManager *createRemoteKeyManager(const char *filename, unsigned keySize, unsigned crc, IDelayedFile *delayedFile)
  2899. {
  2900. return new CRemoteKeyManager(filename, keySize, crc, delayedFile);
  2901. }
  2902. IKeyManager *createKeyManager(const char *filename, unsigned keySize, unsigned crc, IDelayedFile *delayedFile, bool allowRemote, bool forceRemote)
  2903. {
  2904. RemoteFilename rfn;
  2905. rfn.setRemotePath(filename);
  2906. if (forceRemote || (allowRemote && !rfn.isLocal()))
  2907. return createRemoteKeyManager(filename, keySize, crc, delayedFile);
  2908. else
  2909. {
  2910. Owned<IKeyIndex> keyIndex = createKeyIndex(filename, crc, *delayedFile, false, false);
  2911. return createLocalKeyManager(keyIndex, keySize, nullptr);
  2912. }
  2913. }
  2914. //////////////
  2915. extern unsigned stopRemoteServer(ISocket * socket)
  2916. {
  2917. // used to have a global critical section here
  2918. if (!socket)
  2919. return 0;
  2920. MemoryBuffer sendbuf;
  2921. initSendBuffer(sendbuf);
  2922. sendbuf.append((RemoteFileCommandType)RFCstop);
  2923. sendbuf.append((unsigned)RFCstop);
  2924. MemoryBuffer replybuf;
  2925. unsigned errCode = RFSERR_InvalidCommand;
  2926. try {
  2927. sendBuffer(socket, sendbuf);
  2928. receiveBuffer(socket, replybuf, NORMAL_RETRIES, 1024);
  2929. replybuf.read(errCode);
  2930. }
  2931. catch (IJSOCK_Exception *e) {
  2932. if ((e->errorCode()!=JSOCKERR_broken_pipe)&&(e->errorCode()!=JSOCKERR_graceful_close))
  2933. EXCLOG(e);
  2934. else
  2935. errCode = 0;
  2936. }
  2937. catch (IException *e) {
  2938. EXCLOG(e);
  2939. ::Release(e);
  2940. }
  2941. return errCode;
  2942. }
  2943. int setDafsTrace(ISocket * socket,byte flags)
  2944. {
  2945. if (!socket) {
  2946. byte ret = traceFlags;
  2947. traceFlags = flags;
  2948. return ret;
  2949. }
  2950. MemoryBuffer sendbuf;
  2951. initSendBuffer(sendbuf);
  2952. sendbuf.append((RemoteFileCommandType)RFCsettrace).append(flags);
  2953. MemoryBuffer replybuf;
  2954. try {
  2955. sendBuffer(socket, sendbuf);
  2956. receiveBuffer(socket, replybuf, NORMAL_RETRIES, 1024);
  2957. int retcode;
  2958. replybuf.read(retcode);
  2959. return retcode;
  2960. }
  2961. catch (IException *e) {
  2962. EXCLOG(e);
  2963. ::Release(e);
  2964. }
  2965. return -1;
  2966. }
  2967. int setDafsThrottleLimit(ISocket * socket, ThrottleClass throttleClass, unsigned throttleLimit, unsigned throttleDelayMs, unsigned throttleCPULimit, unsigned queueLimit, StringBuffer *errMsg)
  2968. {
  2969. assertex(socket);
  2970. MemoryBuffer sendbuf;
  2971. initSendBuffer(sendbuf);
  2972. sendbuf.append((RemoteFileCommandType)RFCsetthrottle2).append((unsigned)throttleClass).append(throttleLimit);
  2973. sendbuf.append(throttleDelayMs).append(throttleCPULimit).append(queueLimit);
  2974. MemoryBuffer replybuf;
  2975. try {
  2976. sendBuffer(socket, sendbuf);
  2977. receiveBuffer(socket, replybuf, NORMAL_RETRIES, 1024);
  2978. int retcode;
  2979. replybuf.read(retcode);
  2980. if (retcode && errMsg && replybuf.remaining())
  2981. replybuf.read(*errMsg);
  2982. return retcode;
  2983. }
  2984. catch (IException *e) {
  2985. EXCLOG(e);
  2986. ::Release(e);
  2987. }
  2988. return -1;
  2989. }
  2990. int getDafsInfo(ISocket * socket, unsigned level, StringBuffer &retstr)
  2991. {
  2992. if (!socket) {
  2993. retstr.append(VERSTRING);
  2994. return 0;
  2995. }
  2996. MemoryBuffer sendbuf;
  2997. initSendBuffer(sendbuf);
  2998. sendbuf.append((RemoteFileCommandType)RFCgetinfo).append(level);
  2999. MemoryBuffer replybuf;
  3000. try {
  3001. sendBuffer(socket, sendbuf);
  3002. receiveBuffer(socket, replybuf, 1);
  3003. int retcode;
  3004. replybuf.read(retcode);
  3005. if (retcode==0) {
  3006. StringAttr s;
  3007. replybuf.read(s);
  3008. retstr.append(s);
  3009. }
  3010. return retcode;
  3011. }
  3012. catch (IException *e) {
  3013. EXCLOG(e);
  3014. ::Release(e);
  3015. }
  3016. return -1;
  3017. }
  3018. void remoteExtractBlobElements(const SocketEndpoint &ep,const char * prefix, const char * filename, ExtractedBlobArray & extracted)
  3019. {
  3020. Owned<CRemoteFile> file = new CRemoteFile (ep,filename);
  3021. file->remoteExtractBlobElements(prefix, extracted);
  3022. }
  3023. //====================================================================================================
  3024. class CAsyncCommandManager
  3025. {
  3026. class CAsyncJob: public CInterface
  3027. {
  3028. class cThread: public Thread
  3029. {
  3030. CAsyncJob *parent;
  3031. public:
  3032. cThread(CAsyncJob *_parent)
  3033. : Thread("CAsyncJob")
  3034. {
  3035. parent = _parent;
  3036. }
  3037. int run()
  3038. {
  3039. int ret = -1;
  3040. try {
  3041. ret = parent->run();
  3042. parent->setDone();
  3043. }
  3044. catch (IException *e)
  3045. {
  3046. parent->setException(e);
  3047. }
  3048. parent->signal();
  3049. return ret;
  3050. }
  3051. } *thread;
  3052. StringAttr uuid;
  3053. CAsyncCommandManager &parent;
  3054. public:
  3055. CAsyncJob(CAsyncCommandManager &_parent, const char *_uuid)
  3056. : uuid(_uuid), parent(_parent)
  3057. {
  3058. thread = new cThread(this);
  3059. hash = hashc((const byte *)uuid.get(),uuid.length(),~0U);
  3060. }
  3061. ~CAsyncJob()
  3062. {
  3063. thread->join();
  3064. thread->Release();
  3065. }
  3066. static void destroy(CAsyncJob *j)
  3067. {
  3068. j->Release();
  3069. }
  3070. void signal()
  3071. {
  3072. parent.signal();
  3073. }
  3074. void start()
  3075. {
  3076. parent.wait();
  3077. thread->start();
  3078. }
  3079. void join()
  3080. {
  3081. thread->join();
  3082. }
  3083. static unsigned getHash(const char *key)
  3084. {
  3085. return hashc((const byte *)key,strlen(key),~0U);
  3086. }
  3087. static CAsyncJob* create(const char *key) { assertex(!"CAsyncJob::create not implemented"); return NULL; }
  3088. unsigned hash;
  3089. bool eq(const char *key)
  3090. {
  3091. return stricmp(key,uuid.get())==0;
  3092. }
  3093. virtual int run()=0;
  3094. virtual void setException(IException *e)=0;
  3095. virtual void setDone()=0;
  3096. };
  3097. class CAsyncCopySection: public CAsyncJob
  3098. {
  3099. Owned<IFile> src;
  3100. RemoteFilename dst;
  3101. offset_t toOfs;
  3102. offset_t fromOfs;
  3103. offset_t size;
  3104. CFPmode mode; // not yet supported
  3105. CriticalSection sect;
  3106. offset_t done;
  3107. offset_t total;
  3108. Semaphore finished;
  3109. AsyncCommandStatus status;
  3110. Owned<IException> exc;
  3111. public:
  3112. CAsyncCopySection(CAsyncCommandManager &parent, const char *_uuid, const char *fromFile, const char *toFile, offset_t _toOfs, offset_t _fromOfs, offset_t _size)
  3113. : CAsyncJob(parent, _uuid)
  3114. {
  3115. status = ACScontinue;
  3116. src.setown(createIFile(fromFile));
  3117. dst.setRemotePath(toFile);
  3118. toOfs = _toOfs;
  3119. fromOfs = _fromOfs;
  3120. size = _size;
  3121. mode = CFPcontinue;
  3122. done = 0;
  3123. total = (offset_t)-1;
  3124. }
  3125. AsyncCommandStatus poll(offset_t &_done, offset_t &_total,unsigned timeout)
  3126. {
  3127. if (timeout&&finished.wait(timeout))
  3128. finished.signal(); // may need to call again
  3129. CriticalBlock block(sect);
  3130. if (exc)
  3131. throw exc.getClear();
  3132. _done = done;
  3133. _total = total;
  3134. return status;
  3135. }
  3136. int run()
  3137. {
  3138. class cProgress: implements ICopyFileProgress
  3139. {
  3140. CriticalSection &sect;
  3141. CFPmode &mode;
  3142. offset_t &done;
  3143. offset_t &total;
  3144. public:
  3145. cProgress(CriticalSection &_sect,offset_t &_done,offset_t &_total,CFPmode &_mode)
  3146. : sect(_sect), mode(_mode), done(_done), total(_total)
  3147. {
  3148. }
  3149. CFPmode onProgress(offset_t sizeDone, offset_t totalSize)
  3150. {
  3151. CriticalBlock block(sect);
  3152. done = sizeDone;
  3153. total = totalSize;
  3154. return mode;
  3155. }
  3156. } progress(sect,total,done,mode);
  3157. src->copySection(dst,toOfs, fromOfs, size, &progress); // exceptions will be handled by base class
  3158. return 0;
  3159. }
  3160. void setException(IException *e)
  3161. {
  3162. EXCLOG(e,"CAsyncCommandManager::CAsyncJob");
  3163. CriticalBlock block(sect);
  3164. if (exc.get())
  3165. e->Release();
  3166. else
  3167. exc.setown(e);
  3168. status = ACSerror;
  3169. }
  3170. void setDone()
  3171. {
  3172. CriticalBlock block(sect);
  3173. finished.signal();
  3174. status = ACSdone;
  3175. }
  3176. };
  3177. CMinHashTable<CAsyncJob> jobtable;
  3178. CriticalSection sect;
  3179. Semaphore threadsem;
  3180. unsigned limit;
  3181. public:
  3182. CAsyncCommandManager(unsigned _limit) : limit(_limit)
  3183. {
  3184. if (limit) // 0 == unbound
  3185. threadsem.signal(limit); // max number of async jobs
  3186. }
  3187. void join()
  3188. {
  3189. CriticalBlock block(sect);
  3190. unsigned i;
  3191. CAsyncJob *j=jobtable.first(i);
  3192. while (j) {
  3193. j->join();
  3194. j=jobtable.next(i);
  3195. }
  3196. }
  3197. void signal()
  3198. {
  3199. if (limit)
  3200. threadsem.signal();
  3201. }
  3202. void wait()
  3203. {
  3204. if (limit)
  3205. threadsem.wait();
  3206. }
  3207. AsyncCommandStatus copySection(const char *uuid, const char *fromFile, const char *toFile, offset_t toOfs, offset_t fromOfs, offset_t size, offset_t &done, offset_t &total, unsigned timeout)
  3208. {
  3209. // return 0 if continuing, 1 if done
  3210. CAsyncCopySection * job;
  3211. Linked<CAsyncJob> cjob;
  3212. {
  3213. CriticalBlock block(sect);
  3214. cjob.set(jobtable.find(uuid,false));
  3215. if (cjob) {
  3216. job = QUERYINTERFACE(cjob.get(),CAsyncCopySection);
  3217. if (!job) {
  3218. throw MakeStringException(-1,"Async job ID mismatch");
  3219. }
  3220. }
  3221. else {
  3222. job = new CAsyncCopySection(*this, uuid, fromFile, toFile, toOfs, fromOfs, size);
  3223. cjob.setown(job);
  3224. jobtable.add(cjob.getLink());
  3225. cjob->start();
  3226. }
  3227. }
  3228. AsyncCommandStatus ret = ACSerror;
  3229. Owned<IException> rete;
  3230. try {
  3231. ret = job->poll(done,total,timeout);
  3232. }
  3233. catch (IException * e) {
  3234. rete.setown(e);
  3235. }
  3236. if ((ret!=ACScontinue)||rete.get()) {
  3237. job->join();
  3238. CriticalBlock block(sect);
  3239. jobtable.remove(job);
  3240. if (rete.get())
  3241. throw rete.getClear();
  3242. }
  3243. return ret;
  3244. }
  3245. };
  3246. //====================================================================================================
  3247. inline void appendErr(MemoryBuffer &reply, unsigned e)
  3248. {
  3249. reply.append(e).append(getRFSERRText(e));
  3250. }
  3251. inline void appendErr2(MemoryBuffer &reply, unsigned e, unsigned v)
  3252. {
  3253. StringBuffer msg;
  3254. msg.append(getRFSERRText(e)).append(':').append(v);
  3255. reply.append(e).append(msg.str());
  3256. }
  3257. inline void appendErr3(MemoryBuffer &reply, unsigned e, int code, const char *errMsg)
  3258. {
  3259. StringBuffer msg;
  3260. msg.appendf("ERROR: %s(%d) '%s'", getRFSERRText(e), code, errMsg?errMsg:"");
  3261. reply.append(e);
  3262. reply.append(msg.str());
  3263. }
  3264. inline void appendCmdErr(MemoryBuffer &reply, RemoteFileCommandType e, int code, const char *errMsg)
  3265. {
  3266. StringBuffer msg;
  3267. msg.appendf("ERROR: %s(%d) '%s'", getRFCText(e), code, errMsg?errMsg:"");
  3268. // RFCOpenIO needs remapping to non-zero for client to know its an error
  3269. // perhaps we should use code here instead of e ?
  3270. unsigned err = e;
  3271. if (e == RFCopenIO)
  3272. err = RFSERR_OpenFailed;
  3273. reply.append(err);
  3274. reply.append(msg.str());
  3275. }
  3276. #define MAPCOMMAND(c,p) case c: { ret = this->p(msg, reply) ; break; }
  3277. #define MAPCOMMANDCLIENT(c,p,client) case c: { ret = this->p(msg, reply, client); break; }
  3278. #define MAPCOMMANDCLIENTTHROTTLE(c,p,client,throttler) case c: { ret = this->p(msg, reply, client, throttler); break; }
  3279. #define MAPCOMMANDSTATS(c,p,stats) case c: { ret = this->p(msg, reply, stats); break; }
  3280. #define MAPCOMMANDCLIENTSTATS(c,p,client,stats) case c: { ret = this->p(msg, reply, client, stats); break; }
  3281. static unsigned ClientCount = 0;
  3282. static unsigned MaxClientCount = 0;
  3283. static CriticalSection ClientCountSect;
  3284. #define DEFAULT_THROTTLOG_LOG_INTERVAL_SECS 60 // log total throttled delay period
  3285. class CClientStats : public CInterface
  3286. {
  3287. public:
  3288. CClientStats(const char *_client) : client(_client), count(0), bRead(0), bWritten(0) { }
  3289. const char *queryFindString() const { return client; }
  3290. inline void addRead(unsigned __int64 len)
  3291. {
  3292. bRead += len;
  3293. }
  3294. inline void addWrite(unsigned __int64 len)
  3295. {
  3296. bWritten += len;
  3297. }
  3298. void getStatus(StringBuffer & info) const
  3299. {
  3300. info.appendf("Client %s - %" I64F "d requests handled, bytes read = %" I64F "d, bytes written = % " I64F "d",
  3301. client.get(), count, bRead.load(), bWritten.load()).newline();
  3302. }
  3303. StringAttr client;
  3304. unsigned __int64 count;
  3305. std::atomic<unsigned __int64> bRead;
  3306. std::atomic<unsigned __int64> bWritten;
  3307. };
  3308. class CClientStatsTable : public OwningStringSuperHashTableOf<CClientStats>
  3309. {
  3310. typedef OwningStringSuperHashTableOf<CClientStats> PARENT;
  3311. CriticalSection crit;
  3312. unsigned cmdStats[RFCmax];
  3313. static int compareElement(void* const *ll, void* const *rr)
  3314. {
  3315. const CClientStats *l = (const CClientStats *) *ll;
  3316. const CClientStats *r = (const CClientStats *) *rr;
  3317. if (l->count == r->count)
  3318. return 0;
  3319. else if (l->count<r->count)
  3320. return 1;
  3321. else
  3322. return -1;
  3323. }
  3324. public:
  3325. CClientStatsTable()
  3326. {
  3327. memset(&cmdStats[0], 0, sizeof(cmdStats));
  3328. }
  3329. ~CClientStatsTable()
  3330. {
  3331. _releaseAll();
  3332. }
  3333. CClientStats *getClientReference(RemoteFileCommandType cmd, const char *client)
  3334. {
  3335. CriticalBlock b(crit);
  3336. CClientStats *stats = PARENT::find(client);
  3337. if (!stats)
  3338. {
  3339. stats = new CClientStats(client);
  3340. PARENT::replace(*stats);
  3341. }
  3342. if (cmd<RFCmax) // i.e. ignore duff command (which will be traced), but still record client connected
  3343. cmdStats[cmd]++;
  3344. ++stats->count;
  3345. return LINK(stats);
  3346. }
  3347. StringBuffer &getInfo(StringBuffer &info, unsigned level=1)
  3348. {
  3349. CriticalBlock b(crit);
  3350. unsigned __int64 totalCmds = 0;
  3351. for (unsigned c=0; c<RFCmax; c++)
  3352. totalCmds += cmdStats[c];
  3353. unsigned totalClients = PARENT::ordinality();
  3354. info.appendf("Commands processed = %" I64F "u, unique clients = %u", totalCmds, totalClients);
  3355. if (totalCmds)
  3356. {
  3357. info.append("Command stats:").newline();
  3358. for (unsigned c=0; c<RFCmax; c++)
  3359. {
  3360. unsigned __int64 count = cmdStats[c];
  3361. if (count)
  3362. info.append(getRFCText(c)).append(": ").append(count).newline();
  3363. }
  3364. }
  3365. if (totalClients)
  3366. {
  3367. SuperHashIteratorOf<CClientStats> iter(*this);
  3368. PointerArrayOf<CClientStats> elements;
  3369. ForEach(iter)
  3370. {
  3371. CClientStats &elem = iter.query();
  3372. elements.append(&elem);
  3373. }
  3374. elements.sort(&compareElement);
  3375. if (level < 10)
  3376. {
  3377. // list up to 10 clients ordered by # of commands processed
  3378. unsigned max=elements.ordinality();
  3379. if (max>10)
  3380. max = 10; // cap
  3381. info.append("Top 10 clients:").newline();
  3382. for (unsigned e=0; e<max; e++)
  3383. {
  3384. const CClientStats &element = *elements.item(e);
  3385. element.getStatus(info);
  3386. }
  3387. }
  3388. else // list all
  3389. {
  3390. info.append("All clients:").newline();
  3391. ForEachItemIn(e, elements)
  3392. {
  3393. const CClientStats &element = *elements.item(e);
  3394. element.getStatus(info);
  3395. }
  3396. }
  3397. }
  3398. return info;
  3399. }
  3400. void reset()
  3401. {
  3402. CriticalBlock b(crit);
  3403. memset(&cmdStats[0], 0, sizeof(cmdStats));
  3404. kill();
  3405. }
  3406. };
  3407. enum OpenFileFlag { of_null=0x0, of_key=0x01 };
  3408. struct OpenFileInfo
  3409. {
  3410. OpenFileInfo() { }
  3411. OpenFileInfo(int _handle, IFileIO *_fileIO, StringAttrItem *_filename) : handle(_handle), fileIO(_fileIO), filename(_filename) { }
  3412. Linked<IFileIO> fileIO;
  3413. Linked<StringAttrItem> filename; // for debug
  3414. int handle = 0;
  3415. unsigned flags = 0;
  3416. };
  3417. #define MAX_KEYDATA_SZ 0x10000
  3418. class CRemoteFileServer : implements IRemoteFileServer, public CInterface
  3419. {
  3420. class CThrottler;
  3421. class CRemoteClientHandler : implements ISocketSelectNotify, public CInterface
  3422. {
  3423. public:
  3424. CRemoteFileServer *parent;
  3425. Owned<ISocket> socket;
  3426. StringAttr peerName;
  3427. Owned<IAuthenticatedUser> user;
  3428. MemoryBuffer msg;
  3429. bool selecthandled;
  3430. size32_t left;
  3431. StructArrayOf<OpenFileInfo> openFiles;
  3432. Owned<IDirectoryIterator> opendir;
  3433. unsigned lasttick, lastInactiveTick;
  3434. atomic_t &globallasttick;
  3435. unsigned previdx; // for debug
  3436. IMPLEMENT_IINTERFACE;
  3437. CRemoteClientHandler(CRemoteFileServer *_parent,ISocket *_socket,IAuthenticatedUser *_user,atomic_t &_globallasttick)
  3438. : socket(_socket), user(_user), globallasttick(_globallasttick)
  3439. {
  3440. previdx = (unsigned)-1;
  3441. StringBuffer peerBuf;
  3442. char name[256];
  3443. name[0] = 0;
  3444. int port = socket->peer_name(name,sizeof(name)-1);
  3445. if (port>=0)
  3446. {
  3447. peerBuf.append(name);
  3448. if (port)
  3449. peerBuf.append(':').append(port);
  3450. peerName.set(peerBuf);
  3451. }
  3452. else
  3453. {
  3454. /* There's a possibility the socket closed before got here, in which case, peer name is unavailable
  3455. * May potentially be unavailable for other reasons also.
  3456. * Must be set, as used in client stats HT.
  3457. * If socket closed, the handler will start up but notice closed and quit
  3458. */
  3459. peerName.set("UNKNOWN PEER NAME");
  3460. }
  3461. {
  3462. CriticalBlock block(ClientCountSect);
  3463. if (++ClientCount>MaxClientCount)
  3464. MaxClientCount = ClientCount;
  3465. if (TF_TRACE_CLIENT_CONN)
  3466. {
  3467. StringBuffer s;
  3468. s.appendf("Connecting(%p) [%d,%d] to ",this,ClientCount,MaxClientCount);
  3469. s.append(peerName);
  3470. PROGLOG("%s", s.str());
  3471. }
  3472. }
  3473. parent = _parent;
  3474. left = 0;
  3475. msg.setEndian(__BIG_ENDIAN);
  3476. selecthandled = false;
  3477. touch();
  3478. }
  3479. ~CRemoteClientHandler()
  3480. {
  3481. {
  3482. CriticalBlock block(ClientCountSect);
  3483. ClientCount--;
  3484. if (TF_TRACE_CLIENT_CONN) {
  3485. PROGLOG("Disconnecting(%p) [%d,%d] ",this,ClientCount,MaxClientCount);
  3486. }
  3487. }
  3488. ISocket *sock = socket.getClear();
  3489. try {
  3490. sock->Release();
  3491. }
  3492. catch (IException *e) {
  3493. EXCLOG(e,"~CRemoteClientHandler");
  3494. e->Release();
  3495. }
  3496. }
  3497. bool notifySelected(ISocket *sock,unsigned selected)
  3498. {
  3499. if (TF_TRACE_FULL)
  3500. PROGLOG("notifySelected(%p)",this);
  3501. if (sock!=socket)
  3502. WARNLOG("notifySelected - invalid socket passed");
  3503. size32_t avail = (size32_t)socket->avail_read();
  3504. if (avail)
  3505. touch();
  3506. if (left==0)
  3507. {
  3508. try
  3509. {
  3510. left = avail?receiveBufferSize(socket):0;
  3511. }
  3512. catch (IException *e)
  3513. {
  3514. EXCLOG(e,"notifySelected(1)");
  3515. e->Release();
  3516. left = 0;
  3517. }
  3518. if (left)
  3519. {
  3520. avail = (size32_t)socket->avail_read();
  3521. try
  3522. {
  3523. msg.ensureCapacity(left);
  3524. }
  3525. catch (IException *e)
  3526. {
  3527. EXCLOG(e,"notifySelected(2)");
  3528. e->Release();
  3529. left = 0;
  3530. // if too big then corrupted packet so read avail to try and consume
  3531. char fbuf[1024];
  3532. while (avail)
  3533. {
  3534. size32_t rd = avail>sizeof(fbuf)?sizeof(fbuf):avail;
  3535. try
  3536. {
  3537. socket->read(fbuf, rd); // don't need timeout here
  3538. avail -= rd;
  3539. }
  3540. catch (IException *e)
  3541. {
  3542. EXCLOG(e,"notifySelected(2) flush");
  3543. e->Release();
  3544. break;
  3545. }
  3546. }
  3547. avail = 0;
  3548. left = 0;
  3549. }
  3550. }
  3551. }
  3552. size32_t toread = left>avail?avail:left;
  3553. if (toread)
  3554. {
  3555. try
  3556. {
  3557. socket->read(msg.reserve(toread), toread); // don't need timeout here
  3558. }
  3559. catch (IException *e)
  3560. {
  3561. EXCLOG(e,"notifySelected(3)");
  3562. e->Release();
  3563. toread = left;
  3564. msg.clear();
  3565. }
  3566. }
  3567. if (TF_TRACE_FULL)
  3568. PROGLOG("notifySelected %d,%d",toread,left);
  3569. if ((left!=0)&&(avail==0))
  3570. {
  3571. WARNLOG("notifySelected: Closing mid packet, %d remaining", left);
  3572. toread = left;
  3573. msg.clear();
  3574. }
  3575. left -= toread;
  3576. if (left==0)
  3577. {
  3578. // DEBUG
  3579. parent->notify(this, msg); // consumes msg
  3580. }
  3581. return false;
  3582. }
  3583. void logPrevHandle()
  3584. {
  3585. if (previdx<openFiles.ordinality())
  3586. {
  3587. const OpenFileInfo &fileInfo = openFiles.item(previdx);
  3588. PROGLOG("Previous handle(%d): %s", fileInfo.handle, fileInfo.filename->text.get());
  3589. }
  3590. }
  3591. bool throttleCommand(MemoryBuffer &msg)
  3592. {
  3593. RemoteFileCommandType cmd = RFCunknown;
  3594. Owned<IException> e;
  3595. try
  3596. {
  3597. msg.read(cmd);
  3598. parent->throttleCommand(cmd, msg, this);
  3599. return true;
  3600. }
  3601. catch (IException *_e)
  3602. {
  3603. e.setown(_e);
  3604. }
  3605. /* processCommand() will handle most exception and replies,
  3606. * but if throttleCommand fails before it gets that far, this will handle
  3607. */
  3608. MemoryBuffer reply;
  3609. initSendBuffer(reply);
  3610. StringBuffer s;
  3611. e->errorMessage(s);
  3612. appendCmdErr(reply, cmd, e->errorCode(), s.str());
  3613. parent->appendError(cmd, this, cmd, reply);
  3614. sendBuffer(socket, reply);
  3615. return false;
  3616. }
  3617. void processCommand(RemoteFileCommandType cmd, MemoryBuffer &msg, CThrottler *throttler)
  3618. {
  3619. MemoryBuffer reply;
  3620. parent->processCommand(cmd, msg, initSendBuffer(reply), this, throttler);
  3621. sendBuffer(socket, reply);
  3622. }
  3623. bool immediateCommand() // returns false if socket closed or failure
  3624. {
  3625. MemoryBuffer msg;
  3626. msg.setEndian(__BIG_ENDIAN);
  3627. touch();
  3628. size32_t avail = (size32_t)socket->avail_read();
  3629. if (avail==0)
  3630. return false;
  3631. receiveBuffer(socket, msg, 5); // shouldn't timeout as data is available
  3632. touch();
  3633. if (msg.length()==0)
  3634. return false;
  3635. return throttleCommand(msg);
  3636. }
  3637. void process(MemoryBuffer &msg)
  3638. {
  3639. if (selecthandled)
  3640. throttleCommand(msg);
  3641. else
  3642. {
  3643. // msg only used/filled if process() has been triggered by notify()
  3644. while (parent->threadRunningCount()<=parent->targetActiveThreads) // if too many threads add to select handler
  3645. {
  3646. int w;
  3647. try
  3648. {
  3649. w = socket->wait_read(1000);
  3650. }
  3651. catch (IException *e)
  3652. {
  3653. EXCLOG(e, "CRemoteClientHandler::main wait_read error");
  3654. e->Release();
  3655. parent->onCloseSocket(this,1);
  3656. return;
  3657. }
  3658. if (w==0)
  3659. break;
  3660. if ((w<0)||!immediateCommand())
  3661. {
  3662. if (w<0)
  3663. WARNLOG("CRemoteClientHandler::main wait_read error");
  3664. parent->onCloseSocket(this,1);
  3665. return;
  3666. }
  3667. }
  3668. /* This is a bit confusing..
  3669. * The addClient below, adds this request to a selecthandler handled by another thread
  3670. * and passes ownership of 'this' (CRemoteClientHandler)
  3671. *
  3672. * When notified, the selecthandler will launch a new pool thread to handle the request
  3673. * If the pool thread limit is hit, the selecthandler will be blocked [ see comment in CRemoteFileServer::notify() ]
  3674. *
  3675. * Either way, a thread pool slot is occupied when processing a request.
  3676. * Blocked threads, will be blocked for up to 1 minute (as defined by createThreadPool call)
  3677. * IOW, if there are lots of incoming clients that can't be serviced by the CThrottler limit,
  3678. * a large number of pool threads will build up after a while.
  3679. *
  3680. * The CThrottler mechanism, imposes a further hard limit on how many concurrent request threads can be active.
  3681. * If the thread pool had an absolute limit (instead of just introducing a delay), then I don't see the point
  3682. * in this additional layer of throttling..
  3683. */
  3684. selecthandled = true;
  3685. parent->addClient(this); // add to select handler
  3686. // NB: this (CRemoteClientHandler) is now linked by the selecthandler and owned by the 'clients' list
  3687. }
  3688. }
  3689. bool timedOut()
  3690. {
  3691. return (msTick()-lasttick)>CLIENT_TIMEOUT;
  3692. }
  3693. bool inactiveTimedOut()
  3694. {
  3695. unsigned ms = msTick();
  3696. if ((ms-lastInactiveTick)>CLIENT_INACTIVEWARNING_TIMEOUT)
  3697. {
  3698. lastInactiveTick = ms;
  3699. return true;
  3700. }
  3701. return false;
  3702. }
  3703. void touch()
  3704. {
  3705. lastInactiveTick = lasttick = msTick();
  3706. atomic_set(&globallasttick,lasttick);
  3707. }
  3708. const char *queryPeerName()
  3709. {
  3710. return peerName;
  3711. }
  3712. bool getInfo(StringBuffer &str)
  3713. {
  3714. str.append("client(");
  3715. const char *name = queryPeerName();
  3716. bool ok;
  3717. if (name)
  3718. {
  3719. ok = true;
  3720. str.append(name);
  3721. }
  3722. else
  3723. ok = false;
  3724. unsigned ms = msTick();
  3725. str.appendf("): last touch %d ms ago (%d, %d)",ms-lasttick,lasttick,ms);
  3726. ForEachItemIn(i, openFiles)
  3727. {
  3728. const OpenFileInfo &fileInfo = openFiles.item(i);
  3729. str.appendf("\n %d: ", fileInfo.handle);
  3730. str.append(fileInfo.filename->text.get());
  3731. }
  3732. return ok;
  3733. }
  3734. };
  3735. class CThrottleQueueItem : public CSimpleInterface
  3736. {
  3737. public:
  3738. RemoteFileCommandType cmd;
  3739. Linked<CRemoteClientHandler> client;
  3740. MemoryBuffer msg;
  3741. CCycleTimer timer;
  3742. CThrottleQueueItem(RemoteFileCommandType _cmd, MemoryBuffer &_msg, CRemoteClientHandler *_client) : cmd(_cmd), client(_client)
  3743. {
  3744. msg.swapWith(_msg);
  3745. }
  3746. };
  3747. class CThrottler
  3748. {
  3749. Semaphore sem;
  3750. CriticalSection crit, configureCrit;
  3751. StringAttr title;
  3752. unsigned limit, delayMs, cpuThreshold, queueLimit;
  3753. unsigned disabledLimit;
  3754. unsigned __int64 totalThrottleDelay;
  3755. CCycleTimer totalThrottleDelayTimer;
  3756. QueueOf<CThrottleQueueItem, false> queue;
  3757. unsigned statsIntervalSecs;
  3758. public:
  3759. CThrottler(const char *_title) : title(_title)
  3760. {
  3761. totalThrottleDelay = 0;
  3762. limit = 0;
  3763. delayMs = DEFAULT_STDCMD_THROTTLEDELAYMS;
  3764. cpuThreshold = DEFAULT_STDCMD_THROTTLECPULIMIT;
  3765. disabledLimit = 0;
  3766. queueLimit = DEFAULT_STDCMD_THROTTLEQUEUELIMIT;
  3767. statsIntervalSecs = DEFAULT_STDCMD_THROTTLECPULIMIT;
  3768. }
  3769. ~CThrottler()
  3770. {
  3771. for (;;)
  3772. {
  3773. Owned<CThrottleQueueItem> item = queue.dequeue();
  3774. if (!item)
  3775. break;
  3776. }
  3777. }
  3778. unsigned queryLimit() const { return limit; }
  3779. unsigned queryDelayMs() const { return delayMs; };;
  3780. unsigned queryCpuThreshold() const { return cpuThreshold; }
  3781. unsigned queryQueueLimit() const { return queueLimit; }
  3782. StringBuffer &getInfoSummary(StringBuffer &info)
  3783. {
  3784. info.appendf("Throttler(%s) - limit=%u, delayMs=%u, cpuThreshold=%u, queueLimit=%u", title.get(), limit, delayMs, cpuThreshold, queueLimit).newline();
  3785. unsigned elapsedSecs = totalThrottleDelayTimer.elapsedMs()/1000;
  3786. time_t simple;
  3787. time(&simple);
  3788. simple -= elapsedSecs;
  3789. CDateTime dt;
  3790. dt.set(simple);
  3791. StringBuffer dateStr;
  3792. dt.getTimeString(dateStr, true);
  3793. info.appendf("Throttler(%s): statistics since %s", title.get(), dateStr.str()).newline();
  3794. info.appendf("Total delay of %0.2f seconds", ((double)totalThrottleDelay)/1000).newline();
  3795. info.appendf("Requests currently queued: %u", queue.ordinality());
  3796. return info;
  3797. }
  3798. void getInfo(StringBuffer &info)
  3799. {
  3800. CriticalBlock b(crit);
  3801. getInfoSummary(info).newline();
  3802. }
  3803. void configure(unsigned _limit, unsigned _delayMs, unsigned _cpuThreshold, unsigned _queueLimit)
  3804. {
  3805. if (_limit > THROTTLE_MAX_LIMIT || _delayMs > THROTTLE_MAX_DELAYMS || _cpuThreshold > THROTTLE_MAX_CPUTHRESHOLD || _queueLimit > THROTTLE_MAX_QUEUELIMIT)
  3806. throw MakeStringException(0, "Throttler(%s), rejecting configure command: limit=%u (max permitted=%u), delayMs=%u (max permitted=%u), cpuThreshold=%u (max permitted=%u), queueLimit=%u (max permitted=%u)",
  3807. title.str(), _limit, THROTTLE_MAX_LIMIT, _delayMs, THROTTLE_MAX_DELAYMS, _cpuThreshold,
  3808. THROTTLE_MAX_CPUTHRESHOLD, _queueLimit, THROTTLE_MAX_QUEUELIMIT);
  3809. CriticalBlock b(configureCrit);
  3810. int delta = 0;
  3811. if (_limit)
  3812. {
  3813. if (disabledLimit) // if transitioning from disabled to some throttling
  3814. {
  3815. assertex(0 == limit);
  3816. delta = _limit - disabledLimit; // + or -
  3817. disabledLimit = 0;
  3818. }
  3819. else
  3820. delta = _limit - limit; // + or -
  3821. }
  3822. else if (0 == disabledLimit)
  3823. {
  3824. PROGLOG("Throttler(%s): disabled, previous limit: %u", title.get(), limit);
  3825. /* disabling - set limit immediately to let all new transaction through.
  3826. * NB: the semaphore signals are not consumed in this case, because transactions could be waiting on it.
  3827. * Instead the existing 'limit' is kept in 'disabledLimit', so that if/when throttling is
  3828. * re-enabled, it is used as a basis for increasing or consuming the semaphore signal count.
  3829. */
  3830. disabledLimit = limit;
  3831. limit = 0;
  3832. }
  3833. if (delta > 0)
  3834. {
  3835. PROGLOG("Throttler(%s): Increasing limit from %u to %u", title.get(), limit, _limit);
  3836. sem.signal(delta);
  3837. limit = _limit;
  3838. // NB: If throttling was off, this doesn't effect transactions in progress, i.e. will only throttle new transactions coming in.
  3839. }
  3840. else if (delta < 0)
  3841. {
  3842. PROGLOG("Throttler(%s): Reducing limit from %u to %u", title.get(), limit, _limit);
  3843. // NB: This is not expected to take long
  3844. CCycleTimer timer;
  3845. while (delta < 0)
  3846. {
  3847. if (sem.wait(1000))
  3848. ++delta;
  3849. else
  3850. PROGLOG("Throttler(%s): Waited %0.2f seconds so far for up to a maximum of %u (previous limit) transactions to complete, %u completed", title.get(), ((double)timer.elapsedMs())/1000, limit, -delta);
  3851. }
  3852. limit = _limit;
  3853. // NB: doesn't include transactions in progress, i.e. will only throttle new transactions coming in.
  3854. }
  3855. if (_delayMs != delayMs)
  3856. {
  3857. PROGLOG("Throttler(%s): New delayMs=%u, previous: %u", title.get(), _delayMs, delayMs);
  3858. delayMs = _delayMs;
  3859. }
  3860. if (_cpuThreshold != cpuThreshold)
  3861. {
  3862. PROGLOG("Throttler(%s): New cpuThreshold=%u, previous: %u", title.get(), _cpuThreshold, cpuThreshold);
  3863. cpuThreshold = _cpuThreshold;
  3864. }
  3865. if (((unsigned)-1) != _queueLimit && _queueLimit != queueLimit)
  3866. {
  3867. PROGLOG("Throttler(%s): New queueLimit=%u%s, previous: %u", title.get(), _queueLimit, 0==_queueLimit?"(disabled)":"", queueLimit);
  3868. queueLimit = _queueLimit;
  3869. }
  3870. }
  3871. void setStatsInterval(unsigned _statsIntervalSecs)
  3872. {
  3873. if (_statsIntervalSecs != statsIntervalSecs)
  3874. {
  3875. PROGLOG("Throttler(%s): New statsIntervalSecs=%u, previous: %u", title.get(), _statsIntervalSecs, statsIntervalSecs);
  3876. statsIntervalSecs = _statsIntervalSecs;
  3877. }
  3878. }
  3879. void take(RemoteFileCommandType cmd) // cmd for info. only
  3880. {
  3881. for (;;)
  3882. {
  3883. if (sem.wait(delayMs))
  3884. return;
  3885. PROGLOG("Throttler(%s): transaction delayed [cmd=%s]", title.get(), getRFCText(cmd));
  3886. }
  3887. }
  3888. void release()
  3889. {
  3890. sem.signal();
  3891. }
  3892. StringBuffer &getStats(StringBuffer &stats, bool reset)
  3893. {
  3894. CriticalBlock b(crit);
  3895. getInfoSummary(stats);
  3896. if (reset)
  3897. {
  3898. totalThrottleDelayTimer.reset();
  3899. totalThrottleDelay = 0;
  3900. }
  3901. return stats;
  3902. }
  3903. void addCommand(RemoteFileCommandType cmd, MemoryBuffer &msg, CRemoteClientHandler *client)
  3904. {
  3905. CCycleTimer timer;
  3906. Owned<IException> exception;
  3907. bool hadSem = true;
  3908. if (!sem.wait(delayMs))
  3909. {
  3910. CriticalBlock b(crit);
  3911. if (!sem.wait(0)) // check hasn't become available
  3912. {
  3913. unsigned cpu = getLatestCPUUsage();
  3914. if (getLatestCPUUsage()<cpuThreshold)
  3915. {
  3916. /* Allow to proceed, despite hitting throttle limit because CPU < threshold
  3917. * NB: The overall number of threads is still capped by the thread pool.
  3918. */
  3919. unsigned ms = timer.elapsedMs();
  3920. totalThrottleDelay += ms;
  3921. PROGLOG("Throttler(%s): transaction delayed [cmd=%s] for : %u milliseconds, proceeding as cpu(%u)<throttleCPULimit(%u)", title.get(), getRFCText(cmd), cpu, ms, cpuThreshold);
  3922. hadSem = false;
  3923. }
  3924. else
  3925. {
  3926. if (queueLimit && queue.ordinality()>=queueLimit)
  3927. throw MakeStringException(0, "Throttler(%s), the maxiumum number of items are queued (%u), rejecting new command[%s]", title.str(), queue.ordinality(), getRFCText(cmd));
  3928. queue.enqueue(new CThrottleQueueItem(cmd, msg, client)); // NB: takes over ownership of 'client' from running thread
  3929. PROGLOG("Throttler(%s): transaction delayed [cmd=%s], queuing (%u queueud), [client=%p, sock=%u]", title.get(), getRFCText(cmd), queue.ordinality(), client, client->socket->OShandle());
  3930. return;
  3931. }
  3932. }
  3933. }
  3934. /* Guarantee that sem is released.
  3935. * Should normally release on clean exit when queue is empty.
  3936. */
  3937. struct ReleaseSem
  3938. {
  3939. Semaphore *sem;
  3940. ReleaseSem(Semaphore *_sem) { sem = _sem; }
  3941. ~ReleaseSem() { if (sem) sem->signal(); }
  3942. } releaseSem(hadSem?&sem:NULL);
  3943. /* Whilst holding on this throttle slot (i.e. before signalling semaphore back), process
  3944. * queued items. NB: other threads that are finishing will do also.
  3945. * Queued items are processed 1st, then the current request, then anything that was queued when handling current request
  3946. * Throttle slot (semaphore) is only given back when no more to do.
  3947. */
  3948. Linked<CRemoteClientHandler> currentClient;
  3949. MemoryBuffer currentMsg;
  3950. unsigned ms;
  3951. for (;;)
  3952. {
  3953. RemoteFileCommandType currentCmd;
  3954. {
  3955. CriticalBlock b(crit);
  3956. Owned<CThrottleQueueItem> item = queue.dequeue();
  3957. if (item)
  3958. {
  3959. currentCmd = item->cmd;
  3960. currentClient.setown(item->client.getClear());
  3961. currentMsg.swapWith(item->msg);
  3962. ms = item->timer.elapsedMs();
  3963. }
  3964. else
  3965. {
  3966. if (NULL == client) // previously handled and queue empty
  3967. {
  3968. /* Commands are only queued if semaphore is exhaused (checked inside crit)
  3969. * so only signal the semaphore inside the crit, after checking if there are no queued items
  3970. */
  3971. if (hadSem)
  3972. {
  3973. releaseSem.sem = NULL;
  3974. sem.signal();
  3975. }
  3976. break;
  3977. }
  3978. currentCmd = cmd;
  3979. currentClient.set(client); // process current request after dealing with queue
  3980. currentMsg.swapWith(msg);
  3981. ms = timer.elapsedMs();
  3982. client = NULL;
  3983. }
  3984. }
  3985. if (ms >= 1000)
  3986. {
  3987. if (ms>delayMs)
  3988. PROGLOG("Throttler(%s): transaction delayed [cmd=%s] for : %u seconds", title.get(), getRFCText(currentCmd), ms/1000);
  3989. }
  3990. {
  3991. CriticalBlock b(crit);
  3992. totalThrottleDelay += ms;
  3993. }
  3994. try
  3995. {
  3996. currentClient->processCommand(currentCmd, currentMsg, this);
  3997. }
  3998. catch (IException *e)
  3999. {
  4000. EXCLOG(e, "addCommand: processCommand failed");
  4001. e->Release();
  4002. }
  4003. }
  4004. }
  4005. };
  4006. // temporarily release a throttler slot
  4007. class CThrottleReleaseBlock
  4008. {
  4009. CThrottler &throttler;
  4010. RemoteFileCommandType cmd;
  4011. public:
  4012. CThrottleReleaseBlock(CThrottler &_throttler, RemoteFileCommandType _cmd) : throttler(_throttler), cmd(_cmd)
  4013. {
  4014. throttler.release();
  4015. }
  4016. ~CThrottleReleaseBlock()
  4017. {
  4018. throttler.take(cmd);
  4019. }
  4020. };
  4021. int lasthandle;
  4022. CriticalSection sect;
  4023. Owned<ISocket> acceptsock;
  4024. Owned<ISocket> securesock;
  4025. Owned<ISocketSelectHandler> selecthandler;
  4026. Owned<IThreadPool> threads; // for commands
  4027. bool stopping;
  4028. unsigned clientcounttick;
  4029. unsigned closedclients;
  4030. CAsyncCommandManager asyncCommandManager;
  4031. CThrottler stdCmdThrottler, slowCmdThrottler;
  4032. CClientStatsTable clientStatsTable;
  4033. atomic_t globallasttick;
  4034. unsigned targetActiveThreads;
  4035. int getNextHandle()
  4036. {
  4037. // called in sect critical block
  4038. for (;;) {
  4039. if (lasthandle==INT_MAX)
  4040. lasthandle = 1;
  4041. else
  4042. lasthandle++;
  4043. unsigned idx1;
  4044. unsigned idx2;
  4045. if (!findHandle(lasthandle,idx1,idx2))
  4046. return lasthandle;
  4047. }
  4048. }
  4049. bool findHandle(int handle,unsigned &clientidx,unsigned &handleidx)
  4050. {
  4051. // called in sect critical block
  4052. clientidx = (unsigned)-1;
  4053. handleidx = (unsigned)-1;
  4054. ForEachItemIn(i,clients) {
  4055. CRemoteClientHandler &client = clients.item(i);
  4056. ForEachItemIn(j, client.openFiles)
  4057. {
  4058. if (client.openFiles.item(j).handle==handle)
  4059. {
  4060. handleidx = j;
  4061. clientidx = i;
  4062. return true;
  4063. }
  4064. }
  4065. }
  4066. return false;
  4067. }
  4068. unsigned readKeyData(IKeyManager *keyManager, unsigned maxRecs, MemoryBuffer &reply, bool &maxHit)
  4069. {
  4070. DelayedSizeMarker keyDataSzReturned(reply);
  4071. unsigned numRecs = 0;
  4072. maxHit = false;
  4073. unsigned pos = reply.length();
  4074. while (keyManager->lookup(true))
  4075. {
  4076. unsigned size = keyManager->queryRecordSize();
  4077. offset_t fpos;
  4078. const byte *result = keyManager->queryKeyBuffer(fpos);
  4079. reply.append(fpos);
  4080. reply.append(size);
  4081. reply.append(size, result);
  4082. ++numRecs;
  4083. if (maxRecs && (0 == --maxRecs))
  4084. {
  4085. maxHit = true;
  4086. break;
  4087. }
  4088. if (reply.length()-pos >= MAX_KEYDATA_SZ)
  4089. {
  4090. maxHit = true;
  4091. break;
  4092. }
  4093. }
  4094. keyDataSzReturned.write();
  4095. return numRecs;
  4096. }
  4097. IKeyManager *prepKey(int handle, const char *keyname, unsigned keySize, SegMonitorList *segs)
  4098. {
  4099. OpenFileInfo fileInfo;
  4100. if (!lookupFileIOHandle(handle, fileInfo, of_key))
  4101. {
  4102. VStringBuffer errStr("Error opening key file : %s", keyname);
  4103. throw createDafsException(RFSERR_InvalidFileIOHandle, errStr.str());
  4104. }
  4105. Owned<IKeyIndex> index = createKeyIndex(keyname, 0, *fileInfo.fileIO, false, false);
  4106. if (!index)
  4107. {
  4108. VStringBuffer errStr("Error opening key file : %s", keyname);
  4109. throw createDafsException(RFSERR_KeyIndexFailed, errStr.str());
  4110. }
  4111. Owned<IKeyManager> keyManager = createLocalKeyManager(index, keySize, nullptr);
  4112. if (segs)
  4113. {
  4114. keyManager->setSegmentMonitors(*segs);
  4115. keyManager->finishSegmentMonitors();
  4116. }
  4117. keyManager->reset();
  4118. return keyManager.getLink();
  4119. }
  4120. IKeyManager *prepKey(MemoryBuffer &mb, bool segmentMonitors)
  4121. {
  4122. int handle;
  4123. StringBuffer keyName;
  4124. size32_t keySize;
  4125. mb.read(handle).read(keyName).read(keySize);
  4126. if (segmentMonitors)
  4127. {
  4128. SegMonitorList segs;
  4129. segs.deserialize(mb);
  4130. return prepKey(handle, keyName, keySize, &segs);
  4131. }
  4132. else
  4133. return prepKey(handle, keyName, keySize, nullptr);
  4134. }
  4135. class cCommandProcessor: public CInterface, implements IPooledThread
  4136. {
  4137. Owned<CRemoteClientHandler> client;
  4138. MemoryBuffer msg;
  4139. public:
  4140. IMPLEMENT_IINTERFACE;
  4141. struct cCommandProcessorParams
  4142. {
  4143. cCommandProcessorParams() { msg.setEndian(__BIG_ENDIAN); }
  4144. CRemoteClientHandler *client;
  4145. MemoryBuffer msg;
  4146. };
  4147. void init(void *_params)
  4148. {
  4149. cCommandProcessorParams &params = *(cCommandProcessorParams *)_params;
  4150. client.setown(params.client);
  4151. msg.swapWith(params.msg);
  4152. }
  4153. void main()
  4154. {
  4155. // idea is that initially we process commands inline then pass over to select handler
  4156. try
  4157. {
  4158. client->process(msg);
  4159. }
  4160. catch (IException *e)
  4161. {
  4162. // suppress some errors
  4163. EXCLOG(e,"cCommandProcessor::main");
  4164. e->Release();
  4165. }
  4166. try
  4167. {
  4168. client.clear();
  4169. }
  4170. catch (IException *e)
  4171. {
  4172. // suppress some more errors clearing client
  4173. EXCLOG(e,"cCommandProcessor::main(2)");
  4174. e->Release();
  4175. }
  4176. }
  4177. bool stop()
  4178. {
  4179. return true;
  4180. }
  4181. bool canReuse()
  4182. {
  4183. return false; // want to free owned socket
  4184. }
  4185. };
  4186. IArrayOf<CRemoteClientHandler> clients;
  4187. class cImpersonateBlock
  4188. {
  4189. CRemoteClientHandler &client;
  4190. public:
  4191. cImpersonateBlock(CRemoteClientHandler &_client)
  4192. : client(_client)
  4193. {
  4194. if (client.user.get()) {
  4195. if (TF_TRACE)
  4196. PROGLOG("Impersonate user: %s",client.user->username());
  4197. client.user->impersonate();
  4198. }
  4199. }
  4200. ~cImpersonateBlock()
  4201. {
  4202. if (client.user.get()) {
  4203. if (TF_TRACE)
  4204. PROGLOG("Stop impersonating user: %s",client.user->username());
  4205. client.user->revert();
  4206. }
  4207. }
  4208. };
  4209. #define IMPERSONATE_USER(client) cImpersonateBlock ublock(client)
  4210. public:
  4211. IMPLEMENT_IINTERFACE
  4212. CRemoteFileServer(unsigned maxThreads, unsigned maxThreadsDelayMs, unsigned maxAsyncCopy)
  4213. : asyncCommandManager(maxAsyncCopy), stdCmdThrottler("stdCmdThrotlter"), slowCmdThrottler("slowCmdThrotlter")
  4214. {
  4215. lasthandle = 0;
  4216. selecthandler.setown(createSocketSelectHandler(NULL));
  4217. stdCmdThrottler.configure(DEFAULT_STDCMD_PARALLELREQUESTLIMIT, DEFAULT_STDCMD_THROTTLEDELAYMS, DEFAULT_STDCMD_THROTTLECPULIMIT, DEFAULT_STDCMD_THROTTLEQUEUELIMIT);
  4218. slowCmdThrottler.configure(DEFAULT_SLOWCMD_PARALLELREQUESTLIMIT, DEFAULT_SLOWCMD_THROTTLEDELAYMS, DEFAULT_SLOWCMD_THROTTLECPULIMIT, DEFAULT_SLOWCMD_THROTTLEQUEUELIMIT);
  4219. unsigned targetMinThreads=maxThreads*20/100; // 20%
  4220. if (0 == targetMinThreads) targetMinThreads = 1;
  4221. targetActiveThreads=maxThreads*80/100; // 80%
  4222. if (0 == targetActiveThreads) targetActiveThreads = 1;
  4223. class CCommandFactory : public CSimpleInterfaceOf<IThreadFactory>
  4224. {
  4225. CRemoteFileServer &parent;
  4226. public:
  4227. CCommandFactory(CRemoteFileServer &_parent) : parent(_parent) { }
  4228. virtual IPooledThread *createNew()
  4229. {
  4230. return parent.createCommandProcessor();
  4231. }
  4232. };
  4233. Owned<IThreadFactory> factory = new CCommandFactory(*this); // NB: pool links factory, so takes ownership
  4234. threads.setown(createThreadPool("CRemoteFileServerPool", factory, NULL, maxThreads, maxThreadsDelayMs,
  4235. #ifdef __64BIT__
  4236. 0, // Unlimited stack size
  4237. #else
  4238. 0x10000,
  4239. #endif
  4240. INFINITE,targetMinThreads));
  4241. threads->setStartDelayTracing(60); // trace amount delayed every minute.
  4242. PROGLOG("CRemoteFileServer: maxThreads = %u, maxThreadsDelayMs = %u, maxAsyncCopy = %u", maxThreads, maxThreadsDelayMs, maxAsyncCopy);
  4243. stopping = false;
  4244. clientcounttick = msTick();
  4245. closedclients = 0;
  4246. atomic_set(&globallasttick,msTick());
  4247. }
  4248. ~CRemoteFileServer()
  4249. {
  4250. #ifdef _DEBUG
  4251. PROGLOG("Exiting CRemoteFileServer");
  4252. #endif
  4253. asyncCommandManager.join();
  4254. clients.kill();
  4255. #ifdef _DEBUG
  4256. PROGLOG("Exited CRemoteFileServer");
  4257. #endif
  4258. }
  4259. bool lookupFileIOHandle(int handle, OpenFileInfo &fileInfo, unsigned newFlags=0)
  4260. {
  4261. if (handle<=0)
  4262. return false;
  4263. CriticalBlock block(sect);
  4264. unsigned clientidx;
  4265. unsigned handleidx;
  4266. if (!findHandle(handle,clientidx,handleidx))
  4267. return false;
  4268. CRemoteClientHandler &client = clients.item(clientidx);
  4269. OpenFileInfo &openFileInfo = client.openFiles.element(handleidx); // NB: links members
  4270. openFileInfo.flags |= newFlags;
  4271. fileInfo = openFileInfo;
  4272. client.previdx = handleidx;
  4273. return true;
  4274. }
  4275. //MORE: The file handles should timeout after a while, and accessing an old (invalid handle)
  4276. // should throw a different exception
  4277. bool checkFileIOHandle(int handle, IFileIO *&fileio, bool del=false)
  4278. {
  4279. fileio = NULL;
  4280. if (handle<=0)
  4281. return false;
  4282. CriticalBlock block(sect);
  4283. unsigned clientidx;
  4284. unsigned handleidx;
  4285. if (findHandle(handle,clientidx,handleidx))
  4286. {
  4287. CRemoteClientHandler &client = clients.item(clientidx);
  4288. const OpenFileInfo &fileInfo = client.openFiles.item(handleidx);
  4289. if (del)
  4290. {
  4291. if (fileInfo.flags & of_key)
  4292. clearKeyStoreCacheEntry(fileInfo.fileIO);
  4293. client.openFiles.remove(handleidx);
  4294. client.previdx = (unsigned)-1;
  4295. }
  4296. else
  4297. {
  4298. fileio = client.openFiles.item(handleidx).fileIO;
  4299. client.previdx = handleidx;
  4300. }
  4301. return true;
  4302. }
  4303. return false;
  4304. }
  4305. bool checkFileIOHandle(MemoryBuffer &reply, int handle, IFileIO *&fileio, bool del=false)
  4306. {
  4307. if (!checkFileIOHandle(handle, fileio, del))
  4308. {
  4309. appendErr(reply, RFSERR_InvalidFileIOHandle);
  4310. return false;
  4311. }
  4312. return true;
  4313. }
  4314. void onCloseSocket(CRemoteClientHandler *client, int which)
  4315. {
  4316. if (!client)
  4317. return;
  4318. CriticalBlock block(sect);
  4319. #ifdef _DEBUG
  4320. StringBuffer s(client->queryPeerName());
  4321. PROGLOG("onCloseSocket(%d) %s",which,s.str());
  4322. #endif
  4323. if (client->socket)
  4324. {
  4325. try
  4326. {
  4327. /* JCSMORE - shouldn't this really be dependent on whether selecthandled=true
  4328. * It has not been added to the selecthandler
  4329. * Harmless, but wasteful if so.
  4330. */
  4331. selecthandler->remove(client->socket);
  4332. }
  4333. catch (IException *e) {
  4334. EXCLOG(e,"CRemoteFileServer::onCloseSocket.1");
  4335. e->Release();
  4336. }
  4337. }
  4338. try {
  4339. clients.zap(*client);
  4340. }
  4341. catch (IException *e) {
  4342. EXCLOG(e,"CRemoteFileServer::onCloseSocket.2");
  4343. e->Release();
  4344. }
  4345. }
  4346. bool cmdOpenFileIO(MemoryBuffer & msg, MemoryBuffer & reply, CRemoteClientHandler &client)
  4347. {
  4348. IMPERSONATE_USER(client);
  4349. Owned<StringAttrItem> name = new StringAttrItem;
  4350. byte mode;
  4351. byte share;
  4352. msg.read(name->text).read(mode).read(share);
  4353. // also try to recv extra byte
  4354. byte extra = 0;
  4355. unsigned short sMode = IFUnone;
  4356. unsigned short cFlags = IFUnone;
  4357. if (msg.remaining() >= sizeof(byte))
  4358. {
  4359. msg.read(extra);
  4360. // and then try to recv extra sMode, cFlags (always sent together)
  4361. if (msg.remaining() >= (sizeof(sMode) + sizeof(cFlags)))
  4362. msg.read(sMode).read(cFlags);
  4363. }
  4364. IFEflags extraFlags = (IFEflags)extra;
  4365. // none => nocache for remote (hint)
  4366. // can revert to previous behavior with conf file setting "allow_pgcache_flush=false"
  4367. if (extraFlags == IFEnone)
  4368. extraFlags = IFEnocache;
  4369. Owned<IFile> file = createIFile(name->text);
  4370. switch ((compatIFSHmode)share) {
  4371. case compatIFSHnone:
  4372. file->setCreateFlags(S_IRUSR|S_IWUSR);
  4373. file->setShareMode(IFSHnone);
  4374. break;
  4375. case compatIFSHread:
  4376. file->setShareMode(IFSHread);
  4377. break;
  4378. case compatIFSHwrite:
  4379. file->setShareMode(IFSHfull);
  4380. break;
  4381. case compatIFSHexec:
  4382. file->setCreateFlags(S_IRUSR|S_IWUSR|S_IXUSR|S_IRGRP|S_IXGRP|S_IROTH|S_IXOTH);
  4383. break;
  4384. case compatIFSHall:
  4385. file->setCreateFlags(S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP|S_IROTH|S_IWOTH); // bit excessive
  4386. file->setShareMode(IFSHfull);
  4387. break;
  4388. }
  4389. // use sMode, cFlags if sent
  4390. if (sMode != IFUnone && cFlags != IFUnone)
  4391. {
  4392. file->setCreateFlags(cFlags);
  4393. file->setShareMode((IFSHmode)sMode);
  4394. }
  4395. if (TF_TRACE_PRE_IO)
  4396. PROGLOG("before open file '%s', (%d,%d,%d,%d,0%o)",name->text.get(),(int)mode,(int)share,extraFlags,sMode,cFlags);
  4397. Owned<IFileIO> fileio = file->open((IFOmode)mode,extraFlags);
  4398. int handle;
  4399. if (fileio) {
  4400. CriticalBlock block(sect);
  4401. handle = getNextHandle();
  4402. client.previdx = client.openFiles.ordinality();
  4403. client.openFiles.append(OpenFileInfo(handle, fileio, name));
  4404. }
  4405. else
  4406. handle = 0;
  4407. reply.append(RFEnoerror);
  4408. reply.append(handle);
  4409. if (TF_TRACE)
  4410. PROGLOG("open file '%s', (%d,%d) handle = %d",name->text.get(),(int)mode,(int)share,handle);
  4411. return true;
  4412. }
  4413. bool cmdCloseFileIO(MemoryBuffer & msg, MemoryBuffer & reply)
  4414. {
  4415. int handle;
  4416. msg.read(handle);
  4417. IFileIO *fileio;
  4418. if (!checkFileIOHandle(reply, handle, fileio, true))
  4419. return false;
  4420. if (TF_TRACE)
  4421. PROGLOG("close file, handle = %d",handle);
  4422. reply.append(RFEnoerror);
  4423. return true;
  4424. }
  4425. bool cmdRead(MemoryBuffer & msg, MemoryBuffer & reply, CClientStats &stats)
  4426. {
  4427. int handle;
  4428. __int64 pos;
  4429. size32_t len;
  4430. msg.read(handle).read(pos).read(len);
  4431. IFileIO *fileio;
  4432. if (!checkFileIOHandle(reply, handle, fileio))
  4433. return false;
  4434. //arrange it so we read directly into the reply buffer...
  4435. unsigned posOfErr = reply.length();
  4436. reply.append((unsigned)RFEnoerror);
  4437. size32_t numRead;
  4438. unsigned posOfLength = reply.length();
  4439. if (TF_TRACE_PRE_IO)
  4440. PROGLOG("before read file, handle = %d, toread = %d",handle,len);
  4441. void * data;
  4442. {
  4443. reply.reserve(sizeof(numRead));
  4444. data = reply.reserve(len);
  4445. }
  4446. try {
  4447. numRead = fileio->read(pos,len,data);
  4448. }
  4449. catch (IException *e)
  4450. {
  4451. reply.setWritePos(posOfErr);
  4452. StringBuffer s;
  4453. e->errorMessage(s);
  4454. appendErr3(reply, RFSERR_ReadFailed, e->errorCode(), s.str());
  4455. e->Release();
  4456. return false;
  4457. }
  4458. stats.addRead(len);
  4459. if (TF_TRACE)
  4460. PROGLOG("read file, handle = %d, pos = %" I64F "d, toread = %d, read = %d",handle,pos,len,numRead);
  4461. {
  4462. reply.setLength(posOfLength + sizeof(numRead) + numRead);
  4463. reply.writeEndianDirect(posOfLength,sizeof(numRead),&numRead);
  4464. }
  4465. return true;
  4466. }
  4467. bool cmdReadFilteredIndex(MemoryBuffer & msg, MemoryBuffer & reply, CClientStats &stats)
  4468. {
  4469. Owned<IKeyManager> keyManager = prepKey(msg, true);
  4470. bool first;
  4471. unsigned maxRecs;
  4472. msg.read(first).read(maxRecs);
  4473. if (!first)
  4474. keyManager->deserializeCursorPos(msg);
  4475. reply.append((unsigned)RFEnoerror);
  4476. DelayedMarker<unsigned> numReturned(reply);
  4477. bool maxHit;
  4478. unsigned numRecs = readKeyData(keyManager, maxRecs, reply, maxHit);
  4479. numReturned.write(numRecs);
  4480. DelayedSizeMarker keyCursorSzMarker(reply);
  4481. if (maxHit) // if maximum hit, either supplied maxRecs limit, or buffer limit, return cursor
  4482. keyManager->serializeCursorPos(reply);
  4483. keyCursorSzMarker.write();
  4484. return true;
  4485. }
  4486. bool cmdReadFilteredIndexCount(MemoryBuffer & msg, MemoryBuffer & reply, CClientStats &stats)
  4487. {
  4488. Owned<IKeyManager> keyManager = prepKey(msg, true);
  4489. unsigned __int64 limit;
  4490. msg.read(limit);
  4491. unsigned __int64 count;
  4492. if (((unsigned __int64)-1) != limit)
  4493. count = keyManager->checkCount(limit);
  4494. else
  4495. count = keyManager->getCount();
  4496. reply.append((unsigned)RFEnoerror);
  4497. reply.append(count);
  4498. return true;
  4499. }
  4500. bool cmdReadFilteredIndexBlob(MemoryBuffer & msg, MemoryBuffer & reply, CClientStats &stats)
  4501. {
  4502. Owned<IKeyManager> keyManager = prepKey(msg, false);
  4503. unsigned __int64 blobId;
  4504. msg.read(blobId);
  4505. size32_t blobSize;
  4506. const byte *blobData = keyManager->loadBlob(blobId, blobSize);
  4507. reply.append((unsigned)RFEnoerror);
  4508. reply.append(blobSize);
  4509. reply.append(blobSize, blobData);
  4510. keyManager->releaseBlobs();
  4511. return true;
  4512. }
  4513. bool cmdSize(MemoryBuffer & msg, MemoryBuffer & reply)
  4514. {
  4515. int handle;
  4516. msg.read(handle);
  4517. IFileIO *fileio;
  4518. if (!checkFileIOHandle(reply, handle, fileio))
  4519. return false;
  4520. __int64 size = fileio->size();
  4521. reply.append((unsigned)RFEnoerror).append(size);
  4522. if (TF_TRACE)
  4523. PROGLOG("size file, handle = %d, size = %" I64F "d",handle,size);
  4524. return true;
  4525. }
  4526. bool cmdSetSize(MemoryBuffer & msg, MemoryBuffer & reply)
  4527. {
  4528. int handle;
  4529. offset_t size;
  4530. msg.read(handle).read(size);
  4531. IFileIO *fileio;
  4532. if (TF_TRACE)
  4533. PROGLOG("set size file, handle = %d, size = %" I64F "d",handle,size);
  4534. if (!checkFileIOHandle(reply, handle, fileio))
  4535. return false;
  4536. fileio->setSize(size);
  4537. reply.append((unsigned)RFEnoerror);
  4538. return true;
  4539. }
  4540. bool cmdWrite(MemoryBuffer & msg, MemoryBuffer & reply, CClientStats &stats)
  4541. {
  4542. int handle;
  4543. __int64 pos;
  4544. size32_t len;
  4545. msg.read(handle).read(pos).read(len);
  4546. IFileIO *fileio;
  4547. if (!checkFileIOHandle(reply, handle, fileio))
  4548. return false;
  4549. const byte *data = (const byte *)msg.readDirect(len);
  4550. if (TF_TRACE_PRE_IO)
  4551. PROGLOG("before write file, handle = %d, towrite = %d",handle,len);
  4552. size32_t numWritten = fileio->write(pos,len,data);
  4553. stats.addWrite(numWritten);
  4554. if (TF_TRACE)
  4555. PROGLOG("write file, handle = %d, towrite = %d, written = %d",handle,len,numWritten);
  4556. reply.append((unsigned)RFEnoerror).append(numWritten);
  4557. return true;
  4558. }
  4559. bool cmdExists(MemoryBuffer & msg, MemoryBuffer & reply, CRemoteClientHandler &client)
  4560. {
  4561. IMPERSONATE_USER(client);
  4562. StringAttr name;
  4563. msg.read(name);
  4564. if (TF_TRACE)
  4565. PROGLOG("exists, '%s'",name.get());
  4566. Owned<IFile> file=createIFile(name);
  4567. bool e = file->exists();
  4568. reply.append((unsigned)RFEnoerror).append(e);
  4569. return true;
  4570. }
  4571. bool cmdRemove(MemoryBuffer & msg, MemoryBuffer & reply,CRemoteClientHandler &client)
  4572. {
  4573. IMPERSONATE_USER(client);
  4574. StringAttr name;
  4575. msg.read(name);
  4576. if (TF_TRACE)
  4577. PROGLOG("remove, '%s'",name.get());
  4578. Owned<IFile> file=createIFile(name);
  4579. bool e = file->remove();
  4580. reply.append((unsigned)RFEnoerror).append(e);
  4581. return true;
  4582. }
  4583. bool cmdGetVer(MemoryBuffer & msg, MemoryBuffer & reply)
  4584. {
  4585. if (TF_TRACE)
  4586. PROGLOG("getVer");
  4587. if (msg.getPos()+sizeof(unsigned)>msg.length())
  4588. reply.append((unsigned)RFEnoerror);
  4589. else
  4590. reply.append((unsigned)FILESRV_VERSION+0x10000);
  4591. reply.append(VERSTRING);
  4592. return true;
  4593. }
  4594. bool cmdRename(MemoryBuffer & msg, MemoryBuffer & reply,CRemoteClientHandler &client)
  4595. {
  4596. IMPERSONATE_USER(client);
  4597. StringAttr fromname;
  4598. msg.read(fromname);
  4599. StringAttr toname;
  4600. msg.read(toname);
  4601. if (TF_TRACE)
  4602. PROGLOG("rename, '%s' to '%s'",fromname.get(),toname.get());
  4603. Owned<IFile> file=createIFile(fromname);
  4604. file->rename(toname);
  4605. reply.append((unsigned)RFEnoerror);
  4606. return true;
  4607. }
  4608. bool cmdMove(MemoryBuffer & msg, MemoryBuffer & reply,CRemoteClientHandler &client)
  4609. {
  4610. IMPERSONATE_USER(client);
  4611. StringAttr fromname;
  4612. msg.read(fromname);
  4613. StringAttr toname;
  4614. msg.read(toname);
  4615. if (TF_TRACE)
  4616. PROGLOG("move, '%s' to '%s'",fromname.get(),toname.get());
  4617. Owned<IFile> file=createIFile(fromname);
  4618. file->move(toname);
  4619. reply.append((unsigned)RFEnoerror);
  4620. return true;
  4621. }
  4622. bool cmdCopy(MemoryBuffer & msg, MemoryBuffer & reply, CRemoteClientHandler &client)
  4623. {
  4624. IMPERSONATE_USER(client);
  4625. StringAttr fromname;
  4626. msg.read(fromname);
  4627. StringAttr toname;
  4628. msg.read(toname);
  4629. if (TF_TRACE)
  4630. PROGLOG("copy, '%s' to '%s'",fromname.get(),toname.get());
  4631. copyFile(toname, fromname);
  4632. reply.append((unsigned)RFEnoerror);
  4633. return true;
  4634. }
  4635. bool cmdAppend(MemoryBuffer & msg, MemoryBuffer & reply, CRemoteClientHandler &client, CClientStats &stats)
  4636. {
  4637. IMPERSONATE_USER(client);
  4638. int handle;
  4639. __int64 pos;
  4640. __int64 len;
  4641. StringAttr srcname;
  4642. msg.read(handle).read(srcname).read(pos).read(len);
  4643. IFileIO *fileio;
  4644. if (!checkFileIOHandle(reply, handle, fileio))
  4645. return false;
  4646. Owned<IFile> file = createIFile(srcname.get());
  4647. __int64 written = fileio->appendFile(file,pos,len);
  4648. stats.addWrite(written);
  4649. if (TF_TRACE)
  4650. PROGLOG("append file, handle = %d, file=%s, pos = %" I64F "d len = %" I64F "d written = %" I64F "d",handle,srcname.get(),pos,len,written);
  4651. reply.append((unsigned)RFEnoerror).append(written);
  4652. return true;
  4653. }
  4654. bool cmdIsFile(MemoryBuffer &msg, MemoryBuffer &reply, CRemoteClientHandler &client)
  4655. {
  4656. IMPERSONATE_USER(client);
  4657. StringAttr name;
  4658. msg.read(name);
  4659. if (TF_TRACE)
  4660. PROGLOG("isFile, '%s'",name.get());
  4661. Owned<IFile> file=createIFile(name);
  4662. unsigned ret = (unsigned)file->isFile();
  4663. reply.append((unsigned)RFEnoerror).append(ret);
  4664. return true;
  4665. }
  4666. bool cmdIsDir(MemoryBuffer &msg, MemoryBuffer &reply, CRemoteClientHandler &client)
  4667. {
  4668. IMPERSONATE_USER(client);
  4669. StringAttr name;
  4670. msg.read(name);
  4671. if (TF_TRACE)
  4672. PROGLOG("isDir, '%s'",name.get());
  4673. Owned<IFile> file=createIFile(name);
  4674. unsigned ret = (unsigned)file->isDirectory();
  4675. reply.append((unsigned)RFEnoerror).append(ret);
  4676. return true;
  4677. }
  4678. bool cmdIsReadOnly(MemoryBuffer &msg, MemoryBuffer &reply, CRemoteClientHandler &client)
  4679. {
  4680. IMPERSONATE_USER(client);
  4681. StringAttr name;
  4682. msg.read(name);
  4683. if (TF_TRACE)
  4684. PROGLOG("isReadOnly, '%s'",name.get());
  4685. Owned<IFile> file=createIFile(name);
  4686. unsigned ret = (unsigned)file->isReadOnly();
  4687. reply.append((unsigned)RFEnoerror).append(ret);
  4688. return true;
  4689. }
  4690. bool cmdSetReadOnly(MemoryBuffer &msg, MemoryBuffer &reply, CRemoteClientHandler &client)
  4691. {
  4692. IMPERSONATE_USER(client);
  4693. StringAttr name;
  4694. bool set;
  4695. msg.read(name).read(set);
  4696. if (TF_TRACE)
  4697. PROGLOG("setReadOnly, '%s' %d",name.get(),(int)set);
  4698. Owned<IFile> file=createIFile(name);
  4699. file->setReadOnly(set);
  4700. reply.append((unsigned)RFEnoerror);
  4701. return true;
  4702. }
  4703. bool cmdSetFilePerms(MemoryBuffer &msg, MemoryBuffer &reply, CRemoteClientHandler &client)
  4704. {
  4705. IMPERSONATE_USER(client);
  4706. StringAttr name;
  4707. unsigned fPerms;
  4708. msg.read(name).read(fPerms);
  4709. if (TF_TRACE)
  4710. PROGLOG("setFilePerms, '%s' 0%o",name.get(),fPerms);
  4711. Owned<IFile> file=createIFile(name);
  4712. file->setFilePermissions(fPerms);
  4713. reply.append((unsigned)RFEnoerror);
  4714. return true;
  4715. }
  4716. bool cmdGetTime(MemoryBuffer &msg, MemoryBuffer &reply, CRemoteClientHandler &client)
  4717. {
  4718. IMPERSONATE_USER(client);
  4719. StringAttr name;
  4720. msg.read(name);
  4721. if (TF_TRACE)
  4722. PROGLOG("getTime, '%s'",name.get());
  4723. Owned<IFile> file=createIFile(name);
  4724. CDateTime createTime;
  4725. CDateTime modifiedTime;
  4726. CDateTime accessedTime;
  4727. bool ret = file->getTime(&createTime,&modifiedTime,&accessedTime);
  4728. reply.append((unsigned)RFEnoerror).append(ret);
  4729. if (ret) {
  4730. createTime.serialize(reply);
  4731. modifiedTime.serialize(reply);
  4732. accessedTime.serialize(reply);
  4733. }
  4734. return true;
  4735. }
  4736. bool cmdSetTime(MemoryBuffer &msg, MemoryBuffer &reply, CRemoteClientHandler &client)
  4737. {
  4738. IMPERSONATE_USER(client);
  4739. StringAttr name;
  4740. bool creategot;
  4741. CDateTime createTime;
  4742. bool modifiedgot;
  4743. CDateTime modifiedTime;
  4744. bool accessedgot;
  4745. CDateTime accessedTime;
  4746. msg.read(name);
  4747. msg.read(creategot);
  4748. if (creategot)
  4749. createTime.deserialize(msg);
  4750. msg.read(modifiedgot);
  4751. if (modifiedgot)
  4752. modifiedTime.deserialize(msg);
  4753. msg.read(accessedgot);
  4754. if (accessedgot)
  4755. accessedTime.deserialize(msg);
  4756. if (TF_TRACE)
  4757. PROGLOG("setTime, '%s'",name.get());
  4758. Owned<IFile> file=createIFile(name);
  4759. bool ret = file->setTime(creategot?&createTime:NULL,modifiedgot?&modifiedTime:NULL,accessedgot?&accessedTime:NULL);
  4760. reply.append((unsigned)RFEnoerror).append(ret);
  4761. return true;
  4762. }
  4763. bool cmdCreateDir(MemoryBuffer &msg, MemoryBuffer &reply, CRemoteClientHandler &client)
  4764. {
  4765. IMPERSONATE_USER(client);
  4766. StringAttr name;
  4767. msg.read(name);
  4768. if (TF_TRACE)
  4769. PROGLOG("CreateDir, '%s'",name.get());
  4770. Owned<IFile> dir=createIFile(name);
  4771. bool ret = dir->createDirectory();
  4772. reply.append((unsigned)RFEnoerror).append(ret);
  4773. return true;
  4774. }
  4775. bool cmdGetDir(MemoryBuffer &msg, MemoryBuffer &reply, CRemoteClientHandler &client)
  4776. {
  4777. IMPERSONATE_USER(client);
  4778. StringAttr name;
  4779. StringAttr mask;
  4780. bool includedir;
  4781. bool sub;
  4782. byte stream = 0;
  4783. msg.read(name).read(mask).read(includedir).read(sub);
  4784. if (msg.remaining()>=sizeof(byte)) {
  4785. msg.read(stream);
  4786. if (stream==1)
  4787. client.opendir.clear();
  4788. }
  4789. if (TF_TRACE)
  4790. PROGLOG("GetDir, '%s', '%s'",name.get(),mask.get());
  4791. Owned<IFile> dir=createIFile(name);
  4792. Owned<IDirectoryIterator> iter;
  4793. if (stream>1)
  4794. iter.set(client.opendir);
  4795. else {
  4796. iter.setown(dir->directoryFiles(mask.length()?mask.get():NULL,sub,includedir));
  4797. if (stream != 0)
  4798. client.opendir.set(iter);
  4799. }
  4800. if (!iter) {
  4801. reply.append((unsigned)RFSERR_GetDirFailed);
  4802. return false;
  4803. }
  4804. reply.append((unsigned)RFEnoerror);
  4805. if (CRemoteDirectoryIterator::serialize(reply,iter,stream?0x100000:0,stream<2)) {
  4806. if (stream != 0)
  4807. client.opendir.clear();
  4808. }
  4809. else {
  4810. bool cont=true;
  4811. reply.append(cont);
  4812. }
  4813. return true;
  4814. }
  4815. bool cmdMonitorDir(MemoryBuffer &msg, MemoryBuffer &reply, CRemoteClientHandler &client)
  4816. {
  4817. IMPERSONATE_USER(client);
  4818. StringAttr name;
  4819. StringAttr mask;
  4820. bool includedir;
  4821. bool sub;
  4822. unsigned checkinterval;
  4823. unsigned timeout;
  4824. __int64 cancelid; // not yet used
  4825. msg.read(name).read(mask).read(includedir).read(sub).read(checkinterval).read(timeout).read(cancelid);
  4826. byte isprev;
  4827. msg.read(isprev);
  4828. Owned<IDirectoryIterator> prev;
  4829. if (isprev==1) {
  4830. SocketEndpoint ep;
  4831. CRemoteDirectoryIterator *di = new CRemoteDirectoryIterator(ep,name);
  4832. di->appendBuf(msg);
  4833. prev.setown(di);
  4834. }
  4835. if (TF_TRACE)
  4836. PROGLOG("MonitorDir, '%s' '%s'",name.get(),mask.get());
  4837. Owned<IFile> dir=createIFile(name);
  4838. Owned<IDirectoryDifferenceIterator> iter=dir->monitorDirectory(prev,mask.length()?mask.get():NULL,sub,includedir,checkinterval,timeout);
  4839. reply.append((unsigned)RFEnoerror);
  4840. byte state = (iter.get()==NULL)?0:1;
  4841. reply.append(state);
  4842. if (state==1)
  4843. CRemoteDirectoryIterator::serializeDiff(reply,iter);
  4844. return true;
  4845. }
  4846. bool cmdCopySection(MemoryBuffer &msg, MemoryBuffer &reply, CRemoteClientHandler &client)
  4847. {
  4848. IMPERSONATE_USER(client);
  4849. StringAttr uuid;
  4850. StringAttr fromFile;
  4851. StringAttr toFile;
  4852. offset_t toOfs;
  4853. offset_t fromOfs;
  4854. offset_t size;
  4855. offset_t sizeDone=0;
  4856. offset_t totalSize=(offset_t)-1;
  4857. unsigned timeout;
  4858. msg.read(uuid).read(fromFile).read(toFile).read(toOfs).read(fromOfs).read(size).read(timeout);
  4859. AsyncCommandStatus status = asyncCommandManager.copySection(uuid,fromFile,toFile,toOfs,fromOfs,size,sizeDone,totalSize,timeout);
  4860. reply.append((unsigned)RFEnoerror).append((unsigned)status).append(sizeDone).append(totalSize);
  4861. return true;
  4862. }
  4863. static void treeCopyFile(RemoteFilename &srcfn, RemoteFilename &dstfn, const char *net, const char *mask, IpAddress &ip, bool usetmp, CThrottler *throttler, CFflags copyFlags=CFnone)
  4864. {
  4865. unsigned start = msTick();
  4866. Owned<IFile> dstfile = createIFile(dstfn);
  4867. // the following is really to check the dest node is up and working (otherwise not much point in continuing!)
  4868. if (dstfile->exists())
  4869. PROGLOG("TREECOPY overwriting '%s'",dstfile->queryFilename());
  4870. Owned<IFile> srcfile = createIFile(srcfn);
  4871. unsigned lastmin = 0;
  4872. if (!srcfn.queryIP().ipequals(dstfn.queryIP())) {
  4873. CriticalBlock block(treeCopyCrit);
  4874. for (;;) {
  4875. CDateTime dt;
  4876. offset_t sz;
  4877. try {
  4878. sz = srcfile->size();
  4879. if (sz==(offset_t)-1) {
  4880. if (TF_TRACE_TREE_COPY)
  4881. PROGLOG("TREECOPY source not found '%s'",srcfile->queryFilename());
  4882. break;
  4883. }
  4884. srcfile->getTime(NULL,&dt,NULL);
  4885. }
  4886. catch (IException *e) {
  4887. EXCLOG(e,"treeCopyFile(1)");
  4888. e->Release();
  4889. break;
  4890. }
  4891. Linked<CTreeCopyItem> tc;
  4892. unsigned now = msTick();
  4893. ForEachItemInRev(i1,treeCopyArray) {
  4894. CTreeCopyItem &item = treeCopyArray.item(i1);
  4895. // prune old entries (not strictly needed buf I think better)
  4896. if (now-item.lastused>TREECOPYPRUNETIME)
  4897. treeCopyArray.remove(i1);
  4898. else if (!tc.get()&&item.equals(srcfn,net,mask,sz,dt)) {
  4899. tc.set(&item);
  4900. item.lastused = now;
  4901. }
  4902. }
  4903. if (!tc.get()) {
  4904. if (treeCopyArray.ordinality()>=TREECOPY_CACHE_SIZE)
  4905. treeCopyArray.remove(0);
  4906. tc.setown(new CTreeCopyItem(srcfn,net,mask,sz,dt));
  4907. treeCopyArray.append(*tc.getLink());
  4908. }
  4909. ForEachItemInRev(cand,tc->loc) { // rev to choose copied locations first (maybe optional?)
  4910. if (!tc->busy->testSet(cand)) {
  4911. // check file accessible and matches
  4912. if (!cand&&dstfn.equals(tc->loc.item(cand))) // hmm trying to overwrite existing, better humor
  4913. continue;
  4914. bool ok = true;
  4915. Owned<IFile> rmtfile = createIFile(tc->loc.item(cand));
  4916. if (cand) { // only need to check if remote
  4917. try {
  4918. if (rmtfile->size()!=sz)
  4919. ok = false;
  4920. else {
  4921. CDateTime fdt;
  4922. rmtfile->getTime(NULL,&fdt,NULL);
  4923. ok = fdt.equals(dt);
  4924. }
  4925. }
  4926. catch (IException *e) {
  4927. EXCLOG(e,"treeCopyFile(2)");
  4928. e->Release();
  4929. ok = false;
  4930. }
  4931. }
  4932. if (ok) { // if not ok leave 'busy'
  4933. // finally lets try and copy!
  4934. try {
  4935. if (TF_TRACE_TREE_COPY)
  4936. PROGLOG("TREECOPY(started) %s to %s",rmtfile->queryFilename(),dstfile->queryFilename());
  4937. {
  4938. CriticalUnblock unblock(treeCopyCrit); // note we have tc linked
  4939. rmtfile->copyTo(dstfile,DEFAULT_COPY_BLKSIZE,NULL,usetmp,copyFlags);
  4940. }
  4941. if (TF_TRACE_TREE_COPY)
  4942. PROGLOG("TREECOPY(done) %s to %s",rmtfile->queryFilename(),dstfile->queryFilename());
  4943. tc->busy->set(cand,false);
  4944. if (treeCopyWaiting)
  4945. treeCopySem.signal((treeCopyWaiting>1)?2:1);
  4946. // add to known locations
  4947. tc->busy->set(tc->loc.ordinality(),false); // prob already is clear
  4948. tc->loc.append(dstfn);
  4949. ip.ipset(tc->loc.item(cand).queryIP());
  4950. return;
  4951. }
  4952. catch (IException *e) {
  4953. if (cand==0) {
  4954. tc->busy->set(0,false); // don't leave busy
  4955. if (treeCopyWaiting)
  4956. treeCopySem.signal();
  4957. throw; // what more can we do!
  4958. }
  4959. EXCLOG(e,"treeCopyFile(3)");
  4960. e->Release();
  4961. }
  4962. }
  4963. }
  4964. }
  4965. // all locations busy
  4966. if (msTick()-start>TREECOPYTIMEOUT) {
  4967. WARNLOG("Treecopy %s wait timed out", srcfile->queryFilename());
  4968. break;
  4969. }
  4970. treeCopyWaiting++; // note this isn't precise - just indication
  4971. {
  4972. CriticalUnblock unblock(treeCopyCrit);
  4973. if (throttler)
  4974. {
  4975. CThrottleReleaseBlock block(*throttler, RFCtreecopy);
  4976. treeCopySem.wait(TREECOPYPOLLTIME);
  4977. }
  4978. else
  4979. treeCopySem.wait(TREECOPYPOLLTIME);
  4980. }
  4981. treeCopyWaiting--;
  4982. if ((msTick()-start)/10*1000!=lastmin) {
  4983. lastmin = (msTick()-start)/10*1000;
  4984. PROGLOG("treeCopyFile delayed: %s to %s",srcfile->queryFilename(),dstfile->queryFilename());
  4985. }
  4986. }
  4987. }
  4988. else if (TF_TRACE_TREE_COPY)
  4989. PROGLOG("TREECOPY source on same node as destination");
  4990. if (TF_TRACE_TREE_COPY)
  4991. PROGLOG("TREECOPY(started,fallback) %s to %s",srcfile->queryFilename(),dstfile->queryFilename());
  4992. try {
  4993. GetHostIp(ip);
  4994. srcfile->copyTo(dstfile,DEFAULT_COPY_BLKSIZE,NULL,usetmp,copyFlags);
  4995. }
  4996. catch (IException *e) {
  4997. EXCLOG(e,"TREECOPY(done,fallback)");
  4998. throw;
  4999. }
  5000. if (TF_TRACE_TREE_COPY)
  5001. PROGLOG("TREECOPY(done,fallback) %s to %s",srcfile->queryFilename(),dstfile->queryFilename());
  5002. }
  5003. bool cmdTreeCopy(MemoryBuffer &msg, MemoryBuffer &reply, CRemoteClientHandler &client, CThrottler *throttler, bool usetmp=false)
  5004. {
  5005. IMPERSONATE_USER(client);
  5006. RemoteFilename src;
  5007. src.deserialize(msg);
  5008. RemoteFilename dst;
  5009. dst.deserialize(msg);
  5010. StringAttr net;
  5011. StringAttr mask;
  5012. msg.read(net).read(mask);
  5013. IpAddress ip;
  5014. treeCopyFile(src,dst,net,mask,ip,usetmp,throttler);
  5015. unsigned status = 0;
  5016. reply.append((unsigned)RFEnoerror).append((unsigned)status);
  5017. ip.ipserialize(reply);
  5018. return true;
  5019. }
  5020. bool cmdTreeCopyTmp(MemoryBuffer &msg, MemoryBuffer &reply, CRemoteClientHandler &client, CThrottler *throttler)
  5021. {
  5022. return cmdTreeCopy(msg, reply, client, throttler, true);
  5023. }
  5024. bool cmdGetCRC(MemoryBuffer &msg, MemoryBuffer &reply, CRemoteClientHandler &client)
  5025. {
  5026. IMPERSONATE_USER(client);
  5027. StringAttr name;
  5028. msg.read(name);
  5029. if (TF_TRACE)
  5030. PROGLOG("getCRC, '%s'",name.get());
  5031. Owned<IFile> file=createIFile(name);
  5032. unsigned ret = file->getCRC();
  5033. reply.append((unsigned)RFEnoerror).append(ret);
  5034. return true;
  5035. }
  5036. bool cmdStop(MemoryBuffer &msg, MemoryBuffer &reply)
  5037. {
  5038. PROGLOG("Abort request received");
  5039. stopping = true;
  5040. if (acceptsock)
  5041. acceptsock->cancel_accept();
  5042. if (securesock)
  5043. securesock->cancel_accept();
  5044. reply.append((unsigned)RFEnoerror);
  5045. return false;
  5046. }
  5047. bool cmdExec(MemoryBuffer &msg, MemoryBuffer &reply, CRemoteClientHandler &client)
  5048. {
  5049. StringAttr cmdLine;
  5050. msg.read(cmdLine);
  5051. // NB: legacy remoteExec used to simply pass error code and buffer back to caller.
  5052. VStringBuffer errMsg("Remote command execution no longer supported. Trying to execute cmdline=%s", cmdLine.get());
  5053. WARNLOG("%s", errMsg.str());
  5054. size32_t outSz = errMsg.length()+1; // reply with null terminated string
  5055. // reply with error code -1
  5056. reply.append((unsigned)-1).append((unsigned)0).append(outSz).append(outSz, errMsg.str());
  5057. return true;
  5058. }
  5059. bool cmdSetTrace(MemoryBuffer &msg, MemoryBuffer &reply)
  5060. {
  5061. byte flags;
  5062. msg.read(flags);
  5063. int retcode=-1;
  5064. if (flags!=255) { // escape
  5065. retcode = traceFlags;
  5066. traceFlags = flags;
  5067. }
  5068. reply.append(retcode);
  5069. return true;
  5070. }
  5071. bool cmdGetInfo(MemoryBuffer &msg, MemoryBuffer &reply)
  5072. {
  5073. unsigned level=1;
  5074. if (msg.remaining() >= sizeof(unsigned))
  5075. msg.read(level);
  5076. StringBuffer retstr;
  5077. getInfo(retstr, level);
  5078. reply.append(0).append(retstr.str());
  5079. return true;
  5080. }
  5081. bool cmdFirewall(MemoryBuffer &msg, MemoryBuffer &reply)
  5082. {
  5083. // TBD
  5084. StringBuffer retstr;
  5085. getInfo(retstr);
  5086. reply.append(0).append(retstr.str());
  5087. return true;
  5088. }
  5089. bool cmdExtractBlobElements(MemoryBuffer &msg, MemoryBuffer &reply, CRemoteClientHandler &client)
  5090. {
  5091. IMPERSONATE_USER(client);
  5092. StringAttr prefix;
  5093. StringAttr filename;
  5094. msg.read(prefix).read(filename);
  5095. RemoteFilename rfn;
  5096. rfn.setLocalPath(filename);
  5097. ExtractedBlobArray extracted;
  5098. extractBlobElements(prefix, rfn, extracted);
  5099. unsigned n = extracted.ordinality();
  5100. reply.append((unsigned)RFEnoerror).append(n);
  5101. for (unsigned i=0;i<n;i++)
  5102. extracted.item(i).serialize(reply);
  5103. return true;
  5104. }
  5105. bool cmdRedeploy(MemoryBuffer &msg, MemoryBuffer &reply)
  5106. {
  5107. return false; // TBD
  5108. }
  5109. bool cmdUnknown(MemoryBuffer & msg, MemoryBuffer & reply,RemoteFileCommandType cmd)
  5110. {
  5111. appendErr2(reply, RFSERR_InvalidCommand, cmd);
  5112. return false;
  5113. }
  5114. bool cmdUnlock(MemoryBuffer & msg, MemoryBuffer & reply,CRemoteClientHandler &client)
  5115. {
  5116. // this is an attempt to authenticate when we haven't got authentication turned on
  5117. if (TF_TRACE_CLIENT_STATS)
  5118. {
  5119. StringBuffer s(client.queryPeerName());
  5120. PROGLOG("Connect from %s",s.str());
  5121. }
  5122. appendErr2(reply, RFSERR_InvalidCommand, RFCunlock);
  5123. return false;
  5124. }
  5125. // legacy version
  5126. bool cmdSetThrottle(MemoryBuffer & msg, MemoryBuffer & reply)
  5127. {
  5128. unsigned limit, delayMs, cpuThreshold;
  5129. msg.read(limit);
  5130. msg.read(delayMs);
  5131. msg.read(cpuThreshold);
  5132. stdCmdThrottler.configure(limit, delayMs, cpuThreshold, (unsigned)-1);
  5133. reply.append((unsigned)RFEnoerror);
  5134. return true;
  5135. }
  5136. bool cmdSetThrottle2(MemoryBuffer & msg, MemoryBuffer & reply)
  5137. {
  5138. unsigned throttleClass, limit, delayMs, cpuThreshold, queueLimit;
  5139. msg.read(throttleClass);
  5140. msg.read(limit);
  5141. msg.read(delayMs);
  5142. msg.read(cpuThreshold);
  5143. msg.read(queueLimit);
  5144. setThrottle((ThrottleClass)throttleClass, limit, delayMs, cpuThreshold, queueLimit);
  5145. reply.append((unsigned)RFEnoerror);
  5146. return true;
  5147. }
  5148. void appendError(RemoteFileCommandType cmd, CRemoteClientHandler *client, unsigned ret, MemoryBuffer &reply)
  5149. {
  5150. if (reply.length()>=sizeof(unsigned)*2)
  5151. {
  5152. reply.reset();
  5153. unsigned z;
  5154. unsigned e;
  5155. reply.read(z).read(e);
  5156. StringBuffer err("ERR(");
  5157. err.append(e).append(") ");
  5158. if (client)
  5159. {
  5160. const char *peer = client->queryPeerName();
  5161. if (peer)
  5162. err.append(peer);
  5163. }
  5164. if (e&&(reply.getPos()<reply.length()))
  5165. {
  5166. StringAttr es;
  5167. reply.read(es);
  5168. err.append(" : ").append(es);
  5169. }
  5170. reply.reset();
  5171. if (cmd!=RFCunlock)
  5172. PROGLOG("%s",err.str()); // supress authentication logging
  5173. if (client)
  5174. client->logPrevHandle();
  5175. }
  5176. }
  5177. void throttleCommand(RemoteFileCommandType cmd, MemoryBuffer &msg, CRemoteClientHandler *client)
  5178. {
  5179. switch(cmd)
  5180. {
  5181. case RFCexec:
  5182. case RFCgetcrc:
  5183. case RFCcopy:
  5184. case RFCappend:
  5185. case RFCtreecopy:
  5186. case RFCtreecopytmp:
  5187. slowCmdThrottler.addCommand(cmd, msg, client);
  5188. return;
  5189. case RFCcloseIO:
  5190. case RFCopenIO:
  5191. case RFCread:
  5192. case RFCsize:
  5193. case RFCwrite:
  5194. case RFCexists:
  5195. case RFCremove:
  5196. case RFCrename:
  5197. case RFCgetver:
  5198. case RFCisfile:
  5199. case RFCisdirectory:
  5200. case RFCisreadonly:
  5201. case RFCsetreadonly:
  5202. case RFCsetfileperms:
  5203. case RFCreadfilteredindex:
  5204. case RFCreadfilteredindexcount:
  5205. case RFCreadfilteredindexblob:
  5206. case RFCgettime:
  5207. case RFCsettime:
  5208. case RFCcreatedir:
  5209. case RFCgetdir:
  5210. case RFCmonitordir:
  5211. case RFCstop:
  5212. case RFCextractblobelements:
  5213. case RFCredeploy:
  5214. case RFCmove:
  5215. case RFCsetsize:
  5216. case RFCsettrace:
  5217. case RFCgetinfo:
  5218. case RFCfirewall:
  5219. case RFCunlock:
  5220. stdCmdThrottler.addCommand(cmd, msg, client);
  5221. return;
  5222. // NB: The following commands are still bound by the the thread pool
  5223. case RFCsetthrottle: // legacy version
  5224. case RFCsetthrottle2:
  5225. case RFCcopysection: // slightly odd, but has it's own limit
  5226. default:
  5227. {
  5228. client->processCommand(cmd, msg, NULL);
  5229. break;
  5230. }
  5231. }
  5232. }
  5233. bool processCommand(RemoteFileCommandType cmd, MemoryBuffer & msg, MemoryBuffer & reply, CRemoteClientHandler *client, CThrottler *throttler)
  5234. {
  5235. Owned<CClientStats> stats = clientStatsTable.getClientReference(cmd, client->queryPeerName());
  5236. bool ret = true;
  5237. try
  5238. {
  5239. switch(cmd)
  5240. {
  5241. MAPCOMMANDSTATS(RFCread, cmdRead, *stats);
  5242. MAPCOMMANDSTATS(RFCwrite, cmdWrite, *stats);
  5243. MAPCOMMANDSTATS(RFCreadfilteredindex, cmdReadFilteredIndex, *stats);
  5244. MAPCOMMANDSTATS(RFCreadfilteredindexcount, cmdReadFilteredIndexCount, *stats);
  5245. MAPCOMMANDSTATS(RFCreadfilteredindexblob, cmdReadFilteredIndexBlob, *stats);
  5246. MAPCOMMANDCLIENTSTATS(RFCappend, cmdAppend, *client, *stats);
  5247. MAPCOMMAND(RFCcloseIO, cmdCloseFileIO);
  5248. MAPCOMMANDCLIENT(RFCopenIO, cmdOpenFileIO, *client);
  5249. MAPCOMMAND(RFCsize, cmdSize);
  5250. MAPCOMMANDCLIENT(RFCexists, cmdExists, *client);
  5251. MAPCOMMANDCLIENT(RFCremove, cmdRemove, *client);
  5252. MAPCOMMANDCLIENT(RFCrename, cmdRename, *client);
  5253. MAPCOMMAND(RFCgetver, cmdGetVer);
  5254. MAPCOMMANDCLIENT(RFCisfile, cmdIsFile, *client);
  5255. MAPCOMMANDCLIENT(RFCisdirectory, cmdIsDir, *client);
  5256. MAPCOMMANDCLIENT(RFCisreadonly, cmdIsReadOnly, *client);
  5257. MAPCOMMANDCLIENT(RFCsetreadonly, cmdSetReadOnly, *client);
  5258. MAPCOMMANDCLIENT(RFCsetfileperms, cmdSetFilePerms, *client);
  5259. MAPCOMMANDCLIENT(RFCgettime, cmdGetTime, *client);
  5260. MAPCOMMANDCLIENT(RFCsettime, cmdSetTime, *client);
  5261. MAPCOMMANDCLIENT(RFCcreatedir, cmdCreateDir, *client);
  5262. MAPCOMMANDCLIENT(RFCgetdir, cmdGetDir, *client);
  5263. MAPCOMMANDCLIENT(RFCmonitordir, cmdMonitorDir, *client);
  5264. MAPCOMMAND(RFCstop, cmdStop);
  5265. MAPCOMMANDCLIENT(RFCexec, cmdExec, *client);
  5266. MAPCOMMANDCLIENT(RFCextractblobelements, cmdExtractBlobElements, *client);
  5267. MAPCOMMAND(RFCredeploy, cmdRedeploy); // only Windows
  5268. MAPCOMMANDCLIENT(RFCgetcrc, cmdGetCRC, *client);
  5269. MAPCOMMANDCLIENT(RFCmove, cmdMove, *client);
  5270. MAPCOMMANDCLIENT(RFCcopy, cmdCopy, *client);
  5271. MAPCOMMAND(RFCsetsize, cmdSetSize);
  5272. MAPCOMMAND(RFCsettrace, cmdSetTrace);
  5273. MAPCOMMAND(RFCgetinfo, cmdGetInfo);
  5274. MAPCOMMAND(RFCfirewall, cmdFirewall);
  5275. MAPCOMMANDCLIENT(RFCunlock, cmdUnlock, *client);
  5276. MAPCOMMANDCLIENT(RFCcopysection, cmdCopySection, *client);
  5277. MAPCOMMANDCLIENTTHROTTLE(RFCtreecopy, cmdTreeCopy, *client, &slowCmdThrottler);
  5278. MAPCOMMANDCLIENTTHROTTLE(RFCtreecopytmp, cmdTreeCopyTmp, *client, &slowCmdThrottler);
  5279. MAPCOMMAND(RFCsetthrottle, cmdSetThrottle); // legacy version
  5280. MAPCOMMAND(RFCsetthrottle2, cmdSetThrottle2);
  5281. default:
  5282. ret = cmdUnknown(msg,reply,cmd);
  5283. break;
  5284. }
  5285. }
  5286. catch (IException *e)
  5287. {
  5288. ret = false;
  5289. StringBuffer s;
  5290. e->errorMessage(s);
  5291. appendCmdErr(reply, cmd, e->errorCode(), s.str());
  5292. e->Release();
  5293. }
  5294. if (!ret) // append error string
  5295. appendError(cmd, client, cmd, reply);
  5296. return ret;
  5297. }
  5298. IPooledThread *createCommandProcessor()
  5299. {
  5300. return new cCommandProcessor();
  5301. }
  5302. void run(SSLCfg _useSSL, SocketEndpoint &listenep, unsigned sslPort)
  5303. {
  5304. SocketEndpoint sslep(listenep);
  5305. if (sslPort)
  5306. sslep.port = sslPort;
  5307. else
  5308. sslep.port = securitySettings.daFileSrvSSLPort;
  5309. Owned<ISocket> acceptSocket, acceptSSLSocket;
  5310. if (_useSSL != SSLOnly)
  5311. {
  5312. if (listenep.port == 0)
  5313. throw createDafsException(DAFSERR_connection_failed, "dafilesrv port not specified");
  5314. if (listenep.isNull())
  5315. acceptSocket.setown(ISocket::create(listenep.port));
  5316. else
  5317. {
  5318. StringBuffer ips;
  5319. listenep.getIpText(ips);
  5320. acceptSocket.setown(ISocket::create_ip(listenep.port,ips.str()));
  5321. }
  5322. }
  5323. if (_useSSL)
  5324. {
  5325. if (sslep.port == 0)
  5326. throw createDafsException(DAFSERR_connection_failed, "Secure dafilesrv port not specified");
  5327. if ( (_useSSL != UnsecureFirst) && (!securitySettings.certificate || !securitySettings.privateKey) )
  5328. throw createDafsException(DAFSERR_connection_failed, "SSL Certificate and/or Key file information not found in environment.conf");
  5329. if (sslep.isNull())
  5330. acceptSSLSocket.setown(ISocket::create(sslep.port));
  5331. else
  5332. {
  5333. StringBuffer ips;
  5334. sslep.getIpText(ips);
  5335. acceptSSLSocket.setown(ISocket::create_ip(sslep.port,ips.str()));
  5336. }
  5337. }
  5338. run(_useSSL, acceptSocket.getClear(), acceptSSLSocket.getClear());
  5339. }
  5340. void run(SSLCfg _useSSL, ISocket *regSocket, ISocket *secureSocket)
  5341. {
  5342. if (_useSSL != SSLOnly)
  5343. {
  5344. if (regSocket)
  5345. acceptsock.setown(regSocket);
  5346. else
  5347. throw createDafsException(DAFSERR_connection_failed, "Invalid non-secure socket");
  5348. }
  5349. if (_useSSL)
  5350. {
  5351. if (secureSocket)
  5352. securesock.setown(secureSocket);
  5353. else
  5354. throw createDafsException(DAFSERR_connection_failed, "Invalid secure socket");
  5355. }
  5356. selecthandler->start();
  5357. for (;;)
  5358. {
  5359. Owned<ISocket> sock;
  5360. Owned<ISocket> sockSSL;
  5361. bool sockavail = false;
  5362. bool securesockavail = false;
  5363. if (_useSSL == SSLNone)
  5364. sockavail = acceptsock->wait_read(1000*60*1)!=0;
  5365. else if (_useSSL == SSLOnly)
  5366. securesockavail = securesock->wait_read(1000*60*1)!=0;
  5367. else
  5368. {
  5369. UnsignedArray readSocks;
  5370. UnsignedArray waitingSocks;
  5371. readSocks.append(acceptsock->OShandle());
  5372. readSocks.append(securesock->OShandle());
  5373. int numReady = wait_read_multiple(readSocks, 1000*60*1, waitingSocks);
  5374. if (numReady > 0)
  5375. {
  5376. for (int idx = 0; idx < numReady; idx++)
  5377. {
  5378. if (waitingSocks.item(idx) == acceptsock->OShandle())
  5379. sockavail = true;
  5380. else if (waitingSocks.item(idx) == securesock->OShandle())
  5381. securesockavail = true;
  5382. }
  5383. }
  5384. }
  5385. #if 0
  5386. if (!sockavail && !securesockavail)
  5387. {
  5388. JSocketStatistics stats;
  5389. getSocketStatistics(stats);
  5390. StringBuffer s;
  5391. getSocketStatisticsString(stats,s);
  5392. PROGLOG( "Socket statistics : \n%s\n",s.str());
  5393. }
  5394. #endif
  5395. if (stopping)
  5396. break;
  5397. if (sockavail || securesockavail)
  5398. {
  5399. if (sockavail)
  5400. {
  5401. try
  5402. {
  5403. sock.setown(acceptsock->accept(true));
  5404. if (!sock||stopping)
  5405. break;
  5406. #ifdef _DEBUG
  5407. SocketEndpoint eps;
  5408. sock->getPeerEndpoint(eps);
  5409. StringBuffer sb;
  5410. eps.getUrlStr(sb);
  5411. PROGLOG("Server accepting from %s", sb.str());
  5412. #endif
  5413. }
  5414. catch (IException *e)
  5415. {
  5416. EXCLOG(e,"CRemoteFileServer");
  5417. e->Release();
  5418. break;
  5419. }
  5420. }
  5421. if (securesockavail)
  5422. {
  5423. try
  5424. {
  5425. sockSSL.setown(securesock->accept(true));
  5426. if (!sockSSL||stopping)
  5427. break;
  5428. if ( (_useSSL == UnsecureFirst) && (!securitySettings.certificate || !securitySettings.privateKey) )
  5429. {
  5430. // for client secure_connect() to fail quickly ...
  5431. sockSSL->shutdown();
  5432. sockSSL->close();
  5433. sockSSL.clear();
  5434. securesockavail = false;
  5435. }
  5436. else
  5437. {
  5438. #ifdef _USE_OPENSSL
  5439. Owned<ISecureSocket> ssock = createSecureSocket(sockSSL.getClear(), ServerSocket);
  5440. int status = ssock->secure_accept();
  5441. if (status < 0)
  5442. throw createDafsException(DAFSERR_connection_failed,"Failure to establish secure connection");
  5443. sockSSL.setown(ssock.getLink());
  5444. #else
  5445. throw createDafsException(DAFSERR_connection_failed,"Failure to establish secure connection: OpenSSL disabled in build");
  5446. #endif
  5447. #ifdef _DEBUG
  5448. SocketEndpoint eps;
  5449. sockSSL->getPeerEndpoint(eps);
  5450. StringBuffer sb;
  5451. eps.getUrlStr(sb);
  5452. PROGLOG("Server accepting SECURE from %s", sb.str());
  5453. #endif
  5454. }
  5455. }
  5456. catch (IException *e)
  5457. {
  5458. EXCLOG(e,"CRemoteFileServer (secure)");
  5459. e->Release();
  5460. break;
  5461. }
  5462. if (sockavail)
  5463. runClient(sock.getClear());
  5464. if (securesockavail)
  5465. runClient(sockSSL.getClear());
  5466. }
  5467. }
  5468. else
  5469. checkTimeout();
  5470. }
  5471. if (TF_TRACE_CLIENT_STATS)
  5472. PROGLOG("CRemoteFileServer:run exiting");
  5473. selecthandler->stop(true);
  5474. }
  5475. void processUnauthenticatedCommand(RemoteFileCommandType cmd, ISocket *socket, MemoryBuffer &msg)
  5476. {
  5477. // these are unauthenticated commands
  5478. if (cmd != RFCgetver)
  5479. cmd = RFCinvalid;
  5480. MemoryBuffer reply;
  5481. processCommand(cmd, msg, initSendBuffer(reply), NULL, NULL);
  5482. sendBuffer(socket, reply);
  5483. }
  5484. bool checkAuthentication(ISocket *socket, IAuthenticatedUser *&ret)
  5485. {
  5486. ret = NULL;
  5487. if (!AuthenticationEnabled)
  5488. return true;
  5489. MemoryBuffer reqbuf;
  5490. MemoryBuffer reply;
  5491. MemoryBuffer encbuf; // because aesEncrypt clears input
  5492. initSendBuffer(reply);
  5493. receiveBuffer(socket, reqbuf, 1);
  5494. RemoteFileCommandType typ=0;
  5495. if (reqbuf.remaining()<sizeof(RemoteFileCommandType))
  5496. return false;
  5497. reqbuf.read(typ);
  5498. if (typ!=RFCunlock) {
  5499. processUnauthenticatedCommand(typ,socket,reqbuf);
  5500. return false;
  5501. }
  5502. if (reqbuf.remaining()<sizeof(OnceKey))
  5503. return false;
  5504. OnceKey oncekey;
  5505. reqbuf.read(sizeof(oncekey),&oncekey);
  5506. IpAddress ip;
  5507. socket->getPeerAddress(ip);
  5508. byte ipdata[16];
  5509. ip.getNetAddress(sizeof(ipdata),&ipdata);
  5510. mergeOnce(oncekey,sizeof(ipdata),&ipdata); // this is clients key
  5511. OnceKey mykey;
  5512. genOnce(mykey);
  5513. reply.append((unsigned)0); // errcode
  5514. aesEncrypt(&oncekey,sizeof(oncekey),&mykey,sizeof(oncekey),encbuf);
  5515. reply.append(encbuf.length()).append(encbuf);
  5516. sendBuffer(socket, reply); // send my oncekey
  5517. reqbuf.clear();
  5518. receiveBuffer(socket, reqbuf, 1);
  5519. if (reqbuf.remaining()>sizeof(RemoteFileCommandType)+sizeof(size32_t)) {
  5520. reqbuf.read(typ);
  5521. if (typ==RFCunlockreply) {
  5522. size32_t bs;
  5523. reqbuf.read(bs);
  5524. if (bs<=reqbuf.remaining()) {
  5525. MemoryBuffer userbuf;
  5526. aesDecrypt(&mykey,sizeof(mykey),reqbuf.readDirect(bs),bs,userbuf);
  5527. byte n;
  5528. userbuf.read(n);
  5529. if (n>=2) {
  5530. StringAttr user;
  5531. StringAttr password;
  5532. userbuf.read(user).read(password);
  5533. Owned<IAuthenticatedUser> iau = createAuthenticatedUser();
  5534. if (iau->login(user,password)) {
  5535. initSendBuffer(reply.clear());
  5536. reply.append((unsigned)0);
  5537. sendBuffer(socket, reply); // send OK
  5538. ret = iau;
  5539. return true;
  5540. }
  5541. }
  5542. }
  5543. }
  5544. }
  5545. reply.clear();
  5546. appendErr(reply, RFSERR_AuthenticateFailed);
  5547. sendBuffer(socket, reply); // send OK
  5548. return false;
  5549. }
  5550. void runClient(ISocket *sock)
  5551. {
  5552. cCommandProcessor::cCommandProcessorParams params;
  5553. IAuthenticatedUser *user=NULL;
  5554. bool authenticated = false;
  5555. try {
  5556. if (checkAuthentication(sock,user))
  5557. authenticated = true;
  5558. }
  5559. catch (IException *e) {
  5560. e->Release();
  5561. }
  5562. if (!authenticated) {
  5563. try {
  5564. sock->Release();
  5565. }
  5566. catch (IException *e) {
  5567. e->Release();
  5568. }
  5569. return;
  5570. }
  5571. params.client = new CRemoteClientHandler(this,sock,user,globallasttick);
  5572. {
  5573. CriticalBlock block(sect);
  5574. clients.append(*LINK(params.client));
  5575. }
  5576. // NB: This could be blocked, by thread pool limit
  5577. threads->start(&params);
  5578. }
  5579. void stop()
  5580. {
  5581. // stop accept loop
  5582. if (TF_TRACE_CLIENT_STATS)
  5583. PROGLOG("CRemoteFileServer::stop");
  5584. if (acceptsock)
  5585. acceptsock->cancel_accept();
  5586. if (securesock)
  5587. securesock->cancel_accept();
  5588. threads->stopAll();
  5589. threads->joinAll(true,60*1000);
  5590. }
  5591. bool notify(CRemoteClientHandler *_client, MemoryBuffer &msg)
  5592. {
  5593. Linked<CRemoteClientHandler> client;
  5594. client.set(_client);
  5595. if (TF_TRACE_FULL)
  5596. PROGLOG("notify %d", msg.length());
  5597. if (msg.length())
  5598. {
  5599. if (TF_TRACE_FULL)
  5600. PROGLOG("notify CRemoteClientHandler(%p), msg length=%u", _client, msg.length());
  5601. cCommandProcessor::cCommandProcessorParams params;
  5602. params.client = client.getClear();
  5603. params.msg.swapWith(msg);
  5604. /* This can block because the thread pool is full and therefore block the selecthandler
  5605. * This is akin to the main server blocking post accept() for the same reason.
  5606. */
  5607. threads->start(&params);
  5608. }
  5609. else
  5610. onCloseSocket(client,3); // removes owned handles
  5611. return false;
  5612. }
  5613. void addClient(CRemoteClientHandler *client)
  5614. {
  5615. if (client&&client->socket)
  5616. selecthandler->add(client->socket,SELECTMODE_READ,client);
  5617. }
  5618. void checkTimeout()
  5619. {
  5620. if (msTick()-clientcounttick>1000*60*60)
  5621. {
  5622. CriticalBlock block(ClientCountSect);
  5623. if (TF_TRACE_CLIENT_STATS && (ClientCount || MaxClientCount))
  5624. PROGLOG("Client count = %d, max = %d", ClientCount, MaxClientCount);
  5625. clientcounttick = msTick();
  5626. MaxClientCount = ClientCount;
  5627. if (closedclients)
  5628. {
  5629. if (TF_TRACE_CLIENT_STATS)
  5630. PROGLOG("Closed client count = %d",closedclients);
  5631. closedclients = 0;
  5632. }
  5633. }
  5634. CriticalBlock block(sect);
  5635. ForEachItemInRev(i,clients)
  5636. {
  5637. CRemoteClientHandler &client = clients.item(i);
  5638. if (client.timedOut())
  5639. {
  5640. StringBuffer s;
  5641. bool ok = client.getInfo(s); // will spot duff sockets
  5642. if (ok&&(client.openFiles.ordinality()!=0))
  5643. {
  5644. if (TF_TRACE_CLIENT_CONN && client.inactiveTimedOut())
  5645. WARNLOG("Inactive %s",s.str());
  5646. }
  5647. else
  5648. {
  5649. #ifndef _DEBUG
  5650. if (TF_TRACE_CLIENT_CONN)
  5651. #endif
  5652. PROGLOG("Timing out %s",s.str());
  5653. closedclients++;
  5654. onCloseSocket(&client,4); // removes owned handles
  5655. }
  5656. }
  5657. }
  5658. }
  5659. void getInfo(StringBuffer &info, unsigned level=1)
  5660. {
  5661. {
  5662. CriticalBlock block(ClientCountSect);
  5663. info.append(VERSTRING).append('\n');
  5664. info.appendf("Client count = %d\n",ClientCount);
  5665. info.appendf("Max client count = %d",MaxClientCount);
  5666. }
  5667. CriticalBlock block(sect);
  5668. ForEachItemIn(i,clients)
  5669. {
  5670. info.newline().append(i).append(": ");
  5671. clients.item(i).getInfo(info);
  5672. }
  5673. info.newline().appendf("Running threads: %u", threadRunningCount());
  5674. info.newline();
  5675. stdCmdThrottler.getInfo(info);
  5676. info.newline();
  5677. slowCmdThrottler.getInfo(info);
  5678. clientStatsTable.getInfo(info, level);
  5679. }
  5680. unsigned threadRunningCount()
  5681. {
  5682. if (!threads)
  5683. return 0;
  5684. return threads->runningCount();
  5685. }
  5686. unsigned idleTime()
  5687. {
  5688. unsigned t = (unsigned)atomic_read(&globallasttick);
  5689. return msTick()-t;
  5690. }
  5691. void setThrottle(ThrottleClass throttleClass, unsigned limit, unsigned delayMs, unsigned cpuThreshold, unsigned queueLimit)
  5692. {
  5693. switch (throttleClass)
  5694. {
  5695. case ThrottleStd:
  5696. stdCmdThrottler.configure(limit, delayMs, cpuThreshold, queueLimit);
  5697. break;
  5698. case ThrottleSlow:
  5699. slowCmdThrottler.configure(limit, delayMs, cpuThreshold, queueLimit);
  5700. break;
  5701. default:
  5702. {
  5703. StringBuffer availableClasses("{ ");
  5704. for (unsigned c=0; c<ThrottleClassMax; c++)
  5705. {
  5706. availableClasses.append(c).append(" = ").append(getThrottleClassText((ThrottleClass)c));
  5707. if (c+1<ThrottleClassMax)
  5708. availableClasses.append(", ");
  5709. }
  5710. availableClasses.append(" }");
  5711. throw MakeStringException(0, "Unknown throttle class: %u, available classes are: %s", (unsigned)throttleClass, availableClasses.str());
  5712. }
  5713. }
  5714. }
  5715. StringBuffer &getStats(StringBuffer &stats, bool reset)
  5716. {
  5717. CriticalBlock block(sect);
  5718. stdCmdThrottler.getStats(stats, reset).newline();
  5719. slowCmdThrottler.getStats(stats, reset);
  5720. if (reset)
  5721. clientStatsTable.reset();
  5722. return stats;
  5723. }
  5724. };
  5725. IRemoteFileServer * createRemoteFileServer(unsigned maxThreads, unsigned maxThreadsDelayMs, unsigned maxAsyncCopy)
  5726. {
  5727. #if SIMULATE_PACKETLOSS
  5728. errorSimulationOn = false;
  5729. #endif
  5730. return new CRemoteFileServer(maxThreads, maxThreadsDelayMs, maxAsyncCopy);
  5731. }
  5732. #ifdef _USE_CPPUNIT
  5733. #include "unittests.hpp"
  5734. #include "rmtfile.hpp"
  5735. static unsigned serverPort = DAFILESRV_PORT+1; // do not use standard port, which if in a URL will be converted to local parth if IP is local
  5736. static StringBuffer basePath;
  5737. static Owned<CSimpleInterface> serverThread;
  5738. class RemoteFileTest : public CppUnit::TestFixture
  5739. {
  5740. CPPUNIT_TEST_SUITE(RemoteFileTest);
  5741. CPPUNIT_TEST(testStartServer);
  5742. CPPUNIT_TEST(testBasicFunctionality);
  5743. CPPUNIT_TEST(testCopy);
  5744. CPPUNIT_TEST(testOther);
  5745. CPPUNIT_TEST(testConfiguration);
  5746. CPPUNIT_TEST(testDirectoryMonitoring);
  5747. CPPUNIT_TEST(testFinish);
  5748. CPPUNIT_TEST_SUITE_END();
  5749. size32_t testLen = 1024;
  5750. protected:
  5751. void testStartServer()
  5752. {
  5753. Owned<ISocket> socket;
  5754. unsigned endPort = MP_END_PORT;
  5755. while (1)
  5756. {
  5757. try
  5758. {
  5759. socket.setown(ISocket::create(serverPort));
  5760. break;
  5761. }
  5762. catch (IJSOCK_Exception *e)
  5763. {
  5764. if (e->errorCode() != JSOCKERR_port_in_use)
  5765. {
  5766. StringBuffer eStr;
  5767. e->errorMessage(eStr);
  5768. e->Release();
  5769. CPPUNIT_ASSERT_MESSAGE(eStr.str(), 0);
  5770. }
  5771. else if (serverPort == endPort)
  5772. {
  5773. e->Release();
  5774. CPPUNIT_ASSERT_MESSAGE("Could not find a free port to use for remote file server", 0);
  5775. }
  5776. }
  5777. ++serverPort;
  5778. }
  5779. basePath.append("//");
  5780. SocketEndpoint ep(serverPort);
  5781. ep.getUrlStr(basePath);
  5782. char cpath[_MAX_DIR];
  5783. if (!GetCurrentDirectory(_MAX_DIR, cpath))
  5784. CPPUNIT_ASSERT_MESSAGE("Current directory path too big", 0);
  5785. else
  5786. basePath.append(cpath);
  5787. addPathSepChar(basePath);
  5788. PROGLOG("basePath = %s", basePath.str());
  5789. class CServerThread : public CSimpleInterface, implements IThreaded
  5790. {
  5791. CThreaded threaded;
  5792. Owned<CRemoteFileServer> server;
  5793. Linked<ISocket> socket;
  5794. public:
  5795. CServerThread(CRemoteFileServer *_server, ISocket *_socket) : server(_server), socket(_socket), threaded("CServerThread")
  5796. {
  5797. threaded.init(this);
  5798. }
  5799. ~CServerThread()
  5800. {
  5801. threaded.join();
  5802. }
  5803. // IThreaded
  5804. virtual void main()
  5805. {
  5806. SSLCfg sslCfg = SSLNone;
  5807. server->run(sslCfg, socket, nullptr);
  5808. }
  5809. };
  5810. enableDafsAuthentication(false);
  5811. Owned<IRemoteFileServer> server = createRemoteFileServer();
  5812. serverThread.setown(new CServerThread(QUERYINTERFACE(server.getClear(), CRemoteFileServer), socket.getClear()));
  5813. }
  5814. void testBasicFunctionality()
  5815. {
  5816. VStringBuffer filePath("%s%s", basePath.str(), "file1");
  5817. // create file
  5818. Owned<IFile> iFile = createIFile(filePath);
  5819. CPPUNIT_ASSERT(iFile);
  5820. Owned<IFileIO> iFileIO = iFile->open(IFOcreate);
  5821. CPPUNIT_ASSERT(iFileIO);
  5822. // write out 1k of random data and crc
  5823. MemoryBuffer mb;
  5824. char *buf = (char *)mb.reserveTruncate(testLen);
  5825. for (unsigned b=0; b<1024; b++)
  5826. buf[b] = getRandom()%256;
  5827. CRC32 crc;
  5828. crc.tally(testLen, buf);
  5829. unsigned writeCrc = crc.get();
  5830. size32_t sz = iFileIO->write(0, testLen, buf);
  5831. CPPUNIT_ASSERT(sz == testLen);
  5832. // close file
  5833. iFileIO.clear();
  5834. // validate remote crc
  5835. CPPUNIT_ASSERT(writeCrc == iFile->getCRC());
  5836. // exists
  5837. CPPUNIT_ASSERT(iFile->exists());
  5838. // validate size
  5839. CPPUNIT_ASSERT(iFile->size() == testLen);
  5840. // read back and validate read data's crc against written
  5841. iFileIO.setown(iFile->open(IFOread));
  5842. CPPUNIT_ASSERT(iFileIO);
  5843. sz = iFileIO->read(0, testLen, buf);
  5844. iFileIO.clear();
  5845. CPPUNIT_ASSERT(sz == testLen);
  5846. crc.reset();
  5847. crc.tally(testLen, buf);
  5848. CPPUNIT_ASSERT(writeCrc == crc.get());
  5849. }
  5850. void testCopy()
  5851. {
  5852. VStringBuffer filePath("%s%s", basePath.str(), "file1");
  5853. Owned<IFile> iFile = createIFile(filePath);
  5854. // test file copy
  5855. VStringBuffer filePathCopy("%s%s", basePath.str(), "file1copy");
  5856. Owned<IFile> iFile1Copy = createIFile(filePathCopy);
  5857. iFile->copyTo(iFile1Copy);
  5858. // read back copy and validate read data's crc against written
  5859. Owned<IFileIO> iFileIO = iFile1Copy->open(IFOreadwrite); // open read/write for appendFile in next step.
  5860. CPPUNIT_ASSERT(iFileIO);
  5861. MemoryBuffer mb;
  5862. char *buf = (char *)mb.reserveTruncate(testLen);
  5863. size32_t sz = iFileIO->read(0, testLen, buf);
  5864. CPPUNIT_ASSERT(sz == testLen);
  5865. CRC32 crc;
  5866. crc.tally(testLen, buf);
  5867. CPPUNIT_ASSERT(iFile->getCRC() == crc.get());
  5868. // check appendFile functionality. NB after this "file1copy" should be 2*testLen
  5869. CPPUNIT_ASSERT(testLen == iFileIO->appendFile(iFile));
  5870. iFileIO.clear();
  5871. // validate new size
  5872. CPPUNIT_ASSERT(iFile1Copy->size() == 2 * testLen);
  5873. // setSize test, truncate copy to original size
  5874. iFileIO.setown(iFile1Copy->open(IFOreadwrite));
  5875. iFileIO->setSize(testLen);
  5876. // validate new size
  5877. CPPUNIT_ASSERT(iFile1Copy->size() == testLen);
  5878. }
  5879. void testOther()
  5880. {
  5881. VStringBuffer filePath("%s%s", basePath.str(), "file1");
  5882. Owned<IFile> iFile = createIFile(filePath);
  5883. // rename
  5884. iFile->rename("file2");
  5885. // create a directory
  5886. VStringBuffer subDirPath("%s%s", basePath.str(), "subdir1");
  5887. Owned<IFile> subDirIFile = createIFile(subDirPath);
  5888. subDirIFile->createDirectory();
  5889. // check isDirectory result
  5890. CPPUNIT_ASSERT(subDirIFile->isDirectory());
  5891. // move previous created and renamed file into new sub-directory
  5892. // ensure not present before move
  5893. VStringBuffer subDirFilePath("%s/%s", subDirPath.str(), "file2");
  5894. Owned<IFile> iFile2 = createIFile(subDirFilePath);
  5895. iFile2->remove();
  5896. iFile->move(subDirFilePath);
  5897. // count sub-directory files with a wildcard
  5898. unsigned count=0;
  5899. Owned<IDirectoryIterator> iter = subDirIFile->directoryFiles("*2");
  5900. ForEach(*iter)
  5901. ++count;
  5902. CPPUNIT_ASSERT(1 == count);
  5903. // check isFile result
  5904. CPPUNIT_ASSERT(iFile2->isFile());
  5905. // validate isReadOnly before after setting
  5906. CPPUNIT_ASSERT(!iFile2->isReadOnly());
  5907. iFile2->setReadOnly(true);
  5908. CPPUNIT_ASSERT(iFile2->isReadOnly());
  5909. // get/set Time and validate result
  5910. CDateTime createTime, modifiedTime, accessedTime;
  5911. CPPUNIT_ASSERT(subDirIFile->getTime(&createTime, &modifiedTime, &accessedTime));
  5912. CDateTime newModifiedTime = modifiedTime;
  5913. newModifiedTime.adjustTime(-86400); // -1 day
  5914. CPPUNIT_ASSERT(subDirIFile->setTime(&createTime, &newModifiedTime, &accessedTime));
  5915. CPPUNIT_ASSERT(subDirIFile->getTime(&createTime, &modifiedTime, &accessedTime));
  5916. CPPUNIT_ASSERT(modifiedTime == newModifiedTime);
  5917. // test set file permissions
  5918. iFile2->setFilePermissions(0777);
  5919. }
  5920. void testConfiguration()
  5921. {
  5922. SocketEndpoint ep(serverPort); // test trace open connections
  5923. CPPUNIT_ASSERT(setDafileSvrTraceFlags(ep, 0x08));
  5924. StringBuffer infoStr;
  5925. CPPUNIT_ASSERT(RFEnoerror == getDafileSvrInfo(ep, 10, infoStr));
  5926. CPPUNIT_ASSERT(RFEnoerror == setDafileSvrThrottleLimit(ep, ThrottleStd, DEFAULT_STDCMD_PARALLELREQUESTLIMIT+1, DEFAULT_STDCMD_THROTTLEDELAYMS+1, DEFAULT_STDCMD_THROTTLECPULIMIT+1, DEFAULT_STDCMD_THROTTLEQUEUELIMIT+1));
  5927. }
  5928. void testDirectoryMonitoring()
  5929. {
  5930. VStringBuffer subDirPath("%s%s", basePath.str(), "subdir1");
  5931. Owned<IFile> subDirIFile = createIFile(subDirPath);
  5932. subDirIFile->createDirectory();
  5933. VStringBuffer filePath("%s/%s", subDirPath.str(), "file1");
  5934. class CDelayedFileCreate : implements IThreaded
  5935. {
  5936. CThreaded threaded;
  5937. StringAttr filePath;
  5938. Semaphore doneSem;
  5939. public:
  5940. CDelayedFileCreate(const char *_filePath) : filePath(_filePath), threaded("CDelayedFileCreate")
  5941. {
  5942. threaded.init(this);
  5943. }
  5944. ~CDelayedFileCreate()
  5945. {
  5946. stop();
  5947. }
  5948. void stop()
  5949. {
  5950. doneSem.signal();
  5951. threaded.join();
  5952. }
  5953. // IThreaded impl.
  5954. virtual void main()
  5955. {
  5956. MilliSleep(1000); // give monitorDirectory a chance to be monitoring
  5957. // create file
  5958. Owned<IFile> iFile = createIFile(filePath);
  5959. CPPUNIT_ASSERT(iFile);
  5960. Owned<IFileIO> iFileIO = iFile->open(IFOcreate);
  5961. CPPUNIT_ASSERT(iFileIO);
  5962. iFileIO.clear();
  5963. doneSem.wait(60 * 1000);
  5964. CPPUNIT_ASSERT(iFile->remove());
  5965. }
  5966. } delayedFileCreate(filePath);
  5967. Owned<IDirectoryDifferenceIterator> iter = subDirIFile->monitorDirectory(nullptr, nullptr, false, false, 2000, 60 * 1000);
  5968. ForEach(*iter)
  5969. {
  5970. StringBuffer fname;
  5971. iter->getName(fname);
  5972. PROGLOG("fname = %s", fname.str());
  5973. }
  5974. delayedFileCreate.stop();
  5975. }
  5976. void testFinish()
  5977. {
  5978. // clearup
  5979. VStringBuffer filePathCopy("%s%s", basePath.str(), "file1copy");
  5980. Owned<IFile> iFile1Copy = createIFile(filePathCopy);
  5981. CPPUNIT_ASSERT(iFile1Copy->remove());
  5982. VStringBuffer subDirPath("%s%s", basePath.str(), "subdir1");
  5983. VStringBuffer subDirFilePath("%s/%s", subDirPath.str(), "file2");
  5984. Owned<IFile> iFile2 = createIFile(subDirFilePath);
  5985. CPPUNIT_ASSERT(iFile2->remove());
  5986. Owned<IFile> subDirIFile = createIFile(subDirPath);
  5987. CPPUNIT_ASSERT(subDirIFile->remove());
  5988. SocketEndpoint ep(serverPort);
  5989. Owned<ISocket> sock = ISocket::connect_timeout(ep, 60 * 1000);
  5990. CPPUNIT_ASSERT(RFEnoerror == stopRemoteServer(sock));
  5991. serverThread.clear();
  5992. }
  5993. };
  5994. CPPUNIT_TEST_SUITE_REGISTRATION( RemoteFileTest );
  5995. CPPUNIT_TEST_SUITE_NAMED_REGISTRATION( RemoteFileTest, "RemoteFileTests" );
  5996. #endif // _USE_CPPUNIT