server.cpp 197 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976
  1. #include "chat.h"
  2. #include "utils.hpp"
  3. #include "arg.h"
  4. #include "common.h"
  5. #include "json-schema-to-grammar.h"
  6. #include "llama.h"
  7. #include "log.h"
  8. #include "sampling.h"
  9. #include "speculative.h"
  10. #include "mtmd.h"
  11. #include "mtmd-helper.h"
  12. // mime type for sending response
  13. #define MIMETYPE_JSON "application/json; charset=utf-8"
  14. // auto generated files (see README.md for details)
  15. #include "index.html.gz.hpp"
  16. #include "loading.html.hpp"
  17. #include <atomic>
  18. #include <chrono>
  19. #include <condition_variable>
  20. #include <cstddef>
  21. #include <cinttypes>
  22. #include <deque>
  23. #include <memory>
  24. #include <mutex>
  25. #include <signal.h>
  26. #include <thread>
  27. #include <unordered_map>
  28. #include <unordered_set>
  29. using json = nlohmann::ordered_json;
  30. constexpr int HTTP_POLLING_SECONDS = 1;
  31. enum stop_type {
  32. STOP_TYPE_NONE,
  33. STOP_TYPE_EOS,
  34. STOP_TYPE_WORD,
  35. STOP_TYPE_LIMIT,
  36. };
  37. // state diagram: https://github.com/ggml-org/llama.cpp/pull/9283
  38. enum slot_state {
  39. SLOT_STATE_IDLE,
  40. SLOT_STATE_STARTED, // TODO: this state is only used for setting up the initial prompt processing; maybe merge it with launch_slot_with_task in the future
  41. SLOT_STATE_PROCESSING_PROMPT,
  42. SLOT_STATE_DONE_PROMPT,
  43. SLOT_STATE_GENERATING,
  44. };
  45. enum server_state {
  46. SERVER_STATE_LOADING_MODEL, // Server is starting up, model not fully loaded yet
  47. SERVER_STATE_READY, // Server is ready and model is loaded
  48. };
  49. enum server_task_type {
  50. SERVER_TASK_TYPE_COMPLETION,
  51. SERVER_TASK_TYPE_EMBEDDING,
  52. SERVER_TASK_TYPE_RERANK,
  53. SERVER_TASK_TYPE_INFILL,
  54. SERVER_TASK_TYPE_CANCEL,
  55. SERVER_TASK_TYPE_NEXT_RESPONSE,
  56. SERVER_TASK_TYPE_METRICS,
  57. SERVER_TASK_TYPE_SLOT_SAVE,
  58. SERVER_TASK_TYPE_SLOT_RESTORE,
  59. SERVER_TASK_TYPE_SLOT_ERASE,
  60. SERVER_TASK_TYPE_SET_LORA,
  61. };
  62. enum oaicompat_type {
  63. OAICOMPAT_TYPE_NONE,
  64. OAICOMPAT_TYPE_CHAT,
  65. OAICOMPAT_TYPE_COMPLETION,
  66. OAICOMPAT_TYPE_EMBEDDING,
  67. };
  68. // https://community.openai.com/t/openai-chat-list-of-error-codes-and-types/357791/11
  69. enum error_type {
  70. ERROR_TYPE_INVALID_REQUEST,
  71. ERROR_TYPE_AUTHENTICATION,
  72. ERROR_TYPE_SERVER,
  73. ERROR_TYPE_NOT_FOUND,
  74. ERROR_TYPE_PERMISSION,
  75. ERROR_TYPE_UNAVAILABLE, // custom error
  76. ERROR_TYPE_NOT_SUPPORTED, // custom error
  77. };
  78. static bool server_task_type_need_embd(server_task_type task_type) {
  79. switch (task_type) {
  80. case SERVER_TASK_TYPE_EMBEDDING:
  81. case SERVER_TASK_TYPE_RERANK:
  82. return true;
  83. default:
  84. return false;
  85. }
  86. }
  87. static bool server_task_type_need_logits(server_task_type task_type) {
  88. switch (task_type) {
  89. case SERVER_TASK_TYPE_COMPLETION:
  90. case SERVER_TASK_TYPE_INFILL:
  91. return true;
  92. default:
  93. return false;
  94. }
  95. }
  96. struct slot_params {
  97. bool stream = true;
  98. bool cache_prompt = true; // remember the prompt to avoid reprocessing all prompt
  99. bool return_tokens = false;
  100. int32_t n_keep = 0; // number of tokens to keep from initial prompt
  101. int32_t n_discard = 0; // number of tokens after n_keep that may be discarded when shifting context, 0 defaults to half
  102. int32_t n_predict = -1; // new tokens to predict
  103. int32_t n_indent = 0; // mininum line indentation for the generated text in number of whitespace characters
  104. int64_t t_max_prompt_ms = -1; // TODO: implement
  105. int64_t t_max_predict_ms = -1; // if positive, limit the generation phase to this time limit
  106. std::vector<common_adapter_lora_info> lora;
  107. std::vector<std::string> antiprompt;
  108. std::vector<std::string> response_fields;
  109. bool timings_per_token = false;
  110. bool post_sampling_probs = false;
  111. bool ignore_eos = false;
  112. struct common_params_sampling sampling;
  113. struct common_params_speculative speculative;
  114. // OAI-compat fields
  115. bool verbose = false;
  116. oaicompat_type oaicompat = OAICOMPAT_TYPE_NONE;
  117. std::string oaicompat_model;
  118. std::string oaicompat_cmpl_id;
  119. common_chat_syntax oaicompat_chat_syntax;
  120. json to_json() const {
  121. std::vector<std::string> samplers;
  122. samplers.reserve(sampling.samplers.size());
  123. for (const auto & sampler : sampling.samplers) {
  124. samplers.emplace_back(common_sampler_type_to_str(sampler));
  125. }
  126. json lora = json::array();
  127. for (size_t i = 0; i < this->lora.size(); ++i) {
  128. lora.push_back({{"id", i}, {"scale", this->lora[i].scale}});
  129. }
  130. auto grammar_triggers = json::array();
  131. for (const auto & trigger : sampling.grammar_triggers) {
  132. server_grammar_trigger ct(std::move(trigger));
  133. grammar_triggers.push_back(ct.to_json());
  134. }
  135. return json {
  136. {"n_predict", n_predict}, // Server configured n_predict
  137. {"seed", sampling.seed},
  138. {"temperature", sampling.temp},
  139. {"dynatemp_range", sampling.dynatemp_range},
  140. {"dynatemp_exponent", sampling.dynatemp_exponent},
  141. {"top_k", sampling.top_k},
  142. {"top_p", sampling.top_p},
  143. {"min_p", sampling.min_p},
  144. {"top_n_sigma", sampling.top_n_sigma},
  145. {"xtc_probability", sampling.xtc_probability},
  146. {"xtc_threshold", sampling.xtc_threshold},
  147. {"typical_p", sampling.typ_p},
  148. {"repeat_last_n", sampling.penalty_last_n},
  149. {"repeat_penalty", sampling.penalty_repeat},
  150. {"presence_penalty", sampling.penalty_present},
  151. {"frequency_penalty", sampling.penalty_freq},
  152. {"dry_multiplier", sampling.dry_multiplier},
  153. {"dry_base", sampling.dry_base},
  154. {"dry_allowed_length", sampling.dry_allowed_length},
  155. {"dry_penalty_last_n", sampling.dry_penalty_last_n},
  156. {"dry_sequence_breakers", sampling.dry_sequence_breakers},
  157. {"mirostat", sampling.mirostat},
  158. {"mirostat_tau", sampling.mirostat_tau},
  159. {"mirostat_eta", sampling.mirostat_eta},
  160. {"stop", antiprompt},
  161. {"max_tokens", n_predict}, // User configured n_predict
  162. {"n_keep", n_keep},
  163. {"n_discard", n_discard},
  164. {"ignore_eos", sampling.ignore_eos},
  165. {"stream", stream},
  166. {"logit_bias", format_logit_bias(sampling.logit_bias)},
  167. {"n_probs", sampling.n_probs},
  168. {"min_keep", sampling.min_keep},
  169. {"grammar", sampling.grammar},
  170. {"grammar_lazy", sampling.grammar_lazy},
  171. {"grammar_triggers", grammar_triggers},
  172. {"preserved_tokens", sampling.preserved_tokens},
  173. {"chat_format", common_chat_format_name(oaicompat_chat_syntax.format)},
  174. {"reasoning_format", common_reasoning_format_name(oaicompat_chat_syntax.reasoning_format)},
  175. {"reasoning_in_content", oaicompat_chat_syntax.reasoning_in_content},
  176. {"thinking_forced_open", oaicompat_chat_syntax.thinking_forced_open},
  177. {"samplers", samplers},
  178. {"speculative.n_max", speculative.n_max},
  179. {"speculative.n_min", speculative.n_min},
  180. {"speculative.p_min", speculative.p_min},
  181. {"timings_per_token", timings_per_token},
  182. {"post_sampling_probs", post_sampling_probs},
  183. {"lora", lora},
  184. };
  185. }
  186. };
  187. struct server_task {
  188. int id = -1; // to be filled by server_queue
  189. int index = -1; // used when there are multiple prompts (batch request)
  190. server_task_type type;
  191. // used by SERVER_TASK_TYPE_CANCEL
  192. int id_target = -1;
  193. // used by SERVER_TASK_TYPE_INFERENCE
  194. slot_params params;
  195. server_tokens prompt_tokens;
  196. int id_selected_slot = -1;
  197. // used by SERVER_TASK_TYPE_SLOT_SAVE, SERVER_TASK_TYPE_SLOT_RESTORE, SERVER_TASK_TYPE_SLOT_ERASE
  198. struct slot_action {
  199. int slot_id;
  200. std::string filename;
  201. std::string filepath;
  202. };
  203. slot_action slot_action;
  204. // used by SERVER_TASK_TYPE_METRICS
  205. bool metrics_reset_bucket = false;
  206. // used by SERVER_TASK_TYPE_SET_LORA
  207. std::vector<common_adapter_lora_info> set_lora;
  208. server_task(server_task_type type) : type(type) {}
  209. static slot_params params_from_json_cmpl(
  210. const llama_context * ctx,
  211. const common_params & params_base,
  212. const json & data) {
  213. const llama_model * model = llama_get_model(ctx);
  214. const llama_vocab * vocab = llama_model_get_vocab(model);
  215. slot_params params;
  216. // Sampling parameter defaults are loaded from the global server context (but individual requests can still override them)
  217. slot_params defaults;
  218. defaults.sampling = params_base.sampling;
  219. defaults.speculative = params_base.speculative;
  220. defaults.n_keep = params_base.n_keep;
  221. // enabling this will output extra debug information in the HTTP responses from the server
  222. params.verbose = params_base.verbosity > 9;
  223. params.timings_per_token = json_value(data, "timings_per_token", false);
  224. params.stream = json_value(data, "stream", false);
  225. params.cache_prompt = json_value(data, "cache_prompt", true);
  226. params.return_tokens = json_value(data, "return_tokens", false);
  227. params.n_predict = json_value(data, "n_predict", json_value(data, "max_tokens", defaults.n_predict));
  228. params.n_indent = json_value(data, "n_indent", defaults.n_indent);
  229. params.n_keep = json_value(data, "n_keep", defaults.n_keep);
  230. params.n_discard = json_value(data, "n_discard", defaults.n_discard);
  231. //params.t_max_prompt_ms = json_value(data, "t_max_prompt_ms", defaults.t_max_prompt_ms); // TODO: implement
  232. params.t_max_predict_ms = json_value(data, "t_max_predict_ms", defaults.t_max_predict_ms);
  233. params.response_fields = json_value(data, "response_fields", std::vector<std::string>());
  234. params.sampling.top_k = json_value(data, "top_k", defaults.sampling.top_k);
  235. params.sampling.top_p = json_value(data, "top_p", defaults.sampling.top_p);
  236. params.sampling.min_p = json_value(data, "min_p", defaults.sampling.min_p);
  237. params.sampling.top_n_sigma = json_value(data, "top_n_sigma", defaults.sampling.top_n_sigma);
  238. params.sampling.xtc_probability = json_value(data, "xtc_probability", defaults.sampling.xtc_probability);
  239. params.sampling.xtc_threshold = json_value(data, "xtc_threshold", defaults.sampling.xtc_threshold);
  240. params.sampling.typ_p = json_value(data, "typical_p", defaults.sampling.typ_p);
  241. params.sampling.temp = json_value(data, "temperature", defaults.sampling.temp);
  242. params.sampling.dynatemp_range = json_value(data, "dynatemp_range", defaults.sampling.dynatemp_range);
  243. params.sampling.dynatemp_exponent = json_value(data, "dynatemp_exponent", defaults.sampling.dynatemp_exponent);
  244. params.sampling.penalty_last_n = json_value(data, "repeat_last_n", defaults.sampling.penalty_last_n);
  245. params.sampling.penalty_repeat = json_value(data, "repeat_penalty", defaults.sampling.penalty_repeat);
  246. params.sampling.penalty_freq = json_value(data, "frequency_penalty", defaults.sampling.penalty_freq);
  247. params.sampling.penalty_present = json_value(data, "presence_penalty", defaults.sampling.penalty_present);
  248. params.sampling.dry_multiplier = json_value(data, "dry_multiplier", defaults.sampling.dry_multiplier);
  249. params.sampling.dry_base = json_value(data, "dry_base", defaults.sampling.dry_base);
  250. params.sampling.dry_allowed_length = json_value(data, "dry_allowed_length", defaults.sampling.dry_allowed_length);
  251. params.sampling.dry_penalty_last_n = json_value(data, "dry_penalty_last_n", defaults.sampling.dry_penalty_last_n);
  252. params.sampling.mirostat = json_value(data, "mirostat", defaults.sampling.mirostat);
  253. params.sampling.mirostat_tau = json_value(data, "mirostat_tau", defaults.sampling.mirostat_tau);
  254. params.sampling.mirostat_eta = json_value(data, "mirostat_eta", defaults.sampling.mirostat_eta);
  255. params.sampling.seed = json_value(data, "seed", defaults.sampling.seed);
  256. params.sampling.n_probs = json_value(data, "n_probs", defaults.sampling.n_probs);
  257. params.sampling.min_keep = json_value(data, "min_keep", defaults.sampling.min_keep);
  258. params.post_sampling_probs = json_value(data, "post_sampling_probs", defaults.post_sampling_probs);
  259. params.speculative.n_min = json_value(data, "speculative.n_min", defaults.speculative.n_min);
  260. params.speculative.n_max = json_value(data, "speculative.n_max", defaults.speculative.n_max);
  261. params.speculative.p_min = json_value(data, "speculative.p_min", defaults.speculative.p_min);
  262. params.speculative.n_min = std::min(params.speculative.n_max, params.speculative.n_min);
  263. params.speculative.n_min = std::max(params.speculative.n_min, 0);
  264. params.speculative.n_max = std::max(params.speculative.n_max, 0);
  265. // Use OpenAI API logprobs only if n_probs wasn't provided
  266. if (data.contains("logprobs") && params.sampling.n_probs == defaults.sampling.n_probs){
  267. params.sampling.n_probs = json_value(data, "logprobs", defaults.sampling.n_probs);
  268. }
  269. if (data.contains("lora")) {
  270. if (data.at("lora").is_array()) {
  271. params.lora = parse_lora_request(params_base.lora_adapters, data.at("lora"));
  272. } else {
  273. throw std::runtime_error("Error: 'lora' must be an array of objects with 'id' and 'scale' fields");
  274. }
  275. } else {
  276. params.lora = params_base.lora_adapters;
  277. }
  278. // TODO: add more sanity checks for the input parameters
  279. if (params.sampling.penalty_last_n < -1) {
  280. throw std::runtime_error("Error: repeat_last_n must be >= -1");
  281. }
  282. if (params.sampling.dry_penalty_last_n < -1) {
  283. throw std::runtime_error("Error: dry_penalty_last_n must be >= -1");
  284. }
  285. if (params.sampling.penalty_last_n == -1) {
  286. // note: should be the slot's context and not the full context, but it's ok
  287. params.sampling.penalty_last_n = llama_n_ctx(ctx);
  288. }
  289. if (params.sampling.dry_penalty_last_n == -1) {
  290. params.sampling.dry_penalty_last_n = llama_n_ctx(ctx);
  291. }
  292. if (params.sampling.dry_base < 1.0f) {
  293. params.sampling.dry_base = defaults.sampling.dry_base;
  294. }
  295. // sequence breakers for DRY
  296. {
  297. // Currently, this is not compatible with TextGen WebUI, Koboldcpp and SillyTavern format
  298. // Ref: https://github.com/oobabooga/text-generation-webui/blob/d1af7a41ade7bd3c3a463bfa640725edb818ebaf/extensions/openai/typing.py#L39
  299. if (data.contains("dry_sequence_breakers")) {
  300. params.sampling.dry_sequence_breakers = json_value(data, "dry_sequence_breakers", std::vector<std::string>());
  301. if (params.sampling.dry_sequence_breakers.empty()) {
  302. throw std::runtime_error("Error: dry_sequence_breakers must be a non-empty array of strings");
  303. }
  304. }
  305. }
  306. // process "json_schema" and "grammar"
  307. if (data.contains("json_schema") && !data.contains("grammar")) {
  308. try {
  309. auto schema = json_value(data, "json_schema", json::object());
  310. SRV_DBG("JSON schema: %s\n", schema.dump(2).c_str());
  311. params.sampling.grammar = json_schema_to_grammar(schema);
  312. SRV_DBG("Converted grammar: %s\n", params.sampling.grammar.c_str());
  313. } catch (const std::exception & e) {
  314. throw std::runtime_error(std::string("\"json_schema\": ") + e.what());
  315. }
  316. } else {
  317. params.sampling.grammar = json_value(data, "grammar", defaults.sampling.grammar);
  318. SRV_DBG("Grammar: %s\n", params.sampling.grammar.c_str());
  319. params.sampling.grammar_lazy = json_value(data, "grammar_lazy", defaults.sampling.grammar_lazy);
  320. SRV_DBG("Grammar lazy: %s\n", params.sampling.grammar_lazy ? "true" : "false");
  321. }
  322. {
  323. auto it = data.find("chat_format");
  324. if (it != data.end()) {
  325. params.oaicompat_chat_syntax.format = static_cast<common_chat_format>(it->get<int>());
  326. SRV_INF("Chat format: %s\n", common_chat_format_name(params.oaicompat_chat_syntax.format));
  327. } else {
  328. params.oaicompat_chat_syntax.format = defaults.oaicompat_chat_syntax.format;
  329. }
  330. params.oaicompat_chat_syntax.reasoning_format = params_base.reasoning_format;
  331. params.oaicompat_chat_syntax.reasoning_in_content = params.stream && (params_base.reasoning_format == COMMON_REASONING_FORMAT_DEEPSEEK_LEGACY);
  332. params.oaicompat_chat_syntax.thinking_forced_open = json_value(data, "thinking_forced_open", false);
  333. params.oaicompat_chat_syntax.parse_tool_calls = json_value(data, "parse_tool_calls", false);
  334. }
  335. {
  336. const auto preserved_tokens = data.find("preserved_tokens");
  337. if (preserved_tokens != data.end()) {
  338. for (const auto & t : *preserved_tokens) {
  339. auto ids = common_tokenize(vocab, t.get<std::string>(), /* add_special= */ false, /* parse_special= */ true);
  340. if (ids.size() == 1) {
  341. SRV_DBG("Preserved token: %d\n", ids[0]);
  342. params.sampling.preserved_tokens.insert(ids[0]);
  343. } else {
  344. // This may happen when using a tool call style meant for a model with special tokens to preserve on a model without said tokens.
  345. SRV_DBG("Not preserved because more than 1 token: %s\n", t.get<std::string>().c_str());
  346. }
  347. }
  348. }
  349. const auto grammar_triggers = data.find("grammar_triggers");
  350. if (grammar_triggers != data.end()) {
  351. for (const auto & t : *grammar_triggers) {
  352. server_grammar_trigger ct(t);
  353. if (ct.value.type == COMMON_GRAMMAR_TRIGGER_TYPE_WORD) {
  354. const auto & word = ct.value.value;
  355. auto ids = common_tokenize(vocab, word, /* add_special= */ false, /* parse_special= */ true);
  356. if (ids.size() == 1) {
  357. auto token = ids[0];
  358. if (std::find(params.sampling.preserved_tokens.begin(), params.sampling.preserved_tokens.end(), (llama_token) token) == params.sampling.preserved_tokens.end()) {
  359. throw std::runtime_error("Grammar trigger word should be marked as preserved token: " + word);
  360. }
  361. SRV_DBG("Grammar trigger token: %d (`%s`)\n", token, word.c_str());
  362. common_grammar_trigger trigger;
  363. trigger.type = COMMON_GRAMMAR_TRIGGER_TYPE_TOKEN;
  364. trigger.value = word;
  365. trigger.token = token;
  366. params.sampling.grammar_triggers.push_back(std::move(trigger));
  367. } else {
  368. SRV_DBG("Grammar trigger word: `%s`\n", word.c_str());
  369. params.sampling.grammar_triggers.push_back({COMMON_GRAMMAR_TRIGGER_TYPE_WORD, word});
  370. }
  371. } else {
  372. if (ct.value.type == COMMON_GRAMMAR_TRIGGER_TYPE_PATTERN) {
  373. SRV_DBG("Grammar trigger pattern: `%s`\n", ct.value.value.c_str());
  374. } else if (ct.value.type == COMMON_GRAMMAR_TRIGGER_TYPE_PATTERN_FULL) {
  375. SRV_DBG("Grammar trigger pattern full: `%s`\n", ct.value.value.c_str());
  376. } else {
  377. throw std::runtime_error("Unknown grammar trigger type");
  378. }
  379. params.sampling.grammar_triggers.emplace_back(std::move(ct.value));
  380. }
  381. }
  382. }
  383. if (params.sampling.grammar_lazy && params.sampling.grammar_triggers.empty()) {
  384. throw std::runtime_error("Error: no triggers set for lazy grammar!");
  385. }
  386. }
  387. {
  388. params.sampling.logit_bias.clear();
  389. params.ignore_eos = json_value(data, "ignore_eos", false);
  390. const auto & logit_bias = data.find("logit_bias");
  391. if (logit_bias != data.end() && logit_bias->is_array()) {
  392. const int n_vocab = llama_vocab_n_tokens(vocab);
  393. for (const auto & el : *logit_bias) {
  394. // TODO: we may want to throw errors here, in case "el" is incorrect
  395. if (el.is_array() && el.size() == 2) {
  396. float bias;
  397. if (el[1].is_number()) {
  398. bias = el[1].get<float>();
  399. } else if (el[1].is_boolean() && !el[1].get<bool>()) {
  400. bias = -INFINITY;
  401. } else {
  402. continue;
  403. }
  404. if (el[0].is_number_integer()) {
  405. llama_token tok = el[0].get<llama_token>();
  406. if (tok >= 0 && tok < n_vocab) {
  407. params.sampling.logit_bias.push_back({tok, bias});
  408. }
  409. } else if (el[0].is_string()) {
  410. auto toks = common_tokenize(vocab, el[0].get<std::string>(), false);
  411. for (auto tok : toks) {
  412. params.sampling.logit_bias.push_back({tok, bias});
  413. }
  414. }
  415. }
  416. }
  417. }
  418. }
  419. {
  420. params.antiprompt.clear();
  421. const auto & stop = data.find("stop");
  422. if (stop != data.end() && stop->is_array()) {
  423. for (const auto & word : *stop) {
  424. if (!word.empty()) {
  425. params.antiprompt.push_back(word);
  426. }
  427. }
  428. }
  429. }
  430. {
  431. const auto samplers = data.find("samplers");
  432. if (samplers != data.end()) {
  433. if (samplers->is_array()) {
  434. params.sampling.samplers = common_sampler_types_from_names(*samplers, false);
  435. } else if (samplers->is_string()){
  436. params.sampling.samplers = common_sampler_types_from_chars(samplers->get<std::string>());
  437. }
  438. } else {
  439. params.sampling.samplers = defaults.sampling.samplers;
  440. }
  441. }
  442. std::string model_name = params_base.model_alias.empty() ? DEFAULT_OAICOMPAT_MODEL : params_base.model_alias;
  443. params.oaicompat_model = json_value(data, "model", model_name);
  444. return params;
  445. }
  446. // utility function
  447. static std::unordered_set<int> get_list_id(const std::vector<server_task> & tasks) {
  448. std::unordered_set<int> ids(tasks.size());
  449. for (size_t i = 0; i < tasks.size(); i++) {
  450. ids.insert(tasks[i].id);
  451. }
  452. return ids;
  453. }
  454. };
  455. struct result_timings {
  456. int32_t prompt_n = -1;
  457. double prompt_ms;
  458. double prompt_per_token_ms;
  459. double prompt_per_second;
  460. int32_t predicted_n = -1;
  461. double predicted_ms;
  462. double predicted_per_token_ms;
  463. double predicted_per_second;
  464. // Optional speculative metrics - only included when > 0
  465. int32_t draft_n = 0;
  466. int32_t draft_n_accepted = 0;
  467. json to_json() const {
  468. json base = {
  469. {"prompt_n", prompt_n},
  470. {"prompt_ms", prompt_ms},
  471. {"prompt_per_token_ms", prompt_per_token_ms},
  472. {"prompt_per_second", prompt_per_second},
  473. {"predicted_n", predicted_n},
  474. {"predicted_ms", predicted_ms},
  475. {"predicted_per_token_ms", predicted_per_token_ms},
  476. {"predicted_per_second", predicted_per_second},
  477. };
  478. if (draft_n > 0) {
  479. base["draft_n"] = draft_n;
  480. base["draft_n_accepted"] = draft_n_accepted;
  481. }
  482. return base;
  483. }
  484. };
  485. struct server_task_result {
  486. int id = -1;
  487. int id_slot = -1;
  488. virtual bool is_error() {
  489. // only used by server_task_result_error
  490. return false;
  491. }
  492. virtual bool is_stop() {
  493. // only used by server_task_result_cmpl_*
  494. return false;
  495. }
  496. virtual int get_index() {
  497. return -1;
  498. }
  499. virtual json to_json() = 0;
  500. virtual ~server_task_result() = default;
  501. };
  502. // using shared_ptr for polymorphism of server_task_result
  503. using server_task_result_ptr = std::unique_ptr<server_task_result>;
  504. inline std::string stop_type_to_str(stop_type type) {
  505. switch (type) {
  506. case STOP_TYPE_EOS: return "eos";
  507. case STOP_TYPE_WORD: return "word";
  508. case STOP_TYPE_LIMIT: return "limit";
  509. default: return "none";
  510. }
  511. }
  512. struct completion_token_output {
  513. llama_token tok;
  514. float prob;
  515. std::string text_to_send;
  516. struct prob_info {
  517. llama_token tok;
  518. std::string txt;
  519. float prob;
  520. };
  521. std::vector<prob_info> probs;
  522. json to_json(bool post_sampling_probs) const {
  523. json probs_for_token = json::array();
  524. for (const auto & p : probs) {
  525. std::string txt(p.txt);
  526. txt.resize(validate_utf8(txt));
  527. probs_for_token.push_back(json {
  528. {"id", p.tok},
  529. {"token", txt},
  530. {"bytes", str_to_bytes(p.txt)},
  531. {
  532. post_sampling_probs ? "prob" : "logprob",
  533. post_sampling_probs ? p.prob : logarithm(p.prob)
  534. },
  535. });
  536. }
  537. return probs_for_token;
  538. }
  539. static json probs_vector_to_json(const std::vector<completion_token_output> & probs, bool post_sampling_probs) {
  540. json out = json::array();
  541. for (const auto & p : probs) {
  542. std::string txt(p.text_to_send);
  543. txt.resize(validate_utf8(txt));
  544. out.push_back(json {
  545. {"id", p.tok},
  546. {"token", txt},
  547. {"bytes", str_to_bytes(p.text_to_send)},
  548. {
  549. post_sampling_probs ? "prob" : "logprob",
  550. post_sampling_probs ? p.prob : logarithm(p.prob)
  551. },
  552. {
  553. post_sampling_probs ? "top_probs" : "top_logprobs",
  554. p.to_json(post_sampling_probs)
  555. },
  556. });
  557. }
  558. return out;
  559. }
  560. static float logarithm(float x) {
  561. // nlohmann::json converts -inf to null, so we need to prevent that
  562. return x == 0.0f ? std::numeric_limits<float>::lowest() : std::log(x);
  563. }
  564. static std::vector<unsigned char> str_to_bytes(const std::string & str) {
  565. std::vector<unsigned char> bytes;
  566. for (unsigned char c : str) {
  567. bytes.push_back(c);
  568. }
  569. return bytes;
  570. }
  571. };
  572. struct server_task_result_cmpl_final : server_task_result {
  573. int index = 0;
  574. std::string content;
  575. llama_tokens tokens;
  576. bool stream;
  577. result_timings timings;
  578. std::string prompt;
  579. bool truncated;
  580. int32_t n_decoded;
  581. int32_t n_prompt_tokens;
  582. int32_t n_tokens_cached;
  583. bool has_new_line;
  584. std::string stopping_word;
  585. stop_type stop = STOP_TYPE_NONE;
  586. bool post_sampling_probs;
  587. std::vector<completion_token_output> probs_output;
  588. std::vector<std::string> response_fields;
  589. slot_params generation_params;
  590. // OAI-compat fields
  591. bool verbose = false;
  592. oaicompat_type oaicompat = OAICOMPAT_TYPE_NONE;
  593. std::string oaicompat_model;
  594. std::string oaicompat_cmpl_id;
  595. common_chat_msg oaicompat_msg;
  596. std::vector<common_chat_msg_diff> oaicompat_msg_diffs;
  597. virtual int get_index() override {
  598. return index;
  599. }
  600. virtual bool is_stop() override {
  601. return true; // in stream mode, final responses are considered stop
  602. }
  603. virtual json to_json() override {
  604. switch (oaicompat) {
  605. case OAICOMPAT_TYPE_NONE:
  606. return to_json_non_oaicompat();
  607. case OAICOMPAT_TYPE_COMPLETION:
  608. return to_json_oaicompat();
  609. case OAICOMPAT_TYPE_CHAT:
  610. return stream ? to_json_oaicompat_chat_stream() : to_json_oaicompat_chat();
  611. default:
  612. GGML_ASSERT(false && "Invalid oaicompat_type");
  613. }
  614. }
  615. json to_json_non_oaicompat() {
  616. json res = json {
  617. {"index", index},
  618. {"content", stream ? "" : content}, // in stream mode, content is already in last partial chunk
  619. {"tokens", stream ? llama_tokens {} : tokens},
  620. {"id_slot", id_slot},
  621. {"stop", true},
  622. {"model", oaicompat_model},
  623. {"tokens_predicted", n_decoded},
  624. {"tokens_evaluated", n_prompt_tokens},
  625. {"generation_settings", generation_params.to_json()},
  626. {"prompt", prompt},
  627. {"has_new_line", has_new_line},
  628. {"truncated", truncated},
  629. {"stop_type", stop_type_to_str(stop)},
  630. {"stopping_word", stopping_word},
  631. {"tokens_cached", n_tokens_cached},
  632. {"timings", timings.to_json()},
  633. };
  634. if (!stream && !probs_output.empty()) {
  635. res["completion_probabilities"] = completion_token_output::probs_vector_to_json(probs_output, post_sampling_probs);
  636. }
  637. return response_fields.empty() ? res : json_get_nested_values(response_fields, res);
  638. }
  639. json to_json_oaicompat() {
  640. std::time_t t = std::time(0);
  641. json logprobs = json(nullptr); // OAI default to null
  642. if (!stream && probs_output.size() > 0) {
  643. logprobs = json{
  644. {"content", completion_token_output::probs_vector_to_json(probs_output, post_sampling_probs)},
  645. };
  646. }
  647. json finish_reason = "length";
  648. if (stop == STOP_TYPE_WORD || stop == STOP_TYPE_EOS) {
  649. finish_reason = "stop";
  650. }
  651. json res = json {
  652. {"choices", json::array({
  653. json{
  654. {"text", stream ? "" : content}, // in stream mode, content is already in last partial chunk
  655. {"index", index},
  656. {"logprobs", logprobs},
  657. {"finish_reason", finish_reason},
  658. }
  659. })},
  660. {"created", t},
  661. {"model", oaicompat_model},
  662. {"system_fingerprint", build_info},
  663. {"object", "text_completion"},
  664. {"usage", json {
  665. {"completion_tokens", n_decoded},
  666. {"prompt_tokens", n_prompt_tokens},
  667. {"total_tokens", n_decoded + n_prompt_tokens}
  668. }},
  669. {"id", oaicompat_cmpl_id}
  670. };
  671. // extra fields for debugging purposes
  672. if (verbose) {
  673. res["__verbose"] = to_json_non_oaicompat();
  674. }
  675. if (timings.prompt_n >= 0) {
  676. res.push_back({"timings", timings.to_json()});
  677. }
  678. return res;
  679. }
  680. json to_json_oaicompat_chat() {
  681. std::string finish_reason = "length";
  682. common_chat_msg msg;
  683. if (!oaicompat_msg.empty()) {
  684. msg = oaicompat_msg;
  685. } else {
  686. msg.role = "assistant";
  687. msg.content = content;
  688. }
  689. if (stop == STOP_TYPE_WORD || stop == STOP_TYPE_EOS) {
  690. finish_reason = msg.tool_calls.empty() ? "stop" : "tool_calls";
  691. }
  692. json choice {
  693. {"finish_reason", finish_reason},
  694. {"index", 0},
  695. {"message", msg.to_json_oaicompat<json>()},
  696. };
  697. if (!stream && probs_output.size() > 0) {
  698. choice["logprobs"] = json{
  699. {"content", completion_token_output::probs_vector_to_json(probs_output, post_sampling_probs)},
  700. };
  701. }
  702. std::time_t t = std::time(0);
  703. json res = json {
  704. {"choices", json::array({choice})},
  705. {"created", t},
  706. {"model", oaicompat_model},
  707. {"system_fingerprint", build_info},
  708. {"object", "chat.completion"},
  709. {"usage", json {
  710. {"completion_tokens", n_decoded},
  711. {"prompt_tokens", n_prompt_tokens},
  712. {"total_tokens", n_decoded + n_prompt_tokens}
  713. }},
  714. {"id", oaicompat_cmpl_id}
  715. };
  716. // extra fields for debugging purposes
  717. if (verbose) {
  718. res["__verbose"] = to_json_non_oaicompat();
  719. }
  720. if (timings.prompt_n >= 0) {
  721. res.push_back({"timings", timings.to_json()});
  722. }
  723. return res;
  724. }
  725. json to_json_oaicompat_chat_stream() {
  726. std::time_t t = std::time(0);
  727. std::string finish_reason = "length";
  728. if (stop == STOP_TYPE_WORD || stop == STOP_TYPE_EOS) {
  729. finish_reason = oaicompat_msg.tool_calls.empty() ? "stop" : "tool_calls";
  730. }
  731. json deltas = json::array();
  732. for (const auto & diff : oaicompat_msg_diffs) {
  733. deltas.push_back({
  734. {"choices", json::array({
  735. json {
  736. {"finish_reason", nullptr},
  737. {"index", 0},
  738. {"delta", common_chat_msg_diff_to_json_oaicompat<json>(diff)},
  739. },
  740. })},
  741. {"created", t},
  742. {"id", oaicompat_cmpl_id},
  743. {"model", oaicompat_model},
  744. {"system_fingerprint", build_info},
  745. {"object", "chat.completion.chunk"},
  746. });
  747. }
  748. deltas.push_back({
  749. {"choices", json::array({
  750. json {
  751. {"finish_reason", finish_reason},
  752. {"index", 0},
  753. {"delta", json::object()},
  754. },
  755. })},
  756. {"created", t},
  757. {"id", oaicompat_cmpl_id},
  758. {"model", oaicompat_model},
  759. {"system_fingerprint", build_info},
  760. {"object", "chat.completion.chunk"},
  761. {"usage", json {
  762. {"completion_tokens", n_decoded},
  763. {"prompt_tokens", n_prompt_tokens},
  764. {"total_tokens", n_decoded + n_prompt_tokens},
  765. }},
  766. });
  767. if (timings.prompt_n >= 0) {
  768. deltas.back().push_back({"timings", timings.to_json()});
  769. }
  770. // extra fields for debugging purposes
  771. if (verbose && !deltas.empty()) {
  772. deltas.front()["__verbose"] = to_json_non_oaicompat();
  773. }
  774. return deltas;
  775. }
  776. };
  777. struct server_task_result_cmpl_partial : server_task_result {
  778. int index = 0;
  779. std::string content;
  780. llama_tokens tokens;
  781. int32_t n_decoded;
  782. int32_t n_prompt_tokens;
  783. bool post_sampling_probs;
  784. completion_token_output prob_output;
  785. result_timings timings;
  786. // OAI-compat fields
  787. bool verbose = false;
  788. oaicompat_type oaicompat = OAICOMPAT_TYPE_NONE;
  789. std::string oaicompat_model;
  790. std::string oaicompat_cmpl_id;
  791. std::vector<common_chat_msg_diff> oaicompat_msg_diffs;
  792. virtual int get_index() override {
  793. return index;
  794. }
  795. virtual bool is_stop() override {
  796. return false; // in stream mode, partial responses are not considered stop
  797. }
  798. virtual json to_json() override {
  799. switch (oaicompat) {
  800. case OAICOMPAT_TYPE_NONE:
  801. return to_json_non_oaicompat();
  802. case OAICOMPAT_TYPE_COMPLETION:
  803. return to_json_oaicompat();
  804. case OAICOMPAT_TYPE_CHAT:
  805. return to_json_oaicompat_chat();
  806. default:
  807. GGML_ASSERT(false && "Invalid oaicompat_type");
  808. }
  809. }
  810. json to_json_non_oaicompat() {
  811. // non-OAI-compat JSON
  812. json res = json {
  813. {"index", index},
  814. {"content", content},
  815. {"tokens", tokens},
  816. {"stop", false},
  817. {"id_slot", id_slot},
  818. {"tokens_predicted", n_decoded},
  819. {"tokens_evaluated", n_prompt_tokens},
  820. };
  821. // populate the timings object when needed (usually for the last response or with timings_per_token enabled)
  822. if (timings.prompt_n > 0) {
  823. res.push_back({"timings", timings.to_json()});
  824. }
  825. if (!prob_output.probs.empty()) {
  826. res["completion_probabilities"] = completion_token_output::probs_vector_to_json({prob_output}, post_sampling_probs);
  827. }
  828. return res;
  829. }
  830. json to_json_oaicompat() {
  831. std::time_t t = std::time(0);
  832. json logprobs = json(nullptr); // OAI default to null
  833. if (prob_output.probs.size() > 0) {
  834. logprobs = json{
  835. {"content", completion_token_output::probs_vector_to_json({prob_output}, post_sampling_probs)},
  836. };
  837. }
  838. json res = json {
  839. {"choices", json::array({
  840. json{
  841. {"text", content},
  842. {"index", index},
  843. {"logprobs", logprobs},
  844. {"finish_reason", nullptr},
  845. }
  846. })},
  847. {"created", t},
  848. {"model", oaicompat_model},
  849. {"system_fingerprint", build_info},
  850. {"object", "text_completion"},
  851. {"id", oaicompat_cmpl_id}
  852. };
  853. // extra fields for debugging purposes
  854. if (verbose) {
  855. res["__verbose"] = to_json_non_oaicompat();
  856. }
  857. if (timings.prompt_n >= 0) {
  858. res.push_back({"timings", timings.to_json()});
  859. }
  860. return res;
  861. }
  862. json to_json_oaicompat_chat() {
  863. bool first = n_decoded == 1;
  864. std::time_t t = std::time(0);
  865. json choices;
  866. std::vector<json> deltas;
  867. auto add_delta = [&](const json & delta) {
  868. deltas.push_back({
  869. {"choices", json::array({
  870. json {
  871. {"finish_reason", nullptr},
  872. {"index", 0},
  873. {"delta", delta},
  874. },
  875. })},
  876. {"created", t},
  877. {"id", oaicompat_cmpl_id},
  878. {"model", oaicompat_model},
  879. {"system_fingerprint", build_info},
  880. {"object", "chat.completion.chunk"},
  881. });
  882. };
  883. // We have to send an initial update to conform to openai behavior
  884. if (first) {
  885. add_delta({
  886. {"role", "assistant"},
  887. {"content", nullptr},
  888. });
  889. }
  890. for (const auto & diff : oaicompat_msg_diffs) {
  891. add_delta(common_chat_msg_diff_to_json_oaicompat<json>(diff));
  892. }
  893. if (!deltas.empty()) {
  894. GGML_ASSERT(deltas[deltas.size() - 1].at("choices").size() >= 1);
  895. if (prob_output.probs.size() > 0) {
  896. deltas[deltas.size() - 1].at("choices").at(0)["logprobs"] = json {
  897. {"content", completion_token_output::probs_vector_to_json({prob_output}, post_sampling_probs)},
  898. };
  899. }
  900. if (timings.prompt_n >= 0) {
  901. deltas[deltas.size() - 1].push_back({"timings", timings.to_json()});
  902. }
  903. }
  904. return deltas;
  905. }
  906. };
  907. struct server_task_result_embd : server_task_result {
  908. int index = 0;
  909. std::vector<std::vector<float>> embedding;
  910. int32_t n_tokens;
  911. // OAI-compat fields
  912. oaicompat_type oaicompat = OAICOMPAT_TYPE_NONE;
  913. virtual int get_index() override {
  914. return index;
  915. }
  916. virtual json to_json() override {
  917. return oaicompat == OAICOMPAT_TYPE_EMBEDDING
  918. ? to_json_oaicompat()
  919. : to_json_non_oaicompat();
  920. }
  921. json to_json_non_oaicompat() {
  922. return json {
  923. {"index", index},
  924. {"embedding", embedding},
  925. };
  926. }
  927. json to_json_oaicompat() {
  928. return json {
  929. {"index", index},
  930. {"embedding", embedding[0]},
  931. {"tokens_evaluated", n_tokens},
  932. };
  933. }
  934. };
  935. struct server_task_result_rerank : server_task_result {
  936. int index = 0;
  937. float score = -1e6;
  938. int32_t n_tokens;
  939. virtual int get_index() override {
  940. return index;
  941. }
  942. virtual json to_json() override {
  943. return json {
  944. {"index", index},
  945. {"score", score},
  946. {"tokens_evaluated", n_tokens},
  947. };
  948. }
  949. };
  950. // this function maybe used outside of server_task_result_error
  951. static json format_error_response(const std::string & message, const enum error_type type) {
  952. std::string type_str;
  953. int code = 500;
  954. switch (type) {
  955. case ERROR_TYPE_INVALID_REQUEST:
  956. type_str = "invalid_request_error";
  957. code = 400;
  958. break;
  959. case ERROR_TYPE_AUTHENTICATION:
  960. type_str = "authentication_error";
  961. code = 401;
  962. break;
  963. case ERROR_TYPE_NOT_FOUND:
  964. type_str = "not_found_error";
  965. code = 404;
  966. break;
  967. case ERROR_TYPE_SERVER:
  968. type_str = "server_error";
  969. code = 500;
  970. break;
  971. case ERROR_TYPE_PERMISSION:
  972. type_str = "permission_error";
  973. code = 403;
  974. break;
  975. case ERROR_TYPE_NOT_SUPPORTED:
  976. type_str = "not_supported_error";
  977. code = 501;
  978. break;
  979. case ERROR_TYPE_UNAVAILABLE:
  980. type_str = "unavailable_error";
  981. code = 503;
  982. break;
  983. }
  984. return json {
  985. {"code", code},
  986. {"message", message},
  987. {"type", type_str},
  988. };
  989. }
  990. struct server_task_result_error : server_task_result {
  991. int index = 0;
  992. error_type err_type = ERROR_TYPE_SERVER;
  993. std::string err_msg;
  994. virtual bool is_error() override {
  995. return true;
  996. }
  997. virtual json to_json() override {
  998. return format_error_response(err_msg, err_type);
  999. }
  1000. };
  1001. struct server_task_result_metrics : server_task_result {
  1002. int n_idle_slots;
  1003. int n_processing_slots;
  1004. int n_tasks_deferred;
  1005. int64_t t_start;
  1006. // TODO: somehow reuse server_metrics in the future, instead of duplicating the fields
  1007. uint64_t n_prompt_tokens_processed_total = 0;
  1008. uint64_t t_prompt_processing_total = 0;
  1009. uint64_t n_tokens_predicted_total = 0;
  1010. uint64_t t_tokens_generation_total = 0;
  1011. uint64_t n_prompt_tokens_processed = 0;
  1012. uint64_t t_prompt_processing = 0;
  1013. uint64_t n_tokens_predicted = 0;
  1014. uint64_t t_tokens_generation = 0;
  1015. uint64_t n_decode_total = 0;
  1016. uint64_t n_busy_slots_total = 0;
  1017. // while we can also use std::vector<server_slot> this requires copying the slot object which can be quite messy
  1018. // therefore, we use json to temporarily store the slot.to_json() result
  1019. json slots_data = json::array();
  1020. virtual json to_json() override {
  1021. return json {
  1022. { "idle", n_idle_slots },
  1023. { "processing", n_processing_slots },
  1024. { "deferred", n_tasks_deferred },
  1025. { "t_start", t_start },
  1026. { "n_prompt_tokens_processed_total", n_prompt_tokens_processed_total },
  1027. { "t_tokens_generation_total", t_tokens_generation_total },
  1028. { "n_tokens_predicted_total", n_tokens_predicted_total },
  1029. { "t_prompt_processing_total", t_prompt_processing_total },
  1030. { "n_prompt_tokens_processed", n_prompt_tokens_processed },
  1031. { "t_prompt_processing", t_prompt_processing },
  1032. { "n_tokens_predicted", n_tokens_predicted },
  1033. { "t_tokens_generation", t_tokens_generation },
  1034. { "n_decode_total", n_decode_total },
  1035. { "n_busy_slots_total", n_busy_slots_total },
  1036. { "slots", slots_data },
  1037. };
  1038. }
  1039. };
  1040. struct server_task_result_slot_save_load : server_task_result {
  1041. std::string filename;
  1042. bool is_save; // true = save, false = load
  1043. size_t n_tokens;
  1044. size_t n_bytes;
  1045. double t_ms;
  1046. virtual json to_json() override {
  1047. if (is_save) {
  1048. return json {
  1049. { "id_slot", id_slot },
  1050. { "filename", filename },
  1051. { "n_saved", n_tokens },
  1052. { "n_written", n_bytes },
  1053. { "timings", {
  1054. { "save_ms", t_ms }
  1055. }},
  1056. };
  1057. } else {
  1058. return json {
  1059. { "id_slot", id_slot },
  1060. { "filename", filename },
  1061. { "n_restored", n_tokens },
  1062. { "n_read", n_bytes },
  1063. { "timings", {
  1064. { "restore_ms", t_ms }
  1065. }},
  1066. };
  1067. }
  1068. }
  1069. };
  1070. struct server_task_result_slot_erase : server_task_result {
  1071. size_t n_erased;
  1072. virtual json to_json() override {
  1073. return json {
  1074. { "id_slot", id_slot },
  1075. { "n_erased", n_erased },
  1076. };
  1077. }
  1078. };
  1079. struct server_task_result_apply_lora : server_task_result {
  1080. virtual json to_json() override {
  1081. return json {{ "success", true }};
  1082. }
  1083. };
  1084. struct server_slot {
  1085. int id;
  1086. int id_task = -1;
  1087. // only used for completion/embedding/infill/rerank
  1088. server_task_type task_type = SERVER_TASK_TYPE_COMPLETION;
  1089. llama_batch batch_spec = {};
  1090. llama_context * ctx = nullptr;
  1091. llama_context * ctx_dft = nullptr;
  1092. // multimodal
  1093. mtmd_context * mctx = nullptr;
  1094. common_speculative * spec = nullptr;
  1095. std::vector<common_adapter_lora_info> lora;
  1096. // the index relative to completion multi-task request
  1097. size_t index = 0;
  1098. struct slot_params params;
  1099. slot_state state = SLOT_STATE_IDLE;
  1100. // used to determine the slot that has been used the longest
  1101. int64_t t_last_used = -1;
  1102. // generation props
  1103. int32_t n_ctx = 0; // context size per slot
  1104. int32_t n_past = 0;
  1105. int32_t n_decoded = 0;
  1106. int32_t n_remaining = -1;
  1107. int32_t i_batch = -1;
  1108. int32_t n_predict = -1; // TODO: disambiguate from params.n_predict
  1109. // n_prompt_tokens may not be equal to prompt_tokens.size(), because prompt maybe truncated
  1110. int32_t n_prompt_tokens = 0;
  1111. int32_t n_prompt_tokens_processed = 0;
  1112. // input prompt tokens
  1113. server_tokens prompt_tokens;
  1114. size_t last_nl_pos = 0;
  1115. std::string generated_text;
  1116. llama_tokens generated_tokens;
  1117. common_chat_msg chat_msg;
  1118. server_tokens cache_tokens;
  1119. std::vector<completion_token_output> generated_token_probs;
  1120. bool has_next_token = true;
  1121. bool has_new_line = false;
  1122. bool truncated = false;
  1123. stop_type stop;
  1124. std::string stopping_word;
  1125. // sampling
  1126. json json_schema;
  1127. struct common_sampler * smpl = nullptr;
  1128. llama_token sampled;
  1129. common_chat_format chat_format = COMMON_CHAT_FORMAT_CONTENT_ONLY;
  1130. std::vector<std::string> generated_tool_call_ids;
  1131. // stats
  1132. size_t n_sent_text = 0; // number of sent text character
  1133. int64_t t_start_process_prompt;
  1134. int64_t t_start_generation;
  1135. double t_prompt_processing; // ms
  1136. double t_token_generation; // ms
  1137. std::function<void(int)> callback_on_release;
  1138. // Speculative decoding stats
  1139. int32_t n_draft_total = 0; // Total draft tokens generated
  1140. int32_t n_draft_accepted = 0; // Draft tokens actually accepted
  1141. void reset() {
  1142. SLT_DBG(*this, "%s", "\n");
  1143. n_prompt_tokens = 0;
  1144. last_nl_pos = 0;
  1145. generated_text = "";
  1146. has_new_line = false;
  1147. truncated = false;
  1148. stop = STOP_TYPE_NONE;
  1149. stopping_word = "";
  1150. n_past = 0;
  1151. n_sent_text = 0;
  1152. task_type = SERVER_TASK_TYPE_COMPLETION;
  1153. chat_format = COMMON_CHAT_FORMAT_CONTENT_ONLY;
  1154. generated_tokens.clear();
  1155. generated_token_probs.clear();
  1156. chat_msg = {};
  1157. json_schema = json();
  1158. generated_tool_call_ids.clear();
  1159. // clear speculative decoding stats
  1160. n_draft_total = 0;
  1161. n_draft_accepted = 0;
  1162. }
  1163. bool need_embd() const {
  1164. return server_task_type_need_embd(task_type);
  1165. }
  1166. bool need_logits() const {
  1167. return server_task_type_need_logits(task_type);
  1168. }
  1169. // if the context does not have a memory module then all embeddings have to be computed within a single ubatch
  1170. // also we cannot split if the pooling would require any past tokens
  1171. bool can_split() const {
  1172. return
  1173. !need_embd() ||
  1174. (llama_get_memory(ctx) && llama_pooling_type(ctx) == LLAMA_POOLING_TYPE_LAST);
  1175. }
  1176. bool can_batch_with(server_slot & other_slot) const {
  1177. return task_type == other_slot.task_type && are_lora_equal(lora, other_slot.lora);
  1178. }
  1179. bool has_budget(const common_params & global_params) {
  1180. if (params.n_predict == -1 && global_params.n_predict == -1) {
  1181. return true; // limitless
  1182. }
  1183. n_remaining = -1;
  1184. if (params.n_predict != -1) {
  1185. n_remaining = params.n_predict - n_decoded;
  1186. } else if (global_params.n_predict != -1) {
  1187. n_remaining = global_params.n_predict - n_decoded;
  1188. }
  1189. return n_remaining > 0; // no budget
  1190. }
  1191. bool is_processing() const {
  1192. return state != SLOT_STATE_IDLE;
  1193. }
  1194. bool can_speculate() const {
  1195. return ctx_dft && params.speculative.n_max > 0 && params.cache_prompt;
  1196. }
  1197. void add_token(const completion_token_output & token) {
  1198. if (!is_processing()) {
  1199. SLT_WRN(*this, "%s", "slot is not processing\n");
  1200. return;
  1201. }
  1202. generated_token_probs.push_back(token);
  1203. }
  1204. void release() {
  1205. if (is_processing()) {
  1206. SLT_INF(*this, "stop processing: n_past = %d, truncated = %d\n", n_past, truncated);
  1207. t_last_used = ggml_time_us();
  1208. t_token_generation = (ggml_time_us() - t_start_generation) / 1e3;
  1209. state = SLOT_STATE_IDLE;
  1210. callback_on_release(id);
  1211. }
  1212. }
  1213. result_timings get_timings() const {
  1214. result_timings timings;
  1215. timings.prompt_n = n_prompt_tokens_processed;
  1216. timings.prompt_ms = t_prompt_processing;
  1217. timings.prompt_per_token_ms = t_prompt_processing / n_prompt_tokens_processed;
  1218. timings.prompt_per_second = 1e3 / t_prompt_processing * n_prompt_tokens_processed;
  1219. timings.predicted_n = n_decoded;
  1220. timings.predicted_ms = t_token_generation;
  1221. timings.predicted_per_token_ms = t_token_generation / n_decoded;
  1222. timings.predicted_per_second = 1e3 / t_token_generation * n_decoded;
  1223. // Add speculative metrics
  1224. if (n_draft_total > 0) {
  1225. timings.draft_n = n_draft_total;
  1226. timings.draft_n_accepted = n_draft_accepted;
  1227. }
  1228. return timings;
  1229. }
  1230. const common_chat_msg & update_chat_msg(std::vector<common_chat_msg_diff> & diffs) {
  1231. auto previous_msg = chat_msg;
  1232. SRV_DBG("Parsing chat message: %s\n", generated_text.c_str());
  1233. auto new_msg = common_chat_parse(
  1234. generated_text,
  1235. /* is_partial= */ stop != STOP_TYPE_EOS,
  1236. params.oaicompat_chat_syntax);
  1237. if (!new_msg.empty()) {
  1238. new_msg.ensure_tool_call_ids_set(generated_tool_call_ids, gen_tool_call_id);
  1239. chat_msg = new_msg;
  1240. diffs = common_chat_msg_diff::compute_diffs(previous_msg, new_msg.empty() ? previous_msg : new_msg);
  1241. }
  1242. return chat_msg;
  1243. }
  1244. size_t find_stopping_strings(const std::string & text, const size_t last_token_size, bool is_full_stop) {
  1245. size_t stop_pos = std::string::npos;
  1246. for (const std::string & word : params.antiprompt) {
  1247. size_t pos;
  1248. if (is_full_stop) {
  1249. const size_t tmp = word.size() + last_token_size;
  1250. const size_t from_pos = text.size() > tmp ? text.size() - tmp : 0;
  1251. pos = text.find(word, from_pos);
  1252. } else {
  1253. // otherwise, partial stop
  1254. pos = string_find_partial_stop(text, word);
  1255. }
  1256. if (pos != std::string::npos && (stop_pos == std::string::npos || pos < stop_pos)) {
  1257. if (is_full_stop) {
  1258. stop = STOP_TYPE_WORD;
  1259. stopping_word = word;
  1260. has_next_token = false;
  1261. }
  1262. stop_pos = pos;
  1263. }
  1264. }
  1265. return stop_pos;
  1266. }
  1267. void print_timings() const {
  1268. const double t_prompt = t_prompt_processing / n_prompt_tokens_processed;
  1269. const double n_prompt_second = 1e3 / t_prompt_processing * n_prompt_tokens_processed;
  1270. const double t_gen = t_token_generation / n_decoded;
  1271. const double n_gen_second = 1e3 / t_token_generation * n_decoded;
  1272. SLT_INF(*this,
  1273. "\n"
  1274. "prompt eval time = %10.2f ms / %5d tokens (%8.2f ms per token, %8.2f tokens per second)\n"
  1275. " eval time = %10.2f ms / %5d tokens (%8.2f ms per token, %8.2f tokens per second)\n"
  1276. " total time = %10.2f ms / %5d tokens\n",
  1277. t_prompt_processing, n_prompt_tokens_processed, t_prompt, n_prompt_second,
  1278. t_token_generation, n_decoded, t_gen, n_gen_second,
  1279. t_prompt_processing + t_token_generation, n_prompt_tokens_processed + n_decoded);
  1280. if (n_draft_total > 0) {
  1281. const float draft_ratio = (float) n_draft_accepted / n_draft_total;
  1282. SLT_INF(*this,
  1283. "\n"
  1284. "draft acceptance rate = %0.5f (%5d accepted / %5d generated)\n",
  1285. draft_ratio, n_draft_accepted, n_draft_total
  1286. );
  1287. }
  1288. }
  1289. json to_json() const {
  1290. return json {
  1291. {"id", id},
  1292. {"id_task", id_task},
  1293. {"n_ctx", n_ctx},
  1294. {"speculative", can_speculate()},
  1295. {"is_processing", is_processing()},
  1296. {"params", params.to_json()},
  1297. {"prompt", prompt_tokens.detokenize(ctx, true)},
  1298. {"next_token",
  1299. {
  1300. {"has_next_token", has_next_token},
  1301. {"has_new_line", has_new_line},
  1302. {"n_remain", n_remaining},
  1303. {"n_decoded", n_decoded},
  1304. {"stopping_word", stopping_word},
  1305. }
  1306. },
  1307. };
  1308. }
  1309. };
  1310. struct server_metrics {
  1311. int64_t t_start = 0;
  1312. uint64_t n_prompt_tokens_processed_total = 0;
  1313. uint64_t t_prompt_processing_total = 0;
  1314. uint64_t n_tokens_predicted_total = 0;
  1315. uint64_t t_tokens_generation_total = 0;
  1316. uint64_t n_prompt_tokens_processed = 0;
  1317. uint64_t t_prompt_processing = 0;
  1318. uint64_t n_tokens_predicted = 0;
  1319. uint64_t t_tokens_generation = 0;
  1320. uint64_t n_decode_total = 0;
  1321. uint64_t n_busy_slots_total = 0;
  1322. void init() {
  1323. t_start = ggml_time_us();
  1324. }
  1325. void on_prompt_eval(const server_slot & slot) {
  1326. n_prompt_tokens_processed_total += slot.n_prompt_tokens_processed;
  1327. n_prompt_tokens_processed += slot.n_prompt_tokens_processed;
  1328. t_prompt_processing += slot.t_prompt_processing;
  1329. t_prompt_processing_total += slot.t_prompt_processing;
  1330. }
  1331. void on_prediction(const server_slot & slot) {
  1332. n_tokens_predicted_total += slot.n_decoded;
  1333. n_tokens_predicted += slot.n_decoded;
  1334. t_tokens_generation += slot.t_token_generation;
  1335. t_tokens_generation_total += slot.t_token_generation;
  1336. }
  1337. void on_decoded(const std::vector<server_slot> & slots) {
  1338. n_decode_total++;
  1339. for (const auto & slot : slots) {
  1340. if (slot.is_processing()) {
  1341. n_busy_slots_total++;
  1342. }
  1343. }
  1344. }
  1345. void reset_bucket() {
  1346. n_prompt_tokens_processed = 0;
  1347. t_prompt_processing = 0;
  1348. n_tokens_predicted = 0;
  1349. t_tokens_generation = 0;
  1350. }
  1351. };
  1352. struct server_queue {
  1353. int id = 0;
  1354. bool running;
  1355. // queues
  1356. std::deque<server_task> queue_tasks;
  1357. std::deque<server_task> queue_tasks_deferred;
  1358. std::mutex mutex_tasks;
  1359. std::condition_variable condition_tasks;
  1360. // callback functions
  1361. std::function<void(server_task &&)> callback_new_task;
  1362. std::function<void(void)> callback_update_slots;
  1363. // Add a new task to the end of the queue
  1364. int post(server_task && task, bool front = false) {
  1365. std::unique_lock<std::mutex> lock(mutex_tasks);
  1366. GGML_ASSERT(task.id != -1);
  1367. // if this is cancel task make sure to clean up pending tasks
  1368. if (task.type == SERVER_TASK_TYPE_CANCEL) {
  1369. cleanup_pending_task(task.id_target);
  1370. }
  1371. const int task_id = task.id;
  1372. QUE_DBG("new task, id = %d, front = %d\n", task_id, front);
  1373. if (front) {
  1374. queue_tasks.push_front(std::move(task));
  1375. } else {
  1376. queue_tasks.push_back(std::move(task));
  1377. }
  1378. condition_tasks.notify_one();
  1379. return task_id;
  1380. }
  1381. // multi-task version of post()
  1382. int post(std::vector<server_task> && tasks, bool front = false) {
  1383. std::unique_lock<std::mutex> lock(mutex_tasks);
  1384. for (auto & task : tasks) {
  1385. if (task.id == -1) {
  1386. task.id = id++;
  1387. }
  1388. // if this is cancel task make sure to clean up pending tasks
  1389. if (task.type == SERVER_TASK_TYPE_CANCEL) {
  1390. cleanup_pending_task(task.id_target);
  1391. }
  1392. QUE_DBG("new task, id = %d/%d, front = %d\n", task.id, (int) tasks.size(), front);
  1393. if (front) {
  1394. queue_tasks.push_front(std::move(task));
  1395. } else {
  1396. queue_tasks.push_back(std::move(task));
  1397. }
  1398. }
  1399. condition_tasks.notify_one();
  1400. return 0;
  1401. }
  1402. // Add a new task, but defer until one slot is available
  1403. void defer(server_task && task) {
  1404. std::unique_lock<std::mutex> lock(mutex_tasks);
  1405. QUE_DBG("defer task, id = %d\n", task.id);
  1406. queue_tasks_deferred.push_back(std::move(task));
  1407. condition_tasks.notify_one();
  1408. }
  1409. // Get the next id for creating a new task
  1410. int get_new_id() {
  1411. std::unique_lock<std::mutex> lock(mutex_tasks);
  1412. int new_id = id++;
  1413. return new_id;
  1414. }
  1415. // Register function to process a new task
  1416. void on_new_task(std::function<void(server_task &&)> callback) {
  1417. callback_new_task = std::move(callback);
  1418. }
  1419. // Register the function to be called when all slots data is ready to be processed
  1420. void on_update_slots(std::function<void(void)> callback) {
  1421. callback_update_slots = std::move(callback);
  1422. }
  1423. // Call when the state of one slot is changed, it will move one task from deferred to main queue
  1424. void pop_deferred_task() {
  1425. std::unique_lock<std::mutex> lock(mutex_tasks);
  1426. if (!queue_tasks_deferred.empty()) {
  1427. queue_tasks.emplace_back(std::move(queue_tasks_deferred.front()));
  1428. queue_tasks_deferred.pop_front();
  1429. }
  1430. condition_tasks.notify_one();
  1431. }
  1432. // end the start_loop routine
  1433. void terminate() {
  1434. std::unique_lock<std::mutex> lock(mutex_tasks);
  1435. running = false;
  1436. condition_tasks.notify_all();
  1437. }
  1438. /**
  1439. * Main loop consists of these steps:
  1440. * - Wait until a new task arrives
  1441. * - Process the task (i.e. maybe copy data into slot)
  1442. * - Check if multitask is finished
  1443. * - Update all slots
  1444. */
  1445. void start_loop() {
  1446. running = true;
  1447. while (true) {
  1448. QUE_DBG("%s", "processing new tasks\n");
  1449. while (true) {
  1450. std::unique_lock<std::mutex> lock(mutex_tasks);
  1451. if (!running) {
  1452. QUE_DBG("%s", "terminate\n");
  1453. return;
  1454. }
  1455. if (queue_tasks.empty()) {
  1456. lock.unlock();
  1457. break;
  1458. }
  1459. server_task task = std::move(queue_tasks.front());
  1460. queue_tasks.pop_front();
  1461. lock.unlock();
  1462. QUE_DBG("processing task, id = %d\n", task.id);
  1463. callback_new_task(std::move(task));
  1464. }
  1465. // all tasks in the current loop is processed, slots data is now ready
  1466. QUE_DBG("%s", "update slots\n");
  1467. callback_update_slots();
  1468. QUE_DBG("%s", "waiting for new tasks\n");
  1469. {
  1470. std::unique_lock<std::mutex> lock(mutex_tasks);
  1471. if (!running) {
  1472. QUE_DBG("%s", "terminate\n");
  1473. return;
  1474. }
  1475. if (queue_tasks.empty()) {
  1476. condition_tasks.wait(lock, [&]{
  1477. return (!queue_tasks.empty() || !running);
  1478. });
  1479. }
  1480. }
  1481. }
  1482. }
  1483. private:
  1484. void cleanup_pending_task(int id_target) {
  1485. // no need lock because this is called exclusively by post()
  1486. auto rm_func = [id_target](const server_task & task) {
  1487. return task.id_target == id_target;
  1488. };
  1489. queue_tasks.erase(
  1490. std::remove_if(queue_tasks.begin(), queue_tasks.end(), rm_func),
  1491. queue_tasks.end());
  1492. queue_tasks_deferred.erase(
  1493. std::remove_if(queue_tasks_deferred.begin(), queue_tasks_deferred.end(), rm_func),
  1494. queue_tasks_deferred.end());
  1495. }
  1496. };
  1497. struct server_response {
  1498. bool running = true;
  1499. // for keeping track of all tasks waiting for the result
  1500. std::unordered_set<int> waiting_task_ids;
  1501. // the main result queue (using ptr for polymorphism)
  1502. std::vector<server_task_result_ptr> queue_results;
  1503. std::mutex mutex_results;
  1504. std::condition_variable condition_results;
  1505. // add the id_task to the list of tasks waiting for response
  1506. void add_waiting_task_id(int id_task) {
  1507. SRV_DBG("add task %d to waiting list. current waiting = %d (before add)\n", id_task, (int) waiting_task_ids.size());
  1508. std::unique_lock<std::mutex> lock(mutex_results);
  1509. waiting_task_ids.insert(id_task);
  1510. }
  1511. void add_waiting_tasks(const std::vector<server_task> & tasks) {
  1512. std::unique_lock<std::mutex> lock(mutex_results);
  1513. for (const auto & task : tasks) {
  1514. SRV_DBG("add task %d to waiting list. current waiting = %d (before add)\n", task.id, (int) waiting_task_ids.size());
  1515. waiting_task_ids.insert(task.id);
  1516. }
  1517. }
  1518. // when the request is finished, we can remove task associated with it
  1519. void remove_waiting_task_id(int id_task) {
  1520. SRV_DBG("remove task %d from waiting list. current waiting = %d (before remove)\n", id_task, (int) waiting_task_ids.size());
  1521. std::unique_lock<std::mutex> lock(mutex_results);
  1522. waiting_task_ids.erase(id_task);
  1523. // make sure to clean up all pending results
  1524. queue_results.erase(
  1525. std::remove_if(queue_results.begin(), queue_results.end(), [id_task](const server_task_result_ptr & res) {
  1526. return res->id == id_task;
  1527. }),
  1528. queue_results.end());
  1529. }
  1530. void remove_waiting_task_ids(const std::unordered_set<int> & id_tasks) {
  1531. std::unique_lock<std::mutex> lock(mutex_results);
  1532. for (const auto & id_task : id_tasks) {
  1533. SRV_DBG("remove task %d from waiting list. current waiting = %d (before remove)\n", id_task, (int) waiting_task_ids.size());
  1534. waiting_task_ids.erase(id_task);
  1535. }
  1536. }
  1537. // This function blocks the thread until there is a response for one of the id_tasks
  1538. server_task_result_ptr recv(const std::unordered_set<int> & id_tasks) {
  1539. while (true) {
  1540. std::unique_lock<std::mutex> lock(mutex_results);
  1541. condition_results.wait(lock, [&]{
  1542. if (!running) {
  1543. SRV_DBG("%s : queue result stop\n", __func__);
  1544. std::terminate(); // we cannot return here since the caller is HTTP code
  1545. }
  1546. return !queue_results.empty();
  1547. });
  1548. for (size_t i = 0; i < queue_results.size(); i++) {
  1549. if (id_tasks.find(queue_results[i]->id) != id_tasks.end()) {
  1550. server_task_result_ptr res = std::move(queue_results[i]);
  1551. queue_results.erase(queue_results.begin() + i);
  1552. return res;
  1553. }
  1554. }
  1555. }
  1556. // should never reach here
  1557. }
  1558. // same as recv(), but have timeout in seconds
  1559. // if timeout is reached, nullptr is returned
  1560. server_task_result_ptr recv_with_timeout(const std::unordered_set<int> & id_tasks, int timeout) {
  1561. while (true) {
  1562. std::unique_lock<std::mutex> lock(mutex_results);
  1563. for (int i = 0; i < (int) queue_results.size(); i++) {
  1564. if (id_tasks.find(queue_results[i]->id) != id_tasks.end()) {
  1565. server_task_result_ptr res = std::move(queue_results[i]);
  1566. queue_results.erase(queue_results.begin() + i);
  1567. return res;
  1568. }
  1569. }
  1570. std::cv_status cr_res = condition_results.wait_for(lock, std::chrono::seconds(timeout));
  1571. if (!running) {
  1572. SRV_DBG("%s : queue result stop\n", __func__);
  1573. std::terminate(); // we cannot return here since the caller is HTTP code
  1574. }
  1575. if (cr_res == std::cv_status::timeout) {
  1576. return nullptr;
  1577. }
  1578. }
  1579. // should never reach here
  1580. }
  1581. // single-task version of recv()
  1582. server_task_result_ptr recv(int id_task) {
  1583. std::unordered_set<int> id_tasks = {id_task};
  1584. return recv(id_tasks);
  1585. }
  1586. // Send a new result to a waiting id_task
  1587. void send(server_task_result_ptr && result) {
  1588. SRV_DBG("sending result for task id = %d\n", result->id);
  1589. std::unique_lock<std::mutex> lock(mutex_results);
  1590. for (const auto & id_task : waiting_task_ids) {
  1591. if (result->id == id_task) {
  1592. SRV_DBG("task id = %d pushed to result queue\n", result->id);
  1593. queue_results.emplace_back(std::move(result));
  1594. condition_results.notify_all();
  1595. return;
  1596. }
  1597. }
  1598. }
  1599. // terminate the waiting loop
  1600. void terminate() {
  1601. running = false;
  1602. condition_results.notify_all();
  1603. }
  1604. };
  1605. struct server_context {
  1606. common_params params_base;
  1607. // note: keep these alive - they determine the lifetime of the model, context, etc.
  1608. common_init_result llama_init;
  1609. common_init_result llama_init_dft;
  1610. llama_model * model = nullptr;
  1611. llama_context * ctx = nullptr;
  1612. // multimodal
  1613. mtmd_context * mctx = nullptr;
  1614. const llama_vocab * vocab = nullptr;
  1615. llama_model * model_dft = nullptr;
  1616. llama_context_params cparams_dft;
  1617. llama_batch batch {};
  1618. bool clean_kv_cache = true;
  1619. bool add_bos_token = true;
  1620. bool has_eos_token = false;
  1621. int32_t n_ctx; // total context for all clients / slots
  1622. // slots / clients
  1623. std::vector<server_slot> slots;
  1624. json default_generation_settings_for_props;
  1625. server_queue queue_tasks;
  1626. server_response queue_results;
  1627. server_metrics metrics;
  1628. // Necessary similarity of prompt for slot selection
  1629. float slot_prompt_similarity = 0.0f;
  1630. common_chat_templates_ptr chat_templates;
  1631. oaicompat_parser_options oai_parser_opt;
  1632. ~server_context() {
  1633. mtmd_free(mctx);
  1634. // Clear any sampling context
  1635. for (server_slot & slot : slots) {
  1636. common_sampler_free(slot.smpl);
  1637. slot.smpl = nullptr;
  1638. llama_free(slot.ctx_dft);
  1639. slot.ctx_dft = nullptr;
  1640. common_speculative_free(slot.spec);
  1641. slot.spec = nullptr;
  1642. llama_batch_free(slot.batch_spec);
  1643. }
  1644. llama_batch_free(batch);
  1645. }
  1646. bool load_model(const common_params & params) {
  1647. SRV_INF("loading model '%s'\n", params.model.path.c_str());
  1648. params_base = params;
  1649. llama_init = common_init_from_params(params_base);
  1650. model = llama_init.model.get();
  1651. ctx = llama_init.context.get();
  1652. if (model == nullptr) {
  1653. SRV_ERR("failed to load model, '%s'\n", params_base.model.path.c_str());
  1654. return false;
  1655. }
  1656. vocab = llama_model_get_vocab(model);
  1657. n_ctx = llama_n_ctx(ctx);
  1658. add_bos_token = llama_vocab_get_add_bos(vocab);
  1659. has_eos_token = llama_vocab_eos(vocab) != LLAMA_TOKEN_NULL;
  1660. if (!params_base.speculative.model.path.empty() || !params_base.speculative.model.hf_repo.empty()) {
  1661. SRV_INF("loading draft model '%s'\n", params_base.speculative.model.path.c_str());
  1662. auto params_dft = params_base;
  1663. params_dft.devices = params_base.speculative.devices;
  1664. params_dft.model = params_base.speculative.model;
  1665. params_dft.n_ctx = params_base.speculative.n_ctx == 0 ? params_base.n_ctx / params_base.n_parallel : params_base.speculative.n_ctx;
  1666. params_dft.n_gpu_layers = params_base.speculative.n_gpu_layers;
  1667. params_dft.n_parallel = 1;
  1668. params_dft.cache_type_k = params_base.speculative.cache_type_k;
  1669. params_dft.cache_type_v = params_base.speculative.cache_type_v;
  1670. llama_init_dft = common_init_from_params(params_dft);
  1671. model_dft = llama_init_dft.model.get();
  1672. if (model_dft == nullptr) {
  1673. SRV_ERR("failed to load draft model, '%s'\n", params_base.speculative.model.path.c_str());
  1674. return false;
  1675. }
  1676. if (!common_speculative_are_compatible(ctx, llama_init_dft.context.get())) {
  1677. SRV_ERR("the draft model '%s' is not compatible with the target model '%s'\n", params_base.speculative.model.path.c_str(), params_base.model.path.c_str());
  1678. return false;
  1679. }
  1680. const int n_ctx_dft = llama_n_ctx(llama_init_dft.context.get());
  1681. cparams_dft = common_context_params_to_llama(params_dft);
  1682. cparams_dft.n_batch = n_ctx_dft;
  1683. // the context is not needed - we will create one for each slot
  1684. llama_init_dft.context.reset();
  1685. }
  1686. chat_templates = common_chat_templates_init(model, params_base.chat_template);
  1687. try {
  1688. common_chat_format_example(chat_templates.get(), params.use_jinja);
  1689. } catch (const std::exception & e) {
  1690. SRV_WRN("%s: Chat template parsing error: %s\n", __func__, e.what());
  1691. SRV_WRN("%s: The chat template that comes with this model is not yet supported, falling back to chatml. This may cause the model to output suboptimal responses\n", __func__);
  1692. chat_templates = common_chat_templates_init(model, "chatml");
  1693. }
  1694. std::string & mmproj_path = params_base.mmproj.path;
  1695. if (!mmproj_path.empty()) {
  1696. mtmd_context_params mparams = mtmd_context_params_default();
  1697. mparams.use_gpu = params_base.mmproj_use_gpu;
  1698. mparams.print_timings = false;
  1699. mparams.n_threads = params_base.cpuparams.n_threads;
  1700. mparams.verbosity = params_base.verbosity > 0 ? GGML_LOG_LEVEL_DEBUG : GGML_LOG_LEVEL_INFO;
  1701. mctx = mtmd_init_from_file(mmproj_path.c_str(), model, mparams);
  1702. if (mctx == nullptr) {
  1703. SRV_ERR("failed to load multimodal model, '%s'\n", mmproj_path.c_str());
  1704. return false;
  1705. }
  1706. SRV_INF("loaded multimodal model, '%s'\n", mmproj_path.c_str());
  1707. if (params_base.ctx_shift) {
  1708. params_base.ctx_shift = false;
  1709. SRV_WRN("%s\n", "ctx_shift is not supported by multimodal, it will be disabled");
  1710. }
  1711. if (params_base.n_cache_reuse) {
  1712. params_base.n_cache_reuse = 0;
  1713. SRV_WRN("%s\n", "cache_reuse is not supported by multimodal, it will be disabled");
  1714. }
  1715. if (!params_base.speculative.model.path.empty()) {
  1716. SRV_ERR("%s\n", "err: speculative decode is not supported by multimodal");
  1717. return false;
  1718. }
  1719. }
  1720. if (!llama_memory_can_shift(llama_get_memory(ctx))) {
  1721. if (params_base.ctx_shift) {
  1722. params_base.ctx_shift = false;
  1723. SRV_WRN("%s\n", "ctx_shift is not supported by this context, it will be disabled");
  1724. }
  1725. if (params_base.n_cache_reuse) {
  1726. params_base.n_cache_reuse = 0;
  1727. SRV_WRN("%s\n", "cache_reuse is not supported by this context, it will be disabled");
  1728. }
  1729. }
  1730. return true;
  1731. }
  1732. void init() {
  1733. const int32_t n_ctx_slot = n_ctx / params_base.n_parallel;
  1734. SRV_INF("initializing slots, n_slots = %d\n", params_base.n_parallel);
  1735. for (int i = 0; i < params_base.n_parallel; i++) {
  1736. server_slot slot;
  1737. slot.id = i;
  1738. slot.ctx = ctx;
  1739. slot.n_ctx = n_ctx_slot;
  1740. slot.n_predict = params_base.n_predict;
  1741. slot.mctx = mctx;
  1742. slot.cache_tokens.has_mtmd = mctx != nullptr;
  1743. if (model_dft) {
  1744. slot.batch_spec = llama_batch_init(params_base.speculative.n_max + 1, 0, 1);
  1745. slot.ctx_dft = llama_init_from_model(model_dft, cparams_dft);
  1746. if (slot.ctx_dft == nullptr) {
  1747. SRV_ERR("%s", "failed to create draft context\n");
  1748. return;
  1749. }
  1750. slot.spec = common_speculative_init(slot.ctx_dft);
  1751. if (slot.spec == nullptr) {
  1752. SRV_ERR("%s", "failed to create speculator\n");
  1753. return;
  1754. }
  1755. }
  1756. SLT_INF(slot, "new slot n_ctx_slot = %d\n", slot.n_ctx);
  1757. slot.params.sampling = params_base.sampling;
  1758. slot.params.n_keep = params_base.n_keep;
  1759. slot.callback_on_release = [this](int) {
  1760. queue_tasks.pop_deferred_task();
  1761. };
  1762. slot.reset();
  1763. slots.push_back(std::move(slot));
  1764. }
  1765. default_generation_settings_for_props = slots[0].to_json();
  1766. // the update_slots() logic will always submit a maximum of n_batch or n_parallel tokens
  1767. // note that n_batch can be > n_ctx (e.g. for non-causal attention models such as BERT where the KV cache is not used)
  1768. {
  1769. const int32_t n_batch = llama_n_batch(ctx);
  1770. batch = llama_batch_init(std::max(n_batch, params_base.n_parallel), 0, 1);
  1771. }
  1772. metrics.init();
  1773. oai_parser_opt = {
  1774. /* use_jinja */ params_base.use_jinja,
  1775. /* prefill_assistant */ params_base.prefill_assistant,
  1776. /* reasoning_format */ params_base.reasoning_format,
  1777. /* chat_template_kwargs */ params_base.default_template_kwargs,
  1778. /* common_chat_templates */ chat_templates.get(),
  1779. /* allow_image */ mctx ? mtmd_support_vision(mctx) : false,
  1780. /* allow_audio */ mctx ? mtmd_support_audio (mctx) : false,
  1781. /* enable_thinking */ params_base.reasoning_budget != 0,
  1782. };
  1783. }
  1784. server_slot * get_slot_by_id(int id) {
  1785. for (server_slot & slot : slots) {
  1786. if (slot.id == id) {
  1787. return &slot;
  1788. }
  1789. }
  1790. return nullptr;
  1791. }
  1792. server_slot * get_available_slot(const server_task & task) {
  1793. server_slot * ret = nullptr;
  1794. // find the slot that has at least n% prompt similarity
  1795. if (ret == nullptr && slot_prompt_similarity != 0.0f) {
  1796. int lcs_len = 0;
  1797. float similarity = 0;
  1798. for (server_slot & slot : slots) {
  1799. // skip the slot if it is not available
  1800. if (slot.is_processing()) {
  1801. continue;
  1802. }
  1803. // skip the slot if it does not contains cached tokens
  1804. if (slot.cache_tokens.empty()) {
  1805. continue;
  1806. }
  1807. // length of the Longest Common Subsequence between the current slot's prompt and the input prompt
  1808. int cur_lcs_len = slot.cache_tokens.get_common_prefix(task.prompt_tokens);
  1809. // fraction of the common subsequence length compared to the current slot's prompt length
  1810. float cur_similarity = static_cast<float>(cur_lcs_len) / static_cast<int>(slot.cache_tokens.size());
  1811. // select the current slot if the criteria match
  1812. if (cur_lcs_len > lcs_len && cur_similarity > slot_prompt_similarity) {
  1813. lcs_len = cur_lcs_len;
  1814. similarity = cur_similarity;
  1815. ret = &slot;
  1816. }
  1817. }
  1818. if (ret != nullptr) {
  1819. SLT_DBG(*ret, "selected slot by lcs similarity, lcs_len = %d, similarity = %f\n", lcs_len, similarity);
  1820. }
  1821. }
  1822. // find the slot that has been least recently used
  1823. if (ret == nullptr) {
  1824. int64_t t_last = -1;
  1825. for (server_slot & slot : slots) {
  1826. // skip the slot if it is not available
  1827. if (slot.is_processing()) {
  1828. continue;
  1829. }
  1830. // select the current slot if the criteria match
  1831. if (!ret || slot.t_last_used <= t_last) {
  1832. t_last = slot.t_last_used;
  1833. ret = &slot;
  1834. }
  1835. }
  1836. if (ret != nullptr) {
  1837. SLT_DBG(*ret, "selected slot by lru, t_last = %" PRId64 "\n", t_last);
  1838. }
  1839. }
  1840. return ret;
  1841. }
  1842. bool launch_slot_with_task(server_slot & slot, server_task && task) {
  1843. slot.reset();
  1844. slot.id_task = task.id;
  1845. slot.index = task.index;
  1846. slot.task_type = task.type;
  1847. slot.params = std::move(task.params);
  1848. slot.prompt_tokens = std::move(task.prompt_tokens);
  1849. if (!are_lora_equal(slot.params.lora, slot.lora)) {
  1850. // if lora is changed, we cannot reuse cached tokens
  1851. slot.cache_tokens.clear();
  1852. slot.lora = slot.params.lora;
  1853. }
  1854. if (!slot.prompt_tokens.validate(ctx)) {
  1855. send_error(task, "Prompt contains invalid tokens", ERROR_TYPE_INVALID_REQUEST);
  1856. return false;
  1857. }
  1858. SLT_DBG(slot, "launching slot : %s\n", safe_json_to_str(slot.to_json()).c_str());
  1859. if (slot.n_predict > 0 && slot.params.n_predict > slot.n_predict) {
  1860. // Might be better to reject the request with a 400 ?
  1861. SLT_WRN(slot, "n_predict = %d exceeds server configuration, setting to %d\n", slot.params.n_predict, slot.n_predict);
  1862. slot.params.n_predict = slot.n_predict;
  1863. }
  1864. if (slot.params.ignore_eos && has_eos_token) {
  1865. slot.params.sampling.logit_bias.push_back({llama_vocab_eos(vocab), -INFINITY});
  1866. }
  1867. {
  1868. if (slot.smpl != nullptr) {
  1869. common_sampler_free(slot.smpl);
  1870. }
  1871. slot.smpl = common_sampler_init(model, slot.params.sampling);
  1872. if (slot.smpl == nullptr) {
  1873. // for now, the only error that may happen here is invalid grammar
  1874. send_error(task, "Failed to parse grammar", ERROR_TYPE_INVALID_REQUEST);
  1875. return false;
  1876. }
  1877. }
  1878. if (slot.ctx_dft) {
  1879. llama_batch_free(slot.batch_spec);
  1880. slot.batch_spec = llama_batch_init(slot.params.speculative.n_max + 1, 0, 1);
  1881. }
  1882. slot.state = SLOT_STATE_STARTED;
  1883. SLT_INF(slot, "%s", "processing task\n");
  1884. return true;
  1885. }
  1886. void kv_cache_clear() {
  1887. SRV_DBG("%s", "clearing KV cache\n");
  1888. // clear the entire KV cache
  1889. llama_memory_clear(llama_get_memory(ctx), true);
  1890. clean_kv_cache = false;
  1891. }
  1892. bool process_token(completion_token_output & result, server_slot & slot) {
  1893. // remember which tokens were sampled - used for repetition penalties during sampling
  1894. const std::string token_str = result.text_to_send;
  1895. slot.sampled = result.tok;
  1896. slot.generated_text += token_str;
  1897. if (slot.params.return_tokens) {
  1898. slot.generated_tokens.push_back(result.tok);
  1899. }
  1900. slot.has_next_token = true;
  1901. // check if there is incomplete UTF-8 character at the end
  1902. bool incomplete = validate_utf8(slot.generated_text) < slot.generated_text.size();
  1903. // search stop word and delete it
  1904. if (!incomplete) {
  1905. size_t pos = std::min(slot.n_sent_text, slot.generated_text.size());
  1906. const std::string str_test = slot.generated_text.substr(pos);
  1907. bool send_text = true;
  1908. size_t stop_pos = slot.find_stopping_strings(str_test, token_str.size(), true);
  1909. if (stop_pos != std::string::npos) {
  1910. slot.generated_text.erase(
  1911. slot.generated_text.begin() + pos + stop_pos,
  1912. slot.generated_text.end());
  1913. pos = std::min(slot.n_sent_text, slot.generated_text.size());
  1914. } else if (slot.has_next_token) {
  1915. stop_pos = slot.find_stopping_strings(str_test, token_str.size(), false);
  1916. send_text = stop_pos == std::string::npos;
  1917. }
  1918. // check if there is any token to predict
  1919. if (send_text) {
  1920. // no send the stop word in the response
  1921. result.text_to_send = slot.generated_text.substr(pos, std::string::npos);
  1922. slot.n_sent_text += result.text_to_send.size();
  1923. // add the token to slot queue and cache
  1924. } else {
  1925. result.text_to_send = "";
  1926. }
  1927. slot.add_token(result);
  1928. if (slot.params.stream) {
  1929. send_partial_response(slot, result);
  1930. }
  1931. }
  1932. if (incomplete) {
  1933. slot.has_next_token = true;
  1934. }
  1935. // if context shifting is disabled, make sure that we don't run out of context
  1936. if (!params_base.ctx_shift && slot.n_past + 1 >= slot.n_ctx) {
  1937. slot.stop = STOP_TYPE_LIMIT;
  1938. slot.has_next_token = false;
  1939. SLT_DBG(slot, "stopped due to running out of context, n_past = %d, n_ctx = %d\n", slot.n_past, slot.n_ctx);
  1940. }
  1941. // check the limits
  1942. if (slot.n_decoded > 0 && slot.has_next_token && !slot.has_budget(params_base)) {
  1943. slot.stop = STOP_TYPE_LIMIT;
  1944. slot.has_next_token = false;
  1945. SLT_DBG(slot, "stopped by limit, n_decoded = %d, n_predict = %d\n", slot.n_decoded, slot.params.n_predict);
  1946. }
  1947. if (slot.has_new_line) {
  1948. // require that each new line has a whitespace prefix (i.e. indentation) of at least slot.params.n_indent
  1949. if (slot.params.n_indent > 0) {
  1950. // check the current indentation
  1951. // TODO: improve by not doing it more than once for each new line
  1952. if (slot.last_nl_pos > 0) {
  1953. size_t pos = slot.last_nl_pos;
  1954. int n_indent = 0;
  1955. while (pos < slot.generated_text.size() && (slot.generated_text[pos] == ' ' || slot.generated_text[pos] == '\t')) {
  1956. n_indent++;
  1957. pos++;
  1958. }
  1959. if (pos < slot.generated_text.size() && n_indent < slot.params.n_indent) {
  1960. slot.stop = STOP_TYPE_LIMIT;
  1961. slot.has_next_token = false;
  1962. // cut the last line
  1963. slot.generated_text.erase(pos, std::string::npos);
  1964. SLT_DBG(slot, "stopped by indentation limit, n_decoded = %d, n_indent = %d\n", slot.n_decoded, n_indent);
  1965. }
  1966. }
  1967. // find the next new line
  1968. {
  1969. const size_t pos = slot.generated_text.find('\n', slot.last_nl_pos);
  1970. if (pos != std::string::npos) {
  1971. slot.last_nl_pos = pos + 1;
  1972. }
  1973. }
  1974. }
  1975. }
  1976. // check if there is a new line in the generated text
  1977. if (result.text_to_send.find('\n') != std::string::npos) {
  1978. slot.has_new_line = true;
  1979. // if we have seen a new line, we stop after a certain time limit, but only upon another new line
  1980. if (slot.params.t_max_predict_ms > 0 && (ggml_time_us() - slot.t_start_generation > 1000.0f*slot.params.t_max_predict_ms)) {
  1981. slot.stop = STOP_TYPE_LIMIT;
  1982. slot.has_next_token = false;
  1983. SLT_DBG(slot, "stopped by time limit, n_decoded = %d, t_max_predict_ms = %d ms\n", slot.n_decoded, (int) slot.params.t_max_predict_ms);
  1984. }
  1985. }
  1986. // if context shift is disabled, we stop when it reaches the context limit
  1987. if (slot.n_past >= slot.n_ctx) {
  1988. slot.truncated = true;
  1989. slot.stop = STOP_TYPE_LIMIT;
  1990. slot.has_next_token = false;
  1991. SLT_DBG(slot, "stopped due to running out of context capacity, n_past = %d, n_prompt_tokens = %d, n_decoded = %d, n_ctx = %d\n",
  1992. slot.n_decoded, slot.n_prompt_tokens, slot.n_past, slot.n_ctx);
  1993. }
  1994. if (llama_vocab_is_eog(vocab, result.tok)) {
  1995. slot.stop = STOP_TYPE_EOS;
  1996. slot.has_next_token = false;
  1997. SLT_DBG(slot, "%s", "stopped by EOS\n");
  1998. }
  1999. const auto n_ctx_train = llama_model_n_ctx_train(model);
  2000. if (slot.params.n_predict < 1 && slot.n_predict < 1 && slot.n_prompt_tokens + slot.n_decoded >= n_ctx_train) {
  2001. slot.truncated = true;
  2002. slot.stop = STOP_TYPE_LIMIT;
  2003. slot.has_next_token = false; // stop prediction
  2004. SLT_WRN(slot,
  2005. "n_predict (%d) is set for infinite generation. "
  2006. "Limiting generated tokens to n_ctx_train (%d) to avoid EOS-less generation infinite loop\n",
  2007. slot.params.n_predict, n_ctx_train);
  2008. }
  2009. SLT_DBG(slot, "n_decoded = %d, n_remaining = %d, next token: %5d '%s'\n", slot.n_decoded, slot.n_remaining, result.tok, token_str.c_str());
  2010. return slot.has_next_token; // continue
  2011. }
  2012. void populate_token_probs(const server_slot & slot, completion_token_output & result, bool post_sampling, bool special, int idx) {
  2013. size_t n_probs = slot.params.sampling.n_probs;
  2014. size_t n_vocab = llama_vocab_n_tokens(vocab);
  2015. if (post_sampling) {
  2016. const auto * cur_p = common_sampler_get_candidates(slot.smpl);
  2017. const size_t max_probs = cur_p->size;
  2018. // set probability for sampled token
  2019. for (size_t i = 0; i < max_probs; i++) {
  2020. if (cur_p->data[i].id == result.tok) {
  2021. result.prob = cur_p->data[i].p;
  2022. break;
  2023. }
  2024. }
  2025. // set probability for top n_probs tokens
  2026. result.probs.reserve(max_probs);
  2027. for (size_t i = 0; i < std::min(max_probs, n_probs); i++) {
  2028. result.probs.push_back({
  2029. cur_p->data[i].id,
  2030. common_token_to_piece(ctx, cur_p->data[i].id, special),
  2031. cur_p->data[i].p
  2032. });
  2033. }
  2034. } else {
  2035. // TODO: optimize this with min-p optimization
  2036. std::vector<llama_token_data> cur = get_token_probabilities(ctx, idx);
  2037. // set probability for sampled token
  2038. for (size_t i = 0; i < n_vocab; i++) {
  2039. // set probability for sampled token
  2040. if (cur[i].id == result.tok) {
  2041. result.prob = cur[i].p;
  2042. break;
  2043. }
  2044. }
  2045. // set probability for top n_probs tokens
  2046. result.probs.reserve(n_probs);
  2047. for (size_t i = 0; i < std::min(n_vocab, n_probs); i++) {
  2048. result.probs.push_back({
  2049. cur[i].id,
  2050. common_token_to_piece(ctx, cur[i].id, special),
  2051. cur[i].p
  2052. });
  2053. }
  2054. }
  2055. }
  2056. void send_error(const server_task & task, const std::string & error, const enum error_type type = ERROR_TYPE_SERVER) {
  2057. send_error(task.id, error, type);
  2058. }
  2059. void send_error(const server_slot & slot, const std::string & error, const enum error_type type = ERROR_TYPE_SERVER) {
  2060. send_error(slot.id_task, error, type);
  2061. }
  2062. void send_error(const int id_task, const std::string & error, const enum error_type type = ERROR_TYPE_SERVER) {
  2063. SRV_ERR("task id = %d, error: %s\n", id_task, error.c_str());
  2064. auto res = std::make_unique<server_task_result_error>();
  2065. res->id = id_task;
  2066. res->err_type = type;
  2067. res->err_msg = error;
  2068. queue_results.send(std::move(res));
  2069. }
  2070. // if multimodal is enabled, send an error and return false
  2071. bool ensure_no_mtmd(const int id_task) {
  2072. if (mctx) {
  2073. send_error(id_task, "This feature is not supported by multimodal", ERROR_TYPE_NOT_SUPPORTED);
  2074. return false;
  2075. }
  2076. return true;
  2077. }
  2078. void send_partial_response(server_slot & slot, const completion_token_output & tkn) {
  2079. auto res = std::make_unique<server_task_result_cmpl_partial>();
  2080. res->id = slot.id_task;
  2081. res->index = slot.index;
  2082. res->content = tkn.text_to_send;
  2083. res->tokens = { tkn.tok };
  2084. res->n_decoded = slot.n_decoded;
  2085. res->n_prompt_tokens = slot.n_prompt_tokens;
  2086. res->post_sampling_probs = slot.params.post_sampling_probs;
  2087. res->verbose = slot.params.verbose;
  2088. res->oaicompat = slot.params.oaicompat;
  2089. res->oaicompat_model = slot.params.oaicompat_model;
  2090. res->oaicompat_cmpl_id = slot.params.oaicompat_cmpl_id;
  2091. slot.update_chat_msg(res->oaicompat_msg_diffs);
  2092. // populate res.probs_output
  2093. if (slot.params.sampling.n_probs > 0) {
  2094. res->prob_output = tkn; // copy the token probs
  2095. }
  2096. // populate timings if this is final response or timings_per_token is enabled
  2097. if (slot.stop != STOP_TYPE_NONE || slot.params.timings_per_token) {
  2098. res->timings = slot.get_timings();
  2099. }
  2100. queue_results.send(std::move(res));
  2101. }
  2102. void send_final_response(server_slot & slot) {
  2103. auto res = std::make_unique<server_task_result_cmpl_final>();
  2104. res->id = slot.id_task;
  2105. res->id_slot = slot.id;
  2106. res->index = slot.index;
  2107. res->content = slot.generated_text;
  2108. res->tokens = std::move(slot.generated_tokens);
  2109. res->timings = slot.get_timings();
  2110. res->prompt = slot.prompt_tokens.detokenize(ctx, true);
  2111. res->response_fields = std::move(slot.params.response_fields);
  2112. res->truncated = slot.truncated;
  2113. res->n_decoded = slot.n_decoded;
  2114. res->n_prompt_tokens = slot.n_prompt_tokens;
  2115. res->n_tokens_cached = slot.n_past;
  2116. res->has_new_line = slot.has_new_line;
  2117. res->stopping_word = slot.stopping_word;
  2118. res->stop = slot.stop;
  2119. res->post_sampling_probs = slot.params.post_sampling_probs;
  2120. res->verbose = slot.params.verbose;
  2121. res->stream = slot.params.stream;
  2122. res->oaicompat = slot.params.oaicompat;
  2123. res->oaicompat_model = slot.params.oaicompat_model;
  2124. res->oaicompat_cmpl_id = slot.params.oaicompat_cmpl_id;
  2125. res->oaicompat_msg = slot.update_chat_msg(res->oaicompat_msg_diffs);
  2126. // populate res.probs_output
  2127. if (slot.params.sampling.n_probs > 0) {
  2128. if (!slot.params.stream && slot.stop == STOP_TYPE_WORD) {
  2129. const llama_tokens stop_word_toks = common_tokenize(ctx, slot.stopping_word, false);
  2130. size_t safe_offset = std::min(slot.generated_token_probs.size(), stop_word_toks.size());
  2131. res->probs_output = std::vector<completion_token_output>(
  2132. slot.generated_token_probs.begin(),
  2133. slot.generated_token_probs.end() - safe_offset);
  2134. } else {
  2135. res->probs_output = std::vector<completion_token_output>(
  2136. slot.generated_token_probs.begin(),
  2137. slot.generated_token_probs.end());
  2138. }
  2139. }
  2140. res->generation_params = slot.params; // copy the parameters
  2141. queue_results.send(std::move(res));
  2142. }
  2143. void send_embedding(const server_slot & slot, const llama_batch & batch) {
  2144. auto res = std::make_unique<server_task_result_embd>();
  2145. res->id = slot.id_task;
  2146. res->index = slot.index;
  2147. res->n_tokens = slot.n_prompt_tokens;
  2148. res->oaicompat = slot.params.oaicompat;
  2149. const int n_embd = llama_model_n_embd(model);
  2150. std::vector<float> embd_res(n_embd, 0.0f);
  2151. for (int i = 0; i < batch.n_tokens; ++i) {
  2152. if (!batch.logits[i] || batch.seq_id[i][0] != slot.id) {
  2153. continue;
  2154. }
  2155. const float * embd = nullptr;
  2156. if (llama_pooling_type(slot.ctx) == LLAMA_POOLING_TYPE_NONE) {
  2157. embd = llama_get_embeddings_ith(ctx, i);
  2158. } else {
  2159. embd = llama_get_embeddings_seq(ctx, batch.seq_id[i][0]);
  2160. }
  2161. if (embd == nullptr) {
  2162. SLT_ERR(slot, "failed to get embeddings, token = %d, seq_id = %d\n", batch.token[i], batch.seq_id[i][0]);
  2163. res->embedding.push_back(std::vector<float>(n_embd, 0.0f));
  2164. continue;
  2165. }
  2166. // normalize only when there is pooling
  2167. if (llama_pooling_type(slot.ctx) != LLAMA_POOLING_TYPE_NONE) {
  2168. common_embd_normalize(embd, embd_res.data(), n_embd, 2);
  2169. res->embedding.push_back(embd_res);
  2170. break;
  2171. } else {
  2172. res->embedding.emplace_back(embd, embd + n_embd);
  2173. }
  2174. }
  2175. SLT_DBG(slot, "%s", "sending embeddings\n");
  2176. queue_results.send(std::move(res));
  2177. }
  2178. void send_rerank(const server_slot & slot, const llama_batch & batch) {
  2179. auto res = std::make_unique<server_task_result_rerank>();
  2180. res->id = slot.id_task;
  2181. res->index = slot.index;
  2182. res->n_tokens = slot.n_prompt_tokens;
  2183. for (int i = 0; i < batch.n_tokens; ++i) {
  2184. if (!batch.logits[i] || batch.seq_id[i][0] != slot.id) {
  2185. continue;
  2186. }
  2187. const float * embd = llama_get_embeddings_seq(ctx, batch.seq_id[i][0]);
  2188. if (embd == NULL) {
  2189. embd = llama_get_embeddings_ith(ctx, i);
  2190. }
  2191. if (embd == NULL) {
  2192. SLT_ERR(slot, "failed to get embeddings, token = %d, seq_id = %d\n", batch.token[i], batch.seq_id[i][0]);
  2193. res->score = -1e6;
  2194. continue;
  2195. }
  2196. res->score = embd[0];
  2197. }
  2198. SLT_DBG(slot, "sending rerank result, res.score = %f\n", res->score);
  2199. queue_results.send(std::move(res));
  2200. }
  2201. //
  2202. // Functions to create new task(s) and receive result(s)
  2203. //
  2204. void cancel_tasks(const std::unordered_set<int> & id_tasks) {
  2205. std::vector<server_task> cancel_tasks;
  2206. cancel_tasks.reserve(id_tasks.size());
  2207. for (const auto & id_task : id_tasks) {
  2208. SRV_WRN("cancel task, id_task = %d\n", id_task);
  2209. server_task task(SERVER_TASK_TYPE_CANCEL);
  2210. task.id_target = id_task;
  2211. queue_results.remove_waiting_task_id(id_task);
  2212. cancel_tasks.push_back(std::move(task));
  2213. }
  2214. // push to beginning of the queue, so it has highest priority
  2215. queue_tasks.post(std::move(cancel_tasks), true);
  2216. }
  2217. // receive the results from task(s)
  2218. void receive_multi_results(
  2219. const std::unordered_set<int> & id_tasks,
  2220. const std::function<void(std::vector<server_task_result_ptr>&)> & result_handler,
  2221. const std::function<void(json)> & error_handler,
  2222. const std::function<bool()> & is_connection_closed) {
  2223. std::vector<server_task_result_ptr> results(id_tasks.size());
  2224. for (int i = 0; i < (int)id_tasks.size(); i++) {
  2225. server_task_result_ptr result = queue_results.recv_with_timeout(id_tasks, HTTP_POLLING_SECONDS);
  2226. if (is_connection_closed()) {
  2227. cancel_tasks(id_tasks);
  2228. return;
  2229. }
  2230. if (result == nullptr) {
  2231. i--; // retry
  2232. continue;
  2233. }
  2234. if (result->is_error()) {
  2235. error_handler(result->to_json());
  2236. cancel_tasks(id_tasks);
  2237. return;
  2238. }
  2239. GGML_ASSERT(
  2240. dynamic_cast<server_task_result_cmpl_final*>(result.get()) != nullptr
  2241. || dynamic_cast<server_task_result_embd*>(result.get()) != nullptr
  2242. || dynamic_cast<server_task_result_rerank*>(result.get()) != nullptr
  2243. );
  2244. const size_t idx = result->get_index();
  2245. GGML_ASSERT(idx < results.size() && "index out of range");
  2246. results[idx] = std::move(result);
  2247. }
  2248. result_handler(results);
  2249. }
  2250. // receive the results from task(s), in stream mode
  2251. void receive_cmpl_results_stream(
  2252. const std::unordered_set<int> & id_tasks,
  2253. const std::function<bool(server_task_result_ptr&)> & result_handler,
  2254. const std::function<void(json)> & error_handler,
  2255. const std::function<bool()> & is_connection_closed) {
  2256. size_t n_finished = 0;
  2257. while (true) {
  2258. server_task_result_ptr result = queue_results.recv_with_timeout(id_tasks, HTTP_POLLING_SECONDS);
  2259. if (is_connection_closed()) {
  2260. cancel_tasks(id_tasks);
  2261. return;
  2262. }
  2263. if (result == nullptr) {
  2264. continue; // retry
  2265. }
  2266. if (result->is_error()) {
  2267. error_handler(result->to_json());
  2268. cancel_tasks(id_tasks);
  2269. return;
  2270. }
  2271. GGML_ASSERT(
  2272. dynamic_cast<server_task_result_cmpl_partial*>(result.get()) != nullptr
  2273. || dynamic_cast<server_task_result_cmpl_final*>(result.get()) != nullptr
  2274. );
  2275. if (!result_handler(result)) {
  2276. cancel_tasks(id_tasks);
  2277. break;
  2278. }
  2279. if (result->is_stop()) {
  2280. if (++n_finished == id_tasks.size()) {
  2281. break;
  2282. }
  2283. }
  2284. }
  2285. }
  2286. //
  2287. // Functions to process the task
  2288. //
  2289. void process_single_task(server_task && task) {
  2290. switch (task.type) {
  2291. case SERVER_TASK_TYPE_COMPLETION:
  2292. case SERVER_TASK_TYPE_INFILL:
  2293. case SERVER_TASK_TYPE_EMBEDDING:
  2294. case SERVER_TASK_TYPE_RERANK:
  2295. {
  2296. const int id_slot = task.id_selected_slot;
  2297. server_slot * slot = id_slot != -1 ? get_slot_by_id(id_slot) : get_available_slot(task);
  2298. if (slot == nullptr) {
  2299. // if no slot is available, we defer this task for processing later
  2300. SRV_DBG("no slot is available, defer task, id_task = %d\n", task.id);
  2301. queue_tasks.defer(std::move(task));
  2302. break;
  2303. }
  2304. if (slot->is_processing()) {
  2305. // if requested slot is unavailable, we defer this task for processing later
  2306. SRV_DBG("requested slot is unavailable, defer task, id_task = %d\n", task.id);
  2307. queue_tasks.defer(std::move(task));
  2308. break;
  2309. }
  2310. if (!launch_slot_with_task(*slot, std::move(task))) {
  2311. SRV_ERR("failed to launch slot with task, id_task = %d\n", task.id);
  2312. break;
  2313. }
  2314. } break;
  2315. case SERVER_TASK_TYPE_CANCEL:
  2316. {
  2317. // release slot linked with the task id
  2318. for (auto & slot : slots) {
  2319. if (slot.id_task == task.id_target) {
  2320. slot.release();
  2321. break;
  2322. }
  2323. }
  2324. } break;
  2325. case SERVER_TASK_TYPE_NEXT_RESPONSE:
  2326. {
  2327. // do nothing
  2328. } break;
  2329. case SERVER_TASK_TYPE_METRICS:
  2330. {
  2331. json slots_data = json::array();
  2332. int n_idle_slots = 0;
  2333. int n_processing_slots = 0;
  2334. for (server_slot & slot : slots) {
  2335. json slot_data = slot.to_json();
  2336. if (slot.is_processing()) {
  2337. n_processing_slots++;
  2338. } else {
  2339. n_idle_slots++;
  2340. }
  2341. slots_data.push_back(slot_data);
  2342. }
  2343. SRV_DBG("n_idle_slots = %d, n_processing_slots = %d\n", n_idle_slots, n_processing_slots);
  2344. auto res = std::make_unique<server_task_result_metrics>();
  2345. res->id = task.id;
  2346. res->slots_data = std::move(slots_data);
  2347. res->n_idle_slots = n_idle_slots;
  2348. res->n_processing_slots = n_processing_slots;
  2349. res->n_tasks_deferred = queue_tasks.queue_tasks_deferred.size();
  2350. res->t_start = metrics.t_start;
  2351. res->n_prompt_tokens_processed_total = metrics.n_prompt_tokens_processed_total;
  2352. res->t_prompt_processing_total = metrics.t_prompt_processing_total;
  2353. res->n_tokens_predicted_total = metrics.n_tokens_predicted_total;
  2354. res->t_tokens_generation_total = metrics.t_tokens_generation_total;
  2355. res->n_prompt_tokens_processed = metrics.n_prompt_tokens_processed;
  2356. res->t_prompt_processing = metrics.t_prompt_processing;
  2357. res->n_tokens_predicted = metrics.n_tokens_predicted;
  2358. res->t_tokens_generation = metrics.t_tokens_generation;
  2359. res->n_decode_total = metrics.n_decode_total;
  2360. res->n_busy_slots_total = metrics.n_busy_slots_total;
  2361. if (task.metrics_reset_bucket) {
  2362. metrics.reset_bucket();
  2363. }
  2364. queue_results.send(std::move(res));
  2365. } break;
  2366. case SERVER_TASK_TYPE_SLOT_SAVE:
  2367. {
  2368. if (!ensure_no_mtmd(task.id)) {
  2369. break;
  2370. }
  2371. int id_slot = task.slot_action.slot_id;
  2372. server_slot * slot = get_slot_by_id(id_slot);
  2373. if (slot == nullptr) {
  2374. send_error(task, "Invalid slot ID", ERROR_TYPE_INVALID_REQUEST);
  2375. break;
  2376. }
  2377. if (slot->is_processing()) {
  2378. // if requested slot is unavailable, we defer this task for processing later
  2379. SRV_DBG("requested slot is unavailable, defer task, id_task = %d\n", task.id);
  2380. queue_tasks.defer(std::move(task));
  2381. break;
  2382. }
  2383. const size_t token_count = slot->cache_tokens.size();
  2384. const int64_t t_start = ggml_time_us();
  2385. std::string filename = task.slot_action.filename;
  2386. std::string filepath = task.slot_action.filepath;
  2387. const llama_tokens & tokens = slot->cache_tokens.get_text_tokens();
  2388. const size_t nwrite = llama_state_seq_save_file(ctx, filepath.c_str(), slot->id, tokens.data(), token_count);
  2389. const int64_t t_end = ggml_time_us();
  2390. const double t_save_ms = (t_end - t_start) / 1000.0;
  2391. auto res = std::make_unique<server_task_result_slot_save_load>();
  2392. res->id = task.id;
  2393. res->id_slot = id_slot;
  2394. res->filename = filename;
  2395. res->is_save = true;
  2396. res->n_tokens = token_count;
  2397. res->n_bytes = nwrite;
  2398. res->t_ms = t_save_ms;
  2399. queue_results.send(std::move(res));
  2400. } break;
  2401. case SERVER_TASK_TYPE_SLOT_RESTORE:
  2402. {
  2403. if (!ensure_no_mtmd(task.id)) break;
  2404. int id_slot = task.slot_action.slot_id;
  2405. server_slot * slot = get_slot_by_id(id_slot);
  2406. if (slot == nullptr) {
  2407. send_error(task, "Invalid slot ID", ERROR_TYPE_INVALID_REQUEST);
  2408. break;
  2409. }
  2410. if (slot->is_processing()) {
  2411. // if requested slot is unavailable, we defer this task for processing later
  2412. SRV_DBG("requested slot is unavailable, defer task, id_task = %d\n", task.id);
  2413. queue_tasks.defer(std::move(task));
  2414. break;
  2415. }
  2416. const int64_t t_start = ggml_time_us();
  2417. std::string filename = task.slot_action.filename;
  2418. std::string filepath = task.slot_action.filepath;
  2419. llama_tokens tokens;
  2420. tokens.resize(slot->n_ctx);
  2421. size_t token_count = 0;
  2422. size_t nread = llama_state_seq_load_file(ctx, filepath.c_str(), slot->id, tokens.data(), tokens.size(), &token_count);
  2423. if (nread == 0) {
  2424. slot->cache_tokens.clear(); // KV may already been invalidated?
  2425. send_error(task, "Unable to restore slot, no available space in KV cache or invalid slot save file", ERROR_TYPE_INVALID_REQUEST);
  2426. break;
  2427. }
  2428. tokens.resize(token_count);
  2429. slot->cache_tokens.clear();
  2430. slot->cache_tokens.insert(tokens);
  2431. const int64_t t_end = ggml_time_us();
  2432. const double t_restore_ms = (t_end - t_start) / 1000.0;
  2433. auto res = std::make_unique<server_task_result_slot_save_load>();
  2434. res->id = task.id;
  2435. res->id_slot = id_slot;
  2436. res->filename = filename;
  2437. res->is_save = false;
  2438. res->n_tokens = token_count;
  2439. res->n_bytes = nread;
  2440. res->t_ms = t_restore_ms;
  2441. queue_results.send(std::move(res));
  2442. } break;
  2443. case SERVER_TASK_TYPE_SLOT_ERASE:
  2444. {
  2445. if (!ensure_no_mtmd(task.id)) break;
  2446. int id_slot = task.slot_action.slot_id;
  2447. server_slot * slot = get_slot_by_id(id_slot);
  2448. if (slot == nullptr) {
  2449. send_error(task, "Invalid slot ID", ERROR_TYPE_INVALID_REQUEST);
  2450. break;
  2451. }
  2452. if (slot->is_processing()) {
  2453. // if requested slot is unavailable, we defer this task for processing later
  2454. SRV_DBG("requested slot is unavailable, defer task, id_task = %d\n", task.id);
  2455. queue_tasks.defer(std::move(task));
  2456. break;
  2457. }
  2458. // Erase token cache
  2459. const size_t n_erased = slot->cache_tokens.size();
  2460. llama_memory_seq_rm(llama_get_memory(ctx), slot->id, -1, -1);
  2461. slot->cache_tokens.clear();
  2462. auto res = std::make_unique<server_task_result_slot_erase>();
  2463. res->id = task.id;
  2464. res->id_slot = id_slot;
  2465. res->n_erased = n_erased;
  2466. queue_results.send(std::move(res));
  2467. } break;
  2468. case SERVER_TASK_TYPE_SET_LORA:
  2469. {
  2470. params_base.lora_adapters = std::move(task.set_lora);
  2471. auto res = std::make_unique<server_task_result_apply_lora>();
  2472. res->id = task.id;
  2473. queue_results.send(std::move(res));
  2474. } break;
  2475. }
  2476. }
  2477. void update_slots() {
  2478. // check if all slots are idle
  2479. {
  2480. bool all_idle = true;
  2481. for (auto & slot : slots) {
  2482. if (slot.is_processing()) {
  2483. all_idle = false;
  2484. break;
  2485. }
  2486. }
  2487. if (all_idle) {
  2488. SRV_INF("%s", "all slots are idle\n");
  2489. if (clean_kv_cache) {
  2490. kv_cache_clear();
  2491. }
  2492. return;
  2493. }
  2494. }
  2495. {
  2496. SRV_DBG("%s", "posting NEXT_RESPONSE\n");
  2497. server_task task(SERVER_TASK_TYPE_NEXT_RESPONSE);
  2498. task.id = queue_tasks.get_new_id();
  2499. queue_tasks.post(std::move(task));
  2500. }
  2501. // apply context-shift if needed
  2502. // TODO: simplify and improve
  2503. for (server_slot & slot : slots) {
  2504. if (slot.is_processing() && slot.n_past + 1 >= slot.n_ctx) {
  2505. if (!params_base.ctx_shift) {
  2506. // this check is redundant (for good)
  2507. // we should never get here, because generation should already stopped in process_token()
  2508. slot.release();
  2509. send_error(slot, "context shift is disabled", ERROR_TYPE_SERVER);
  2510. continue;
  2511. }
  2512. if (mctx) {
  2513. // we should never reach this because params_base.ctx_shift is automatically disabled if mmproj is loaded
  2514. // we don't support ctx_shift because an image chunk may contains multiple tokens
  2515. GGML_ABORT("not supported by multimodal");
  2516. }
  2517. // Shift context
  2518. const int n_keep = slot.params.n_keep + add_bos_token;
  2519. const int n_left = slot.n_past - n_keep;
  2520. const int n_discard = slot.params.n_discard ? slot.params.n_discard : (n_left / 2);
  2521. SLT_WRN(slot, "slot context shift, n_keep = %d, n_left = %d, n_discard = %d\n", n_keep, n_left, n_discard);
  2522. llama_memory_seq_rm (llama_get_memory(ctx), slot.id, n_keep , n_keep + n_discard);
  2523. llama_memory_seq_add(llama_get_memory(ctx), slot.id, n_keep + n_discard, slot.n_past, -n_discard);
  2524. // add generated tokens to cache
  2525. {
  2526. llama_tokens new_tokens = slot.cache_tokens.get_text_tokens(); // copy
  2527. for (size_t i = n_keep + n_discard; i < new_tokens.size(); i++) {
  2528. new_tokens[i - n_discard] = new_tokens[i];
  2529. }
  2530. new_tokens.resize(slot.cache_tokens.size() - n_discard);
  2531. slot.cache_tokens.clear();
  2532. slot.cache_tokens.insert(new_tokens);
  2533. }
  2534. slot.n_past -= n_discard;
  2535. slot.truncated = true;
  2536. }
  2537. }
  2538. // start populating the batch for this iteration
  2539. common_batch_clear(batch);
  2540. // track if given slot can be batched with slots already in the batch
  2541. server_slot * slot_batched = nullptr;
  2542. auto accept_special_token = [&](server_slot & slot, llama_token token) {
  2543. return params_base.special || slot.params.sampling.preserved_tokens.find(token) != slot.params.sampling.preserved_tokens.end();
  2544. };
  2545. // frist, add sampled tokens from any ongoing sequences
  2546. for (auto & slot : slots) {
  2547. if (slot.state != SLOT_STATE_GENERATING) {
  2548. continue;
  2549. }
  2550. // check if we can batch this slot with the previous one
  2551. if (!slot_batched) {
  2552. slot_batched = &slot;
  2553. } else if (!slot_batched->can_batch_with(slot)) {
  2554. continue;
  2555. }
  2556. slot.i_batch = batch.n_tokens;
  2557. common_batch_add(batch, slot.sampled, slot.n_past, { slot.id }, true);
  2558. slot.n_past += 1;
  2559. slot.cache_tokens.push_back(slot.sampled);
  2560. SLT_DBG(slot, "slot decode token, n_ctx = %d, n_past = %d, n_cache_tokens = %d, truncated = %d\n",
  2561. slot.n_ctx, slot.n_past, (int) slot.cache_tokens.size(), slot.truncated);
  2562. }
  2563. // process in chunks of params.n_batch
  2564. int32_t n_batch = llama_n_batch(ctx);
  2565. int32_t n_ubatch = llama_n_ubatch(ctx);
  2566. // next, batch any pending prompts without exceeding n_batch
  2567. if (params_base.cont_batching || batch.n_tokens == 0) {
  2568. for (auto & slot : slots) {
  2569. // check if we can batch this slot with the previous one
  2570. if (slot.is_processing()) {
  2571. if (!slot_batched) {
  2572. slot_batched = &slot;
  2573. } else if (!slot_batched->can_batch_with(slot)) {
  2574. continue;
  2575. }
  2576. }
  2577. // this slot still has a prompt to be processed
  2578. if (slot.state == SLOT_STATE_PROCESSING_PROMPT || slot.state == SLOT_STATE_STARTED) {
  2579. auto & prompt_tokens = slot.prompt_tokens;
  2580. // TODO: maybe move branch to outside of this loop in the future
  2581. if (slot.state == SLOT_STATE_STARTED) {
  2582. slot.t_start_process_prompt = ggml_time_us();
  2583. slot.t_start_generation = 0;
  2584. slot.n_past = 0;
  2585. slot.n_prompt_tokens = prompt_tokens.size();
  2586. slot.state = SLOT_STATE_PROCESSING_PROMPT;
  2587. SLT_INF(slot, "new prompt, n_ctx_slot = %d, n_keep = %d, n_prompt_tokens = %d\n", slot.n_ctx, slot.params.n_keep, slot.n_prompt_tokens);
  2588. // print prompt tokens (for debugging)
  2589. /*if (1) {
  2590. // first 16 tokens (avoid flooding logs)
  2591. for (int i = 0; i < std::min<int>(16, prompt_tokens.size()); i++) {
  2592. SLT_DBG(slot, "prompt token %3d: %6d '%s'\n", i, prompt_tokens[i], common_token_to_piece(ctx, prompt_tokens[i]).c_str());
  2593. }
  2594. } else {
  2595. // all
  2596. for (int i = 0; i < (int) prompt_tokens.size(); i++) {
  2597. SLT_DBG(slot, "prompt token %3d: %6d '%s'\n", i, prompt_tokens[i], common_token_to_piece(ctx, prompt_tokens[i]).c_str());
  2598. }
  2599. }*/
  2600. // empty prompt passed -> release the slot and send empty response
  2601. if (prompt_tokens.empty()) {
  2602. SLT_WRN(slot, "%s", "empty prompt - releasing slot\n");
  2603. slot.release();
  2604. slot.print_timings();
  2605. send_final_response(slot);
  2606. continue;
  2607. }
  2608. // TODO: support memory-less logits computation
  2609. if (slot.need_logits() && !llama_get_memory(ctx)) {
  2610. slot.release();
  2611. send_error(slot, "the current context does not logits computation. skipping", ERROR_TYPE_SERVER);
  2612. continue;
  2613. }
  2614. if (!slot.can_split()) {
  2615. if (slot.n_prompt_tokens > n_ubatch) {
  2616. slot.release();
  2617. send_error(slot, "input is too large to process. increase the physical batch size", ERROR_TYPE_SERVER);
  2618. continue;
  2619. }
  2620. if (slot.n_prompt_tokens > slot.n_ctx) {
  2621. slot.release();
  2622. send_error(slot, "input is larger than the max context size. skipping", ERROR_TYPE_SERVER);
  2623. continue;
  2624. }
  2625. } else {
  2626. if (!params_base.ctx_shift) {
  2627. // if context shift is disabled, we make sure prompt size is smaller than KV size
  2628. // TODO: there should be a separate parameter that control prompt truncation
  2629. // context shift should be applied only during the generation phase
  2630. if (slot.n_prompt_tokens >= slot.n_ctx) {
  2631. slot.release();
  2632. send_error(slot, "the request exceeds the available context size. try increasing the context size or enable context shift", ERROR_TYPE_INVALID_REQUEST);
  2633. continue;
  2634. }
  2635. }
  2636. if (slot.params.n_keep < 0) {
  2637. slot.params.n_keep = slot.n_prompt_tokens;
  2638. }
  2639. slot.params.n_keep = std::min(slot.n_ctx - 4, slot.params.n_keep);
  2640. // if input prompt is too big, truncate it
  2641. if (slot.n_prompt_tokens >= slot.n_ctx) {
  2642. if (mctx) {
  2643. // we should never reach this
  2644. GGML_ABORT("not supported by multimodal");
  2645. }
  2646. const int n_left = slot.n_ctx - slot.params.n_keep;
  2647. const int n_block_size = n_left / 2;
  2648. const int erased_blocks = (slot.n_prompt_tokens - slot.params.n_keep - n_block_size) / n_block_size;
  2649. const llama_tokens & curr_tokens = slot.prompt_tokens.get_text_tokens();
  2650. llama_tokens new_tokens(
  2651. curr_tokens.begin(),
  2652. curr_tokens.begin() + slot.params.n_keep);
  2653. new_tokens.insert(
  2654. new_tokens.end(),
  2655. curr_tokens.begin() + slot.params.n_keep + erased_blocks * n_block_size,
  2656. curr_tokens.end());
  2657. prompt_tokens.clear();
  2658. prompt_tokens.insert(new_tokens);
  2659. slot.truncated = true;
  2660. slot.n_prompt_tokens = prompt_tokens.size();
  2661. SLT_WRN(slot, "input truncated, n_ctx = %d, n_keep = %d, n_left = %d, n_prompt_tokens = %d\n", slot.n_ctx, slot.params.n_keep, n_left, slot.n_prompt_tokens);
  2662. GGML_ASSERT(slot.n_prompt_tokens < slot.n_ctx);
  2663. }
  2664. if (slot.params.cache_prompt) {
  2665. // reuse any previously computed tokens that are common with the new prompt
  2666. slot.n_past = slot.cache_tokens.get_common_prefix(prompt_tokens);
  2667. // reuse chunks from the cached prompt by shifting their KV cache in the new position
  2668. if (params_base.n_cache_reuse > 0) {
  2669. size_t head_c = slot.n_past; // cache
  2670. size_t head_p = slot.n_past; // current prompt
  2671. if (mctx) {
  2672. // we should never reach this
  2673. GGML_ABORT("not supported by multimodal");
  2674. }
  2675. SLT_DBG(slot, "trying to reuse chunks with size > %d, slot.n_past = %d\n", params_base.n_cache_reuse, slot.n_past);
  2676. while (head_c < slot.cache_tokens.size() &&
  2677. head_p < prompt_tokens.size()) {
  2678. size_t n_match = 0;
  2679. while (head_c + n_match < slot.cache_tokens.size() &&
  2680. head_p + n_match < prompt_tokens.size() &&
  2681. slot.cache_tokens[head_c + n_match] == prompt_tokens[head_p + n_match]) {
  2682. n_match++;
  2683. }
  2684. if (n_match >= (size_t) params_base.n_cache_reuse) {
  2685. SLT_INF(slot, "reusing chunk with size %zu, shifting KV cache [%zu, %zu) -> [%zu, %zu)\n", n_match, head_c, head_c + n_match, head_p, head_p + n_match);
  2686. //for (size_t i = head_p; i < head_p + n_match; i++) {
  2687. // SLT_DBG(slot, "cache token %3zu: %6d '%s'\n", i, prompt_tokens[i], common_token_to_piece(ctx, prompt_tokens[i]).c_str());
  2688. //}
  2689. const int64_t kv_shift = (int64_t) head_p - (int64_t) head_c;
  2690. llama_memory_seq_rm (llama_get_memory(ctx), slot.id, head_p, head_c);
  2691. llama_memory_seq_add(llama_get_memory(ctx), slot.id, head_c, head_c + n_match, kv_shift);
  2692. for (size_t i = 0; i < n_match; i++) {
  2693. slot.cache_tokens.set_token(head_p + i, slot.cache_tokens[head_c + i]);
  2694. slot.n_past++;
  2695. }
  2696. head_c += n_match;
  2697. head_p += n_match;
  2698. } else {
  2699. head_c += 1;
  2700. }
  2701. }
  2702. SLT_DBG(slot, "after context reuse, new slot.n_past = %d\n", slot.n_past);
  2703. }
  2704. } else {
  2705. // if we don't cache the prompt, we have to remove the entire KV cache
  2706. slot.n_past = 0;
  2707. }
  2708. if (slot.n_past > 0 && slot.n_past < (int) slot.cache_tokens.size()) {
  2709. const auto pos_min = llama_memory_seq_pos_min(llama_get_memory(ctx), slot.id);
  2710. if (pos_min == -1) {
  2711. SLT_ERR(slot, "n_past = %d, cache_tokens.size() = %d, seq_id = %d, pos_min = %d\n", slot.n_past, (int) slot.cache_tokens.size(), slot.id, pos_min);
  2712. GGML_ABORT("pos_min == -1, but n_past > 0 - should not happen: https://github.com/ggml-org/llama.cpp/pull/13833#discussion_r2116181237");
  2713. }
  2714. const auto n_swa = llama_model_n_swa(model);
  2715. if (pos_min > std::max(0, slot.n_past - n_swa)) {
  2716. SLT_WRN(slot, "n_past = %d, cache_tokens.size() = %d, seq_id = %d, pos_min = %d, n_swa = %d\n", slot.n_past, (int) slot.cache_tokens.size(), slot.id, pos_min, n_swa);
  2717. SLT_WRN(slot, "forcing full prompt re-processing due to lack of cache data (likely due to SWA, see %s)\n",
  2718. "https://github.com/ggml-org/llama.cpp/pull/13194#issuecomment-2868343055");
  2719. slot.n_past = 0;
  2720. }
  2721. }
  2722. }
  2723. if (slot.n_past == slot.n_prompt_tokens && slot.n_past > 0) {
  2724. SLT_WRN(slot, "need to evaluate at least 1 token for each active slot, n_past = %d, n_prompt_tokens = %d\n", slot.n_past, slot.n_prompt_tokens);
  2725. slot.n_past--;
  2726. }
  2727. slot.n_prompt_tokens_processed = 0;
  2728. }
  2729. if (!slot.can_split()) {
  2730. // cannot fit the prompt in the current batch - will try next iter
  2731. if (batch.n_tokens + slot.n_prompt_tokens > n_batch) {
  2732. continue;
  2733. }
  2734. }
  2735. // keep only the common part
  2736. if (!llama_memory_seq_rm(llama_get_memory(ctx), slot.id, slot.n_past, -1)) {
  2737. // could not partially delete (likely using a non-Transformer model)
  2738. llama_memory_seq_rm(llama_get_memory(ctx), slot.id, -1, -1);
  2739. // there is no common part left
  2740. slot.n_past = 0;
  2741. }
  2742. SLT_INF(slot, "kv cache rm [%d, end)\n", slot.n_past);
  2743. // remove the non-common part from the cache
  2744. slot.cache_tokens.keep_first(slot.n_past);
  2745. // check if we should process the image
  2746. if (slot.n_past < slot.n_prompt_tokens && slot.prompt_tokens[slot.n_past] == LLAMA_TOKEN_NULL) {
  2747. // process the image
  2748. int32_t new_n_past;
  2749. int32_t res = slot.prompt_tokens.process_chunk(ctx, mctx, slot.n_past, slot.id, new_n_past);
  2750. int32_t n_pos = new_n_past - slot.n_past;
  2751. if (res != 0) {
  2752. SLT_ERR(slot, "failed to process image, res = %d\n", res);
  2753. slot.release();
  2754. send_error(slot, "failed to process image", ERROR_TYPE_SERVER);
  2755. continue;
  2756. }
  2757. // add the image chunk to cache
  2758. {
  2759. const auto & chunk = slot.prompt_tokens.find_chunk(slot.n_past);
  2760. slot.cache_tokens.push_back(chunk.get()); // copy
  2761. }
  2762. slot.n_past += n_pos;
  2763. slot.n_prompt_tokens_processed += n_pos;
  2764. }
  2765. // add prompt tokens for processing in the current batch
  2766. while (slot.n_past < slot.n_prompt_tokens && batch.n_tokens < n_batch) {
  2767. // get next token to process
  2768. llama_token cur_tok = slot.prompt_tokens[slot.n_past];
  2769. if (cur_tok == LLAMA_TOKEN_NULL) {
  2770. break; // end of text chunk
  2771. }
  2772. // embedding requires all tokens in the batch to be output
  2773. const bool need_embd = server_task_type_need_embd(slot.task_type);
  2774. common_batch_add(batch, cur_tok, slot.n_past, { slot.id }, need_embd);
  2775. slot.cache_tokens.push_back(cur_tok);
  2776. slot.n_prompt_tokens_processed++;
  2777. slot.n_past++;
  2778. }
  2779. // SLT_INF(slot, "new cache_tokens: %s\n", slot.cache_tokens.str().c_str());
  2780. SLT_INF(slot, "prompt processing progress, n_past = %d, n_tokens = %d, progress = %f\n", slot.n_past, batch.n_tokens, (float) slot.n_prompt_tokens_processed / slot.n_prompt_tokens);
  2781. // entire prompt has been processed
  2782. if (slot.n_past == slot.n_prompt_tokens) {
  2783. slot.state = SLOT_STATE_DONE_PROMPT;
  2784. GGML_ASSERT(batch.n_tokens > 0);
  2785. GGML_ASSERT((size_t) slot.n_prompt_tokens == slot.prompt_tokens.size());
  2786. common_sampler_reset(slot.smpl);
  2787. // Process all prompt tokens through sampler system
  2788. for (int i = 0; i < slot.n_prompt_tokens; ++i) {
  2789. llama_token id = slot.prompt_tokens[i];
  2790. if (id != LLAMA_TOKEN_NULL) {
  2791. common_sampler_accept(slot.smpl, id, false);
  2792. }
  2793. }
  2794. // extract the logits only for the last token
  2795. batch.logits[batch.n_tokens - 1] = true;
  2796. slot.n_decoded = 0;
  2797. slot.i_batch = batch.n_tokens - 1;
  2798. SLT_INF(slot, "prompt done, n_past = %d, n_tokens = %d\n", slot.n_past, batch.n_tokens);
  2799. }
  2800. }
  2801. if (batch.n_tokens >= n_batch) {
  2802. break;
  2803. }
  2804. }
  2805. }
  2806. if (batch.n_tokens == 0) {
  2807. SRV_WRN("%s", "no tokens to decode\n");
  2808. return;
  2809. }
  2810. SRV_DBG("decoding batch, n_tokens = %d\n", batch.n_tokens);
  2811. if (slot_batched) {
  2812. // apply lora, only need to do it once per batch
  2813. common_set_adapter_lora(ctx, slot_batched->lora);
  2814. llama_set_embeddings(ctx, slot_batched->need_embd());
  2815. }
  2816. int32_t i_next = 0;
  2817. // process the created batch of tokens
  2818. for (int32_t i = 0; i < batch.n_tokens; i = i_next) {
  2819. const int32_t n_tokens = std::min(n_batch, batch.n_tokens - i);
  2820. llama_batch batch_view = {
  2821. n_tokens,
  2822. batch.token + i,
  2823. nullptr,
  2824. batch.pos + i,
  2825. batch.n_seq_id + i,
  2826. batch.seq_id + i,
  2827. batch.logits + i,
  2828. };
  2829. const int ret = llama_decode(ctx, batch_view);
  2830. metrics.on_decoded(slots);
  2831. if (ret != 0) {
  2832. {
  2833. std::string err;
  2834. if (n_batch == 1 && ret == 1) {
  2835. err = "Context size has been exceeded.";
  2836. }
  2837. if (ret == -1) {
  2838. err = "Invalid input batch.";
  2839. }
  2840. if (ret < -1) {
  2841. // TODO: update slot state based on llama_memory_seq_pos_min() and llama_memory_seq_pos_max()
  2842. err = "Compute error.";
  2843. }
  2844. // TODO: handle ret == 2 (abort) when we start aborting
  2845. if (!err.empty()) {
  2846. SRV_ERR("%s, i = %d, n_batch = %d, ret = %d\n", err.c_str(), i, n_batch, ret);
  2847. for (auto & slot : slots) {
  2848. slot.release();
  2849. send_error(slot, err);
  2850. }
  2851. break;
  2852. }
  2853. }
  2854. // retry with half the batch size to try to find a free slot in the KV cache
  2855. n_batch /= 2;
  2856. SRV_WRN("failed to find free space in the KV cache, retrying with smaller batch size, i = %d, n_batch = %d, ret = %d\n", i, n_batch, ret);
  2857. continue; // continue loop of n_batch
  2858. }
  2859. // move the head of the batch forward with the number of tokens we just processed
  2860. i_next = i + n_tokens;
  2861. // on successful decode, restore the original batch size
  2862. n_batch = llama_n_batch(ctx);
  2863. for (auto & slot : slots) {
  2864. if (slot.i_batch < (int) i || slot.i_batch >= (int) (i + n_tokens)) {
  2865. continue; // continue loop of slots
  2866. }
  2867. if (slot.state == SLOT_STATE_DONE_PROMPT) {
  2868. if (slot.task_type == SERVER_TASK_TYPE_EMBEDDING) {
  2869. // prompt evaluated for embedding
  2870. send_embedding(slot, batch_view);
  2871. slot.release();
  2872. slot.i_batch = -1;
  2873. continue; // continue loop of slots
  2874. }
  2875. if (slot.task_type == SERVER_TASK_TYPE_RERANK) {
  2876. send_rerank(slot, batch_view);
  2877. slot.release();
  2878. slot.i_batch = -1;
  2879. continue; // continue loop of slots
  2880. }
  2881. // prompt evaluated for next-token prediction
  2882. slot.state = SLOT_STATE_GENERATING;
  2883. } else if (slot.state != SLOT_STATE_GENERATING) {
  2884. continue; // continue loop of slots
  2885. }
  2886. const int tok_idx = slot.i_batch - i;
  2887. llama_token id = common_sampler_sample(slot.smpl, ctx, tok_idx);
  2888. slot.i_batch = -1;
  2889. common_sampler_accept(slot.smpl, id, true);
  2890. slot.n_decoded += 1;
  2891. const int64_t t_current = ggml_time_us();
  2892. if (slot.n_decoded == 1) {
  2893. slot.t_start_generation = t_current;
  2894. slot.t_prompt_processing = (slot.t_start_generation - slot.t_start_process_prompt) / 1e3;
  2895. metrics.on_prompt_eval(slot);
  2896. }
  2897. slot.t_token_generation = (t_current - slot.t_start_generation) / 1e3;
  2898. completion_token_output result;
  2899. result.tok = id;
  2900. result.text_to_send = common_token_to_piece(ctx, result.tok, accept_special_token(slot, result.tok));
  2901. result.prob = 1.0f; // TODO: set it here instead of doing inside populate_token_probs
  2902. if (slot.params.sampling.n_probs > 0) {
  2903. populate_token_probs(slot, result, slot.params.post_sampling_probs, params_base.special, tok_idx);
  2904. }
  2905. if (!process_token(result, slot)) {
  2906. // release slot because of stop condition
  2907. slot.release();
  2908. slot.print_timings();
  2909. send_final_response(slot);
  2910. metrics.on_prediction(slot);
  2911. continue;
  2912. }
  2913. }
  2914. // do speculative decoding
  2915. for (auto & slot : slots) {
  2916. if (!slot.is_processing() || !slot.can_speculate()) {
  2917. continue;
  2918. }
  2919. if (slot.state != SLOT_STATE_GENERATING) {
  2920. continue;
  2921. }
  2922. if (mctx) {
  2923. // we should never reach this, as speculative is automatically disabled if mmproj is loaded
  2924. GGML_ABORT("not supported by multimodal");
  2925. }
  2926. // determine the max draft that fits the current slot state
  2927. int n_draft_max = slot.params.speculative.n_max;
  2928. // note: n_past is not yet increased for the `id` token sampled above
  2929. // also, need to leave space for 1 extra token to allow context shifts
  2930. n_draft_max = std::min(n_draft_max, slot.n_ctx - slot.n_past - 2);
  2931. if (slot.n_remaining > 0) {
  2932. n_draft_max = std::min(n_draft_max, slot.n_remaining - 1);
  2933. }
  2934. SLT_DBG(slot, "max possible draft: %d\n", n_draft_max);
  2935. if (n_draft_max < slot.params.speculative.n_min) {
  2936. SLT_DBG(slot, "the max possible draft is too small: %d < %d - skipping speculative decoding\n", n_draft_max, slot.params.speculative.n_min);
  2937. continue;
  2938. }
  2939. llama_token id = slot.sampled;
  2940. struct common_speculative_params params_spec;
  2941. params_spec.n_draft = n_draft_max;
  2942. params_spec.n_reuse = llama_n_ctx(slot.ctx_dft) - slot.params.speculative.n_max;
  2943. params_spec.p_min = slot.params.speculative.p_min;
  2944. const llama_tokens & cached_text_tokens = slot.cache_tokens.get_text_tokens();
  2945. llama_tokens draft = common_speculative_gen_draft(slot.spec, params_spec, cached_text_tokens, id);
  2946. // ignore small drafts
  2947. if (slot.params.speculative.n_min > (int) draft.size()) {
  2948. SLT_DBG(slot, "ignoring small draft: %d < %d\n", (int) draft.size(), slot.params.speculative.n_min);
  2949. continue;
  2950. }
  2951. // keep track of total number of drafted tokens tested
  2952. slot.n_draft_total += draft.size();
  2953. // construct the speculation batch
  2954. common_batch_clear(slot.batch_spec);
  2955. common_batch_add (slot.batch_spec, id, slot.n_past, { slot.id }, true);
  2956. for (size_t i = 0; i < draft.size(); ++i) {
  2957. common_batch_add(slot.batch_spec, draft[i], slot.n_past + 1 + i, { slot.id }, true);
  2958. }
  2959. SLT_DBG(slot, "decoding speculative batch, size = %d\n", slot.batch_spec.n_tokens);
  2960. llama_decode(ctx, slot.batch_spec);
  2961. // the accepted tokens from the speculation
  2962. const auto ids = common_sampler_sample_and_accept_n(slot.smpl, ctx, draft);
  2963. slot.n_past += ids.size();
  2964. slot.n_decoded += ids.size();
  2965. // update how many tokens out of those tested were accepted
  2966. slot.n_draft_accepted += ids.size() - 1;
  2967. slot.cache_tokens.push_back(id);
  2968. slot.cache_tokens.insert({ids.begin(), ids.end() - 1});
  2969. llama_memory_seq_rm(llama_get_memory(ctx), slot.id, slot.n_past, -1);
  2970. for (size_t i = 0; i < ids.size(); ++i) {
  2971. completion_token_output result;
  2972. result.tok = ids[i];
  2973. result.text_to_send = common_token_to_piece(ctx, result.tok, accept_special_token(slot, result.tok));
  2974. result.prob = 1.0f; // set later
  2975. // TODO: set result.probs
  2976. if (!process_token(result, slot)) {
  2977. // release slot because of stop condition
  2978. slot.release();
  2979. slot.print_timings();
  2980. send_final_response(slot);
  2981. metrics.on_prediction(slot);
  2982. break;
  2983. }
  2984. }
  2985. SLT_DBG(slot, "accepted %d/%d draft tokens, new n_past = %d\n", (int) ids.size() - 1, (int) draft.size(), slot.n_past);
  2986. }
  2987. }
  2988. SRV_DBG("%s", "run slots completed\n");
  2989. }
  2990. json model_meta() const {
  2991. return json {
  2992. {"vocab_type", llama_vocab_type (vocab)},
  2993. {"n_vocab", llama_vocab_n_tokens (vocab)},
  2994. {"n_ctx_train", llama_model_n_ctx_train(model)},
  2995. {"n_embd", llama_model_n_embd (model)},
  2996. {"n_params", llama_model_n_params (model)},
  2997. {"size", llama_model_size (model)},
  2998. };
  2999. }
  3000. };
  3001. static void log_server_request(const httplib::Request & req, const httplib::Response & res) {
  3002. // skip GH copilot requests when using default port
  3003. if (req.path == "/v1/health" || req.path == "/v1/completions") {
  3004. return;
  3005. }
  3006. // reminder: this function is not covered by httplib's exception handler; if someone does more complicated stuff, think about wrapping it in try-catch
  3007. SRV_INF("request: %s %s %s %d\n", req.method.c_str(), req.path.c_str(), req.remote_addr.c_str(), res.status);
  3008. SRV_DBG("request: %s\n", req.body.c_str());
  3009. SRV_DBG("response: %s\n", res.body.c_str());
  3010. }
  3011. std::function<void(int)> shutdown_handler;
  3012. std::atomic_flag is_terminating = ATOMIC_FLAG_INIT;
  3013. inline void signal_handler(int signal) {
  3014. if (is_terminating.test_and_set()) {
  3015. // in case it hangs, we can force terminate the server by hitting Ctrl+C twice
  3016. // this is for better developer experience, we can remove when the server is stable enough
  3017. fprintf(stderr, "Received second interrupt, terminating immediately.\n");
  3018. exit(1);
  3019. }
  3020. shutdown_handler(signal);
  3021. }
  3022. int main(int argc, char ** argv) {
  3023. // own arguments required by this example
  3024. common_params params;
  3025. if (!common_params_parse(argc, argv, params, LLAMA_EXAMPLE_SERVER)) {
  3026. return 1;
  3027. }
  3028. common_init();
  3029. // struct that contains llama context and inference
  3030. server_context ctx_server;
  3031. llama_backend_init();
  3032. llama_numa_init(params.numa);
  3033. LOG_INF("system info: n_threads = %d, n_threads_batch = %d, total_threads = %d\n", params.cpuparams.n_threads, params.cpuparams_batch.n_threads, std::thread::hardware_concurrency());
  3034. LOG_INF("\n");
  3035. LOG_INF("%s\n", common_params_get_system_info(params).c_str());
  3036. LOG_INF("\n");
  3037. std::unique_ptr<httplib::Server> svr;
  3038. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  3039. if (params.ssl_file_key != "" && params.ssl_file_cert != "") {
  3040. LOG_INF("Running with SSL: key = %s, cert = %s\n", params.ssl_file_key.c_str(), params.ssl_file_cert.c_str());
  3041. svr.reset(
  3042. new httplib::SSLServer(params.ssl_file_cert.c_str(), params.ssl_file_key.c_str())
  3043. );
  3044. } else {
  3045. LOG_INF("Running without SSL\n");
  3046. svr.reset(new httplib::Server());
  3047. }
  3048. #else
  3049. if (params.ssl_file_key != "" && params.ssl_file_cert != "") {
  3050. LOG_ERR("Server is built without SSL support\n");
  3051. return 1;
  3052. }
  3053. svr.reset(new httplib::Server());
  3054. #endif
  3055. std::atomic<server_state> state{SERVER_STATE_LOADING_MODEL};
  3056. svr->set_default_headers({{"Server", "llama.cpp"}});
  3057. svr->set_logger(log_server_request);
  3058. auto res_error = [](httplib::Response & res, const json & error_data) {
  3059. json final_response {{"error", error_data}};
  3060. res.set_content(safe_json_to_str(final_response), MIMETYPE_JSON);
  3061. res.status = json_value(error_data, "code", 500);
  3062. };
  3063. auto res_ok = [](httplib::Response & res, const json & data) {
  3064. res.set_content(safe_json_to_str(data), MIMETYPE_JSON);
  3065. res.status = 200;
  3066. };
  3067. svr->set_exception_handler([&res_error](const httplib::Request &, httplib::Response & res, const std::exception_ptr & ep) {
  3068. std::string message;
  3069. try {
  3070. std::rethrow_exception(ep);
  3071. } catch (const std::exception & e) {
  3072. message = e.what();
  3073. } catch (...) {
  3074. message = "Unknown Exception";
  3075. }
  3076. try {
  3077. json formatted_error = format_error_response(message, ERROR_TYPE_SERVER);
  3078. LOG_WRN("got exception: %s\n", formatted_error.dump().c_str());
  3079. res_error(res, formatted_error);
  3080. } catch (const std::exception & e) {
  3081. LOG_ERR("got another exception: %s | while hanlding exception: %s\n", e.what(), message.c_str());
  3082. }
  3083. });
  3084. svr->set_error_handler([&res_error](const httplib::Request &, httplib::Response & res) {
  3085. if (res.status == 404) {
  3086. res_error(res, format_error_response("File Not Found", ERROR_TYPE_NOT_FOUND));
  3087. }
  3088. // for other error codes, we skip processing here because it's already done by res_error()
  3089. });
  3090. // set timeouts and change hostname and port
  3091. svr->set_read_timeout (params.timeout_read);
  3092. svr->set_write_timeout(params.timeout_write);
  3093. std::unordered_map<std::string, std::string> log_data;
  3094. log_data["hostname"] = params.hostname;
  3095. log_data["port"] = std::to_string(params.port);
  3096. if (params.api_keys.size() == 1) {
  3097. auto key = params.api_keys[0];
  3098. log_data["api_key"] = "api_key: ****" + key.substr(std::max((int)(key.length() - 4), 0));
  3099. } else if (params.api_keys.size() > 1) {
  3100. log_data["api_key"] = "api_key: " + std::to_string(params.api_keys.size()) + " keys loaded";
  3101. }
  3102. // Necessary similarity of prompt for slot selection
  3103. ctx_server.slot_prompt_similarity = params.slot_prompt_similarity;
  3104. //
  3105. // Middlewares
  3106. //
  3107. auto middleware_validate_api_key = [&params, &res_error](const httplib::Request & req, httplib::Response & res) {
  3108. static const std::unordered_set<std::string> public_endpoints = {
  3109. "/health",
  3110. "/models",
  3111. "/v1/models",
  3112. "/api/tags"
  3113. };
  3114. // If API key is not set, skip validation
  3115. if (params.api_keys.empty()) {
  3116. return true;
  3117. }
  3118. // If path is public or is static file, skip validation
  3119. if (public_endpoints.find(req.path) != public_endpoints.end() || req.path == "/") {
  3120. return true;
  3121. }
  3122. // Check for API key in the header
  3123. auto auth_header = req.get_header_value("Authorization");
  3124. std::string prefix = "Bearer ";
  3125. if (auth_header.substr(0, prefix.size()) == prefix) {
  3126. std::string received_api_key = auth_header.substr(prefix.size());
  3127. if (std::find(params.api_keys.begin(), params.api_keys.end(), received_api_key) != params.api_keys.end()) {
  3128. return true; // API key is valid
  3129. }
  3130. }
  3131. // API key is invalid or not provided
  3132. res_error(res, format_error_response("Invalid API Key", ERROR_TYPE_AUTHENTICATION));
  3133. LOG_WRN("Unauthorized: Invalid API Key\n");
  3134. return false;
  3135. };
  3136. auto middleware_server_state = [&res_error, &state](const httplib::Request & req, httplib::Response & res) {
  3137. server_state current_state = state.load();
  3138. if (current_state == SERVER_STATE_LOADING_MODEL) {
  3139. auto tmp = string_split<std::string>(req.path, '.');
  3140. if (req.path == "/" || tmp.back() == "html") {
  3141. res.set_content(reinterpret_cast<const char*>(loading_html), loading_html_len, "text/html; charset=utf-8");
  3142. res.status = 503;
  3143. } else if (req.path == "/models" || req.path == "/v1/models" || req.path == "/api/tags") {
  3144. // allow the models endpoint to be accessed during loading
  3145. return true;
  3146. } else {
  3147. res_error(res, format_error_response("Loading model", ERROR_TYPE_UNAVAILABLE));
  3148. }
  3149. return false;
  3150. }
  3151. return true;
  3152. };
  3153. // register server middlewares
  3154. svr->set_pre_routing_handler([&middleware_validate_api_key, &middleware_server_state](const httplib::Request & req, httplib::Response & res) {
  3155. res.set_header("Access-Control-Allow-Origin", req.get_header_value("Origin"));
  3156. // If this is OPTIONS request, skip validation because browsers don't include Authorization header
  3157. if (req.method == "OPTIONS") {
  3158. res.set_header("Access-Control-Allow-Credentials", "true");
  3159. res.set_header("Access-Control-Allow-Methods", "GET, POST");
  3160. res.set_header("Access-Control-Allow-Headers", "*");
  3161. res.set_content("", "text/html"); // blank response, no data
  3162. return httplib::Server::HandlerResponse::Handled; // skip further processing
  3163. }
  3164. if (!middleware_server_state(req, res)) {
  3165. return httplib::Server::HandlerResponse::Handled;
  3166. }
  3167. if (!middleware_validate_api_key(req, res)) {
  3168. return httplib::Server::HandlerResponse::Handled;
  3169. }
  3170. return httplib::Server::HandlerResponse::Unhandled;
  3171. });
  3172. //
  3173. // Route handlers (or controllers)
  3174. //
  3175. const auto handle_health = [&](const httplib::Request &, httplib::Response & res) {
  3176. // error and loading states are handled by middleware
  3177. json health = {{"status", "ok"}};
  3178. res_ok(res, health);
  3179. };
  3180. const auto handle_slots = [&](const httplib::Request & req, httplib::Response & res) {
  3181. if (!params.endpoint_slots) {
  3182. res_error(res, format_error_response("This server does not support slots endpoint. Start it with `--slots`", ERROR_TYPE_NOT_SUPPORTED));
  3183. return;
  3184. }
  3185. // request slots data using task queue
  3186. int task_id = ctx_server.queue_tasks.get_new_id();
  3187. {
  3188. server_task task(SERVER_TASK_TYPE_METRICS);
  3189. task.id = task_id;
  3190. ctx_server.queue_results.add_waiting_task_id(task_id);
  3191. ctx_server.queue_tasks.post(std::move(task), true); // high-priority task
  3192. }
  3193. // get the result
  3194. server_task_result_ptr result = ctx_server.queue_results.recv(task_id);
  3195. ctx_server.queue_results.remove_waiting_task_id(task_id);
  3196. if (result->is_error()) {
  3197. res_error(res, result->to_json());
  3198. return;
  3199. }
  3200. // TODO: get rid of this dynamic_cast
  3201. auto res_metrics = dynamic_cast<server_task_result_metrics*>(result.get());
  3202. GGML_ASSERT(res_metrics != nullptr);
  3203. // optionally return "fail_on_no_slot" error
  3204. if (req.has_param("fail_on_no_slot")) {
  3205. if (res_metrics->n_idle_slots == 0) {
  3206. res_error(res, format_error_response("no slot available", ERROR_TYPE_UNAVAILABLE));
  3207. return;
  3208. }
  3209. }
  3210. res_ok(res, res_metrics->slots_data);
  3211. };
  3212. const auto handle_metrics = [&](const httplib::Request &, httplib::Response & res) {
  3213. if (!params.endpoint_metrics) {
  3214. res_error(res, format_error_response("This server does not support metrics endpoint. Start it with `--metrics`", ERROR_TYPE_NOT_SUPPORTED));
  3215. return;
  3216. }
  3217. // request slots data using task queue
  3218. int task_id = ctx_server.queue_tasks.get_new_id();
  3219. {
  3220. server_task task(SERVER_TASK_TYPE_METRICS);
  3221. task.id = task_id;
  3222. ctx_server.queue_results.add_waiting_task_id(task_id);
  3223. ctx_server.queue_tasks.post(std::move(task), true); // high-priority task
  3224. }
  3225. // get the result
  3226. server_task_result_ptr result = ctx_server.queue_results.recv(task_id);
  3227. ctx_server.queue_results.remove_waiting_task_id(task_id);
  3228. if (result->is_error()) {
  3229. res_error(res, result->to_json());
  3230. return;
  3231. }
  3232. // TODO: get rid of this dynamic_cast
  3233. auto res_metrics = dynamic_cast<server_task_result_metrics*>(result.get());
  3234. GGML_ASSERT(res_metrics != nullptr);
  3235. // metrics definition: https://prometheus.io/docs/practices/naming/#metric-names
  3236. json all_metrics_def = json {
  3237. {"counter", {{
  3238. {"name", "prompt_tokens_total"},
  3239. {"help", "Number of prompt tokens processed."},
  3240. {"value", (uint64_t) res_metrics->n_prompt_tokens_processed_total}
  3241. }, {
  3242. {"name", "prompt_seconds_total"},
  3243. {"help", "Prompt process time"},
  3244. {"value", (uint64_t) res_metrics->t_prompt_processing_total / 1.e3}
  3245. }, {
  3246. {"name", "tokens_predicted_total"},
  3247. {"help", "Number of generation tokens processed."},
  3248. {"value", (uint64_t) res_metrics->n_tokens_predicted_total}
  3249. }, {
  3250. {"name", "tokens_predicted_seconds_total"},
  3251. {"help", "Predict process time"},
  3252. {"value", (uint64_t) res_metrics->t_tokens_generation_total / 1.e3}
  3253. }, {
  3254. {"name", "n_decode_total"},
  3255. {"help", "Total number of llama_decode() calls"},
  3256. {"value", res_metrics->n_decode_total}
  3257. }, {
  3258. {"name", "n_busy_slots_per_decode"},
  3259. {"help", "Average number of busy slots per llama_decode() call"},
  3260. {"value", (float) res_metrics->n_busy_slots_total / std::max((float) res_metrics->n_decode_total, 1.f)}
  3261. }}},
  3262. {"gauge", {{
  3263. {"name", "prompt_tokens_seconds"},
  3264. {"help", "Average prompt throughput in tokens/s."},
  3265. {"value", res_metrics->n_prompt_tokens_processed ? 1.e3 / res_metrics->t_prompt_processing * res_metrics->n_prompt_tokens_processed : 0.}
  3266. },{
  3267. {"name", "predicted_tokens_seconds"},
  3268. {"help", "Average generation throughput in tokens/s."},
  3269. {"value", res_metrics->n_tokens_predicted ? 1.e3 / res_metrics->t_tokens_generation * res_metrics->n_tokens_predicted : 0.}
  3270. },{
  3271. {"name", "requests_processing"},
  3272. {"help", "Number of requests processing."},
  3273. {"value", (uint64_t) res_metrics->n_processing_slots}
  3274. },{
  3275. {"name", "requests_deferred"},
  3276. {"help", "Number of requests deferred."},
  3277. {"value", (uint64_t) res_metrics->n_tasks_deferred}
  3278. }}}
  3279. };
  3280. std::stringstream prometheus;
  3281. for (const auto & el : all_metrics_def.items()) {
  3282. const auto & type = el.key();
  3283. const auto & metrics_def = el.value();
  3284. for (const auto & metric_def : metrics_def) {
  3285. const std::string name = metric_def.at("name");
  3286. const std::string help = metric_def.at("help");
  3287. auto value = json_value(metric_def, "value", 0.);
  3288. prometheus << "# HELP llamacpp:" << name << " " << help << "\n"
  3289. << "# TYPE llamacpp:" << name << " " << type << "\n"
  3290. << "llamacpp:" << name << " " << value << "\n";
  3291. }
  3292. }
  3293. res.set_header("Process-Start-Time-Unix", std::to_string(res_metrics->t_start));
  3294. res.set_content(prometheus.str(), "text/plain; version=0.0.4");
  3295. res.status = 200; // HTTP OK
  3296. };
  3297. const auto handle_slots_save = [&ctx_server, &res_error, &res_ok, &params](const httplib::Request & req, httplib::Response & res, int id_slot) {
  3298. json request_data = json::parse(req.body);
  3299. std::string filename = request_data.at("filename");
  3300. if (!fs_validate_filename(filename)) {
  3301. res_error(res, format_error_response("Invalid filename", ERROR_TYPE_INVALID_REQUEST));
  3302. return;
  3303. }
  3304. std::string filepath = params.slot_save_path + filename;
  3305. int task_id = ctx_server.queue_tasks.get_new_id();
  3306. {
  3307. server_task task(SERVER_TASK_TYPE_SLOT_SAVE);
  3308. task.id = task_id;
  3309. task.slot_action.slot_id = id_slot;
  3310. task.slot_action.filename = filename;
  3311. task.slot_action.filepath = filepath;
  3312. ctx_server.queue_results.add_waiting_task_id(task_id);
  3313. ctx_server.queue_tasks.post(std::move(task));
  3314. }
  3315. server_task_result_ptr result = ctx_server.queue_results.recv(task_id);
  3316. ctx_server.queue_results.remove_waiting_task_id(task_id);
  3317. if (result->is_error()) {
  3318. res_error(res, result->to_json());
  3319. return;
  3320. }
  3321. res_ok(res, result->to_json());
  3322. };
  3323. const auto handle_slots_restore = [&ctx_server, &res_error, &res_ok, &params](const httplib::Request & req, httplib::Response & res, int id_slot) {
  3324. json request_data = json::parse(req.body);
  3325. std::string filename = request_data.at("filename");
  3326. if (!fs_validate_filename(filename)) {
  3327. res_error(res, format_error_response("Invalid filename", ERROR_TYPE_INVALID_REQUEST));
  3328. return;
  3329. }
  3330. std::string filepath = params.slot_save_path + filename;
  3331. int task_id = ctx_server.queue_tasks.get_new_id();
  3332. {
  3333. server_task task(SERVER_TASK_TYPE_SLOT_RESTORE);
  3334. task.id = task_id;
  3335. task.slot_action.slot_id = id_slot;
  3336. task.slot_action.filename = filename;
  3337. task.slot_action.filepath = filepath;
  3338. ctx_server.queue_results.add_waiting_task_id(task_id);
  3339. ctx_server.queue_tasks.post(std::move(task));
  3340. }
  3341. server_task_result_ptr result = ctx_server.queue_results.recv(task_id);
  3342. ctx_server.queue_results.remove_waiting_task_id(task_id);
  3343. if (result->is_error()) {
  3344. res_error(res, result->to_json());
  3345. return;
  3346. }
  3347. GGML_ASSERT(dynamic_cast<server_task_result_slot_save_load*>(result.get()) != nullptr);
  3348. res_ok(res, result->to_json());
  3349. };
  3350. const auto handle_slots_erase = [&ctx_server, &res_error, &res_ok](const httplib::Request & /* req */, httplib::Response & res, int id_slot) {
  3351. int task_id = ctx_server.queue_tasks.get_new_id();
  3352. {
  3353. server_task task(SERVER_TASK_TYPE_SLOT_ERASE);
  3354. task.id = task_id;
  3355. task.slot_action.slot_id = id_slot;
  3356. ctx_server.queue_results.add_waiting_task_id(task_id);
  3357. ctx_server.queue_tasks.post(std::move(task));
  3358. }
  3359. server_task_result_ptr result = ctx_server.queue_results.recv(task_id);
  3360. ctx_server.queue_results.remove_waiting_task_id(task_id);
  3361. if (result->is_error()) {
  3362. res_error(res, result->to_json());
  3363. return;
  3364. }
  3365. GGML_ASSERT(dynamic_cast<server_task_result_slot_erase*>(result.get()) != nullptr);
  3366. res_ok(res, result->to_json());
  3367. };
  3368. const auto handle_slots_action = [&params, &res_error, &handle_slots_save, &handle_slots_restore, &handle_slots_erase](const httplib::Request & req, httplib::Response & res) {
  3369. if (params.slot_save_path.empty()) {
  3370. res_error(res, format_error_response("This server does not support slots action. Start it with `--slot-save-path`", ERROR_TYPE_NOT_SUPPORTED));
  3371. return;
  3372. }
  3373. std::string id_slot_str = req.path_params.at("id_slot");
  3374. int id_slot;
  3375. try {
  3376. id_slot = std::stoi(id_slot_str);
  3377. } catch (const std::exception &) {
  3378. res_error(res, format_error_response("Invalid slot ID", ERROR_TYPE_INVALID_REQUEST));
  3379. return;
  3380. }
  3381. std::string action = req.get_param_value("action");
  3382. if (action == "save") {
  3383. handle_slots_save(req, res, id_slot);
  3384. } else if (action == "restore") {
  3385. handle_slots_restore(req, res, id_slot);
  3386. } else if (action == "erase") {
  3387. handle_slots_erase(req, res, id_slot);
  3388. } else {
  3389. res_error(res, format_error_response("Invalid action", ERROR_TYPE_INVALID_REQUEST));
  3390. }
  3391. };
  3392. const auto handle_props = [&ctx_server, &res_ok](const httplib::Request &, httplib::Response & res) {
  3393. // this endpoint is publicly available, please only return what is safe to be exposed
  3394. json data = {
  3395. { "default_generation_settings", ctx_server.default_generation_settings_for_props },
  3396. { "total_slots", ctx_server.params_base.n_parallel },
  3397. { "model_path", ctx_server.params_base.model.path },
  3398. { "modalities", json{
  3399. {"vision", ctx_server.oai_parser_opt.allow_image},
  3400. {"audio", ctx_server.oai_parser_opt.allow_audio},
  3401. } },
  3402. { "chat_template", common_chat_templates_source(ctx_server.chat_templates.get()) },
  3403. { "bos_token", common_token_to_piece(ctx_server.ctx, llama_vocab_bos(ctx_server.vocab), /* special= */ true)},
  3404. { "eos_token", common_token_to_piece(ctx_server.ctx, llama_vocab_eos(ctx_server.vocab), /* special= */ true)},
  3405. { "build_info", build_info },
  3406. };
  3407. if (ctx_server.params_base.use_jinja) {
  3408. if (auto tool_use_src = common_chat_templates_source(ctx_server.chat_templates.get(), "tool_use")) {
  3409. data["chat_template_tool_use"] = tool_use_src;
  3410. }
  3411. }
  3412. res_ok(res, data);
  3413. };
  3414. const auto handle_props_change = [&ctx_server, &res_error, &res_ok](const httplib::Request & req, httplib::Response & res) {
  3415. if (!ctx_server.params_base.endpoint_props) {
  3416. res_error(res, format_error_response("This server does not support changing global properties. Start it with `--props`", ERROR_TYPE_NOT_SUPPORTED));
  3417. return;
  3418. }
  3419. json data = json::parse(req.body);
  3420. // update any props here
  3421. res_ok(res, {{ "success", true }});
  3422. };
  3423. const auto handle_api_show = [&ctx_server, &res_ok](const httplib::Request &, httplib::Response & res) {
  3424. json data = {
  3425. {
  3426. "template", common_chat_templates_source(ctx_server.chat_templates.get()),
  3427. },
  3428. {
  3429. "model_info", {
  3430. { "llama.context_length", ctx_server.slots.back().n_ctx, },
  3431. }
  3432. },
  3433. {"modelfile", ""},
  3434. {"parameters", ""},
  3435. {"template", common_chat_templates_source(ctx_server.chat_templates.get())},
  3436. {"details", {
  3437. {"parent_model", ""},
  3438. {"format", "gguf"},
  3439. {"family", ""},
  3440. {"families", {""}},
  3441. {"parameter_size", ""},
  3442. {"quantization_level", ""}
  3443. }},
  3444. {"model_info", ""},
  3445. {"capabilities", {"completion"}}
  3446. };
  3447. res_ok(res, data);
  3448. };
  3449. // handle completion-like requests (completion, chat, infill)
  3450. // we can optionally provide a custom format for partial results and final results
  3451. const auto handle_completions_impl = [&ctx_server, &res_error, &res_ok](
  3452. server_task_type type,
  3453. json & data,
  3454. const std::vector<raw_buffer> & files,
  3455. const std::function<bool()> & is_connection_closed,
  3456. httplib::Response & res,
  3457. oaicompat_type oaicompat) -> void {
  3458. GGML_ASSERT(type == SERVER_TASK_TYPE_COMPLETION || type == SERVER_TASK_TYPE_INFILL);
  3459. auto completion_id = gen_chatcmplid();
  3460. std::unordered_set<int> task_ids;
  3461. try {
  3462. std::vector<server_task> tasks;
  3463. const auto & prompt = data.at("prompt");
  3464. // TODO: this log can become very long, put it behind a flag or think about a more compact format
  3465. //SRV_DBG("Prompt: %s\n", prompt.is_string() ? prompt.get<std::string>().c_str() : prompt.dump(2).c_str());
  3466. // process files
  3467. mtmd::bitmaps bitmaps;
  3468. const bool has_mtmd = ctx_server.mctx != nullptr;
  3469. {
  3470. if (!has_mtmd && !files.empty()) {
  3471. throw std::runtime_error("This server does not support multimodal");
  3472. }
  3473. for (auto & file : files) {
  3474. mtmd::bitmap bmp(mtmd_helper_bitmap_init_from_buf(ctx_server.mctx, file.data(), file.size()));
  3475. if (!bmp.ptr) {
  3476. throw std::runtime_error("Failed to load image or audio file");
  3477. }
  3478. // calculate bitmap hash (for KV caching)
  3479. std::string hash = fnv_hash(bmp.data(), bmp.n_bytes());
  3480. bmp.set_id(hash.c_str());
  3481. bitmaps.entries.push_back(std::move(bmp));
  3482. }
  3483. }
  3484. // process prompt
  3485. std::vector<server_tokens> inputs;
  3486. if (oaicompat && !prompt.is_string()) {
  3487. throw std::runtime_error("prompt must be a string");
  3488. }
  3489. if (oaicompat && has_mtmd) {
  3490. // multimodal
  3491. std::string prompt_str = prompt.get<std::string>();
  3492. mtmd_input_text inp_txt = {
  3493. prompt_str.c_str(),
  3494. /* add_special */ true,
  3495. /* parse_special */ true,
  3496. };
  3497. mtmd::input_chunks chunks(mtmd_input_chunks_init());
  3498. auto bitmaps_c_ptr = bitmaps.c_ptr();
  3499. int32_t tokenized = mtmd_tokenize(ctx_server.mctx,
  3500. chunks.ptr.get(),
  3501. &inp_txt,
  3502. bitmaps_c_ptr.data(),
  3503. bitmaps_c_ptr.size());
  3504. if (tokenized != 0) {
  3505. throw std::runtime_error("Failed to tokenize prompt");
  3506. }
  3507. server_tokens tmp(chunks, true);
  3508. inputs.push_back(std::move(tmp));
  3509. } else {
  3510. // non-multimodal version
  3511. auto tokenized_prompts = tokenize_input_prompts(ctx_server.vocab, prompt, true, true);
  3512. for (auto & p : tokenized_prompts) {
  3513. auto tmp = server_tokens(p, ctx_server.mctx != nullptr);
  3514. inputs.push_back(std::move(tmp));
  3515. }
  3516. }
  3517. tasks.reserve(inputs.size());
  3518. for (size_t i = 0; i < inputs.size(); i++) {
  3519. server_task task = server_task(type);
  3520. task.id = ctx_server.queue_tasks.get_new_id();
  3521. task.index = i;
  3522. task.prompt_tokens = std::move(inputs[i]);
  3523. task.params = server_task::params_from_json_cmpl(
  3524. ctx_server.ctx,
  3525. ctx_server.params_base,
  3526. data);
  3527. task.id_selected_slot = json_value(data, "id_slot", -1);
  3528. // OAI-compat
  3529. task.params.oaicompat = oaicompat;
  3530. task.params.oaicompat_cmpl_id = completion_id;
  3531. // oaicompat_model is already populated by params_from_json_cmpl
  3532. tasks.push_back(std::move(task));
  3533. }
  3534. task_ids = server_task::get_list_id(tasks);
  3535. ctx_server.queue_results.add_waiting_tasks(tasks);
  3536. ctx_server.queue_tasks.post(std::move(tasks));
  3537. } catch (const std::exception & e) {
  3538. res_error(res, format_error_response(e.what(), ERROR_TYPE_INVALID_REQUEST));
  3539. return;
  3540. }
  3541. bool stream = json_value(data, "stream", false);
  3542. if (!stream) {
  3543. ctx_server.receive_multi_results(task_ids, [&](std::vector<server_task_result_ptr> & results) {
  3544. if (results.size() == 1) {
  3545. // single result
  3546. res_ok(res, results[0]->to_json());
  3547. } else {
  3548. // multiple results (multitask)
  3549. json arr = json::array();
  3550. for (auto & res : results) {
  3551. arr.push_back(res->to_json());
  3552. }
  3553. res_ok(res, arr);
  3554. }
  3555. }, [&](const json & error_data) {
  3556. res_error(res, error_data);
  3557. }, is_connection_closed);
  3558. ctx_server.queue_results.remove_waiting_task_ids(task_ids);
  3559. } else {
  3560. const auto chunked_content_provider = [task_ids, &ctx_server, oaicompat](size_t, httplib::DataSink & sink) {
  3561. ctx_server.receive_cmpl_results_stream(task_ids, [&](server_task_result_ptr & result) -> bool {
  3562. json res_json = result->to_json();
  3563. if (res_json.is_array()) {
  3564. for (const auto & res : res_json) {
  3565. if (!server_sent_event(sink, "data", res)) {
  3566. // sending failed (HTTP connection closed), cancel the generation
  3567. return false;
  3568. }
  3569. }
  3570. return true;
  3571. } else {
  3572. return server_sent_event(sink, "data", res_json);
  3573. }
  3574. }, [&](const json & error_data) {
  3575. server_sent_event(sink, "error", error_data);
  3576. }, [&sink]() {
  3577. // note: do not use req.is_connection_closed here because req is already destroyed
  3578. return !sink.is_writable();
  3579. });
  3580. if (oaicompat != OAICOMPAT_TYPE_NONE) {
  3581. static const std::string ev_done = "data: [DONE]\n\n";
  3582. sink.write(ev_done.data(), ev_done.size());
  3583. }
  3584. sink.done();
  3585. return false;
  3586. };
  3587. auto on_complete = [task_ids, &ctx_server] (bool) {
  3588. ctx_server.queue_results.remove_waiting_task_ids(task_ids);
  3589. };
  3590. res.set_chunked_content_provider("text/event-stream", chunked_content_provider, on_complete);
  3591. }
  3592. };
  3593. const auto handle_completions = [&handle_completions_impl](const httplib::Request & req, httplib::Response & res) {
  3594. json data = json::parse(req.body);
  3595. std::vector<raw_buffer> files; // dummy
  3596. handle_completions_impl(
  3597. SERVER_TASK_TYPE_COMPLETION,
  3598. data,
  3599. files,
  3600. req.is_connection_closed,
  3601. res,
  3602. OAICOMPAT_TYPE_NONE);
  3603. };
  3604. const auto handle_completions_oai = [&handle_completions_impl](const httplib::Request & req, httplib::Response & res) {
  3605. json data = oaicompat_completion_params_parse(json::parse(req.body));
  3606. std::vector<raw_buffer> files; // dummy
  3607. handle_completions_impl(
  3608. SERVER_TASK_TYPE_COMPLETION,
  3609. data,
  3610. files,
  3611. req.is_connection_closed,
  3612. res,
  3613. OAICOMPAT_TYPE_COMPLETION);
  3614. };
  3615. const auto handle_infill = [&ctx_server, &res_error, &handle_completions_impl](const httplib::Request & req, httplib::Response & res) {
  3616. // check model compatibility
  3617. std::string err;
  3618. if (llama_vocab_fim_pre(ctx_server.vocab) == LLAMA_TOKEN_NULL) {
  3619. err += "prefix token is missing. ";
  3620. }
  3621. if (llama_vocab_fim_suf(ctx_server.vocab) == LLAMA_TOKEN_NULL) {
  3622. err += "suffix token is missing. ";
  3623. }
  3624. if (llama_vocab_fim_mid(ctx_server.vocab) == LLAMA_TOKEN_NULL) {
  3625. err += "middle token is missing. ";
  3626. }
  3627. if (!err.empty()) {
  3628. res_error(res, format_error_response(string_format("Infill is not supported by this model: %s", err.c_str()), ERROR_TYPE_NOT_SUPPORTED));
  3629. return;
  3630. }
  3631. json data = json::parse(req.body);
  3632. // validate input
  3633. if (data.contains("prompt") && !data.at("prompt").is_string()) {
  3634. // prompt is optional
  3635. res_error(res, format_error_response("\"prompt\" must be a string", ERROR_TYPE_INVALID_REQUEST));
  3636. }
  3637. if (!data.contains("input_prefix")) {
  3638. res_error(res, format_error_response("\"input_prefix\" is required", ERROR_TYPE_INVALID_REQUEST));
  3639. }
  3640. if (!data.contains("input_suffix")) {
  3641. res_error(res, format_error_response("\"input_suffix\" is required", ERROR_TYPE_INVALID_REQUEST));
  3642. }
  3643. if (data.contains("input_extra") && !data.at("input_extra").is_array()) {
  3644. // input_extra is optional
  3645. res_error(res, format_error_response("\"input_extra\" must be an array of {\"filename\": string, \"text\": string}", ERROR_TYPE_INVALID_REQUEST));
  3646. return;
  3647. }
  3648. json input_extra = json_value(data, "input_extra", json::array());
  3649. for (const auto & chunk : input_extra) {
  3650. // { "text": string, "filename": string }
  3651. if (!chunk.contains("text") || !chunk.at("text").is_string()) {
  3652. res_error(res, format_error_response("extra_context chunk must contain a \"text\" field with a string value", ERROR_TYPE_INVALID_REQUEST));
  3653. return;
  3654. }
  3655. // filename is optional
  3656. if (chunk.contains("filename") && !chunk.at("filename").is_string()) {
  3657. res_error(res, format_error_response("extra_context chunk's \"filename\" field must be a string", ERROR_TYPE_INVALID_REQUEST));
  3658. return;
  3659. }
  3660. }
  3661. data["input_extra"] = input_extra; // default to empty array if it's not exist
  3662. std::string prompt = json_value(data, "prompt", std::string());
  3663. std::vector<llama_tokens> tokenized_prompts = tokenize_input_prompts(ctx_server.vocab, prompt, false, true);
  3664. SRV_DBG("creating infill tasks, n_prompts = %d\n", (int) tokenized_prompts.size());
  3665. data["prompt"] = format_infill(
  3666. ctx_server.vocab,
  3667. data.at("input_prefix"),
  3668. data.at("input_suffix"),
  3669. data.at("input_extra"),
  3670. ctx_server.params_base.n_batch,
  3671. ctx_server.params_base.n_predict,
  3672. ctx_server.slots[0].n_ctx, // TODO: there should be a better way
  3673. ctx_server.params_base.spm_infill,
  3674. tokenized_prompts[0]
  3675. );
  3676. std::vector<raw_buffer> files; // dummy
  3677. handle_completions_impl(
  3678. SERVER_TASK_TYPE_INFILL,
  3679. data,
  3680. files,
  3681. req.is_connection_closed,
  3682. res,
  3683. OAICOMPAT_TYPE_NONE); // infill is not OAI compatible
  3684. };
  3685. const auto handle_chat_completions = [&ctx_server, &handle_completions_impl](const httplib::Request & req, httplib::Response & res) {
  3686. LOG_DBG("request: %s\n", req.body.c_str());
  3687. auto body = json::parse(req.body);
  3688. std::vector<raw_buffer> files;
  3689. json data = oaicompat_chat_params_parse(
  3690. body,
  3691. ctx_server.oai_parser_opt,
  3692. files);
  3693. handle_completions_impl(
  3694. SERVER_TASK_TYPE_COMPLETION,
  3695. data,
  3696. files,
  3697. req.is_connection_closed,
  3698. res,
  3699. OAICOMPAT_TYPE_CHAT);
  3700. };
  3701. // same with handle_chat_completions, but without inference part
  3702. const auto handle_apply_template = [&ctx_server, &res_ok](const httplib::Request & req, httplib::Response & res) {
  3703. auto body = json::parse(req.body);
  3704. std::vector<raw_buffer> files; // dummy, unused
  3705. json data = oaicompat_chat_params_parse(
  3706. body,
  3707. ctx_server.oai_parser_opt,
  3708. files);
  3709. res_ok(res, {{ "prompt", std::move(data.at("prompt")) }});
  3710. };
  3711. const auto handle_models = [&params, &ctx_server, &state, &res_ok](const httplib::Request &, httplib::Response & res) {
  3712. server_state current_state = state.load();
  3713. json model_meta = nullptr;
  3714. if (current_state == SERVER_STATE_READY) {
  3715. model_meta = ctx_server.model_meta();
  3716. }
  3717. json models = {
  3718. {"models", {
  3719. {
  3720. {"name", params.model_alias.empty() ? params.model.path : params.model_alias},
  3721. {"model", params.model_alias.empty() ? params.model.path : params.model_alias},
  3722. {"modified_at", ""},
  3723. {"size", ""},
  3724. {"digest", ""}, // dummy value, llama.cpp does not support managing model file's hash
  3725. {"type", "model"},
  3726. {"description", ""},
  3727. {"tags", {""}},
  3728. {"capabilities", {"completion"}},
  3729. {"parameters", ""},
  3730. {"details", {
  3731. {"parent_model", ""},
  3732. {"format", "gguf"},
  3733. {"family", ""},
  3734. {"families", {""}},
  3735. {"parameter_size", ""},
  3736. {"quantization_level", ""}
  3737. }}
  3738. }
  3739. }},
  3740. {"object", "list"},
  3741. {"data", {
  3742. {
  3743. {"id", params.model_alias.empty() ? params.model.path : params.model_alias},
  3744. {"object", "model"},
  3745. {"created", std::time(0)},
  3746. {"owned_by", "llamacpp"},
  3747. {"meta", model_meta},
  3748. },
  3749. }}
  3750. };
  3751. res_ok(res, models);
  3752. };
  3753. const auto handle_tokenize = [&ctx_server, &res_ok](const httplib::Request & req, httplib::Response & res) {
  3754. const json body = json::parse(req.body);
  3755. json tokens_response = json::array();
  3756. if (body.count("content") != 0) {
  3757. const bool add_special = json_value(body, "add_special", false);
  3758. const bool with_pieces = json_value(body, "with_pieces", false);
  3759. llama_tokens tokens = tokenize_mixed(ctx_server.vocab, body.at("content"), add_special, true);
  3760. if (with_pieces) {
  3761. for (const auto& token : tokens) {
  3762. std::string piece = common_token_to_piece(ctx_server.ctx, token);
  3763. json piece_json;
  3764. // Check if the piece is valid UTF-8
  3765. if (is_valid_utf8(piece)) {
  3766. piece_json = piece;
  3767. } else {
  3768. // If not valid UTF-8, store as array of byte values
  3769. piece_json = json::array();
  3770. for (unsigned char c : piece) {
  3771. piece_json.push_back(static_cast<int>(c));
  3772. }
  3773. }
  3774. tokens_response.push_back({
  3775. {"id", token},
  3776. {"piece", piece_json}
  3777. });
  3778. }
  3779. } else {
  3780. tokens_response = tokens;
  3781. }
  3782. }
  3783. const json data = format_tokenizer_response(tokens_response);
  3784. res_ok(res, data);
  3785. };
  3786. const auto handle_detokenize = [&ctx_server, &res_ok](const httplib::Request & req, httplib::Response & res) {
  3787. const json body = json::parse(req.body);
  3788. std::string content;
  3789. if (body.count("tokens") != 0) {
  3790. const llama_tokens tokens = body.at("tokens");
  3791. content = tokens_to_str(ctx_server.ctx, tokens.cbegin(), tokens.cend());
  3792. }
  3793. const json data = format_detokenized_response(content);
  3794. res_ok(res, data);
  3795. };
  3796. const auto handle_embeddings_impl = [&ctx_server, &res_error, &res_ok](const httplib::Request & req, httplib::Response & res, oaicompat_type oaicompat) {
  3797. if (!ctx_server.params_base.embedding) {
  3798. res_error(res, format_error_response("This server does not support embeddings. Start it with `--embeddings`", ERROR_TYPE_NOT_SUPPORTED));
  3799. return;
  3800. }
  3801. if (oaicompat != OAICOMPAT_TYPE_NONE && llama_pooling_type(ctx_server.ctx) == LLAMA_POOLING_TYPE_NONE) {
  3802. res_error(res, format_error_response("Pooling type 'none' is not OAI compatible. Please use a different pooling type", ERROR_TYPE_INVALID_REQUEST));
  3803. return;
  3804. }
  3805. const json body = json::parse(req.body);
  3806. // for the shape of input/content, see tokenize_input_prompts()
  3807. json prompt;
  3808. if (body.count("input") != 0) {
  3809. prompt = body.at("input");
  3810. } else if (body.contains("content")) {
  3811. oaicompat = OAICOMPAT_TYPE_NONE; // "content" field is not OAI compatible
  3812. prompt = body.at("content");
  3813. } else {
  3814. res_error(res, format_error_response("\"input\" or \"content\" must be provided", ERROR_TYPE_INVALID_REQUEST));
  3815. return;
  3816. }
  3817. bool use_base64 = false;
  3818. if (body.count("encoding_format") != 0) {
  3819. const std::string& format = body.at("encoding_format");
  3820. if (format == "base64") {
  3821. use_base64 = true;
  3822. } else if (format != "float") {
  3823. res_error(res, format_error_response("The format to return the embeddings in. Can be either float or base64", ERROR_TYPE_INVALID_REQUEST));
  3824. return;
  3825. }
  3826. }
  3827. auto tokenized_prompts = tokenize_input_prompts(ctx_server.vocab, prompt, true, true);
  3828. for (const auto & tokens : tokenized_prompts) {
  3829. // this check is necessary for models that do not add BOS token to the input
  3830. if (tokens.empty()) {
  3831. res_error(res, format_error_response("Input content cannot be empty", ERROR_TYPE_INVALID_REQUEST));
  3832. return;
  3833. }
  3834. }
  3835. // create and queue the task
  3836. json responses = json::array();
  3837. bool error = false;
  3838. std::unordered_set<int> task_ids;
  3839. {
  3840. std::vector<server_task> tasks;
  3841. for (size_t i = 0; i < tokenized_prompts.size(); i++) {
  3842. server_task task = server_task(SERVER_TASK_TYPE_EMBEDDING);
  3843. task.id = ctx_server.queue_tasks.get_new_id();
  3844. task.index = i;
  3845. task.prompt_tokens = server_tokens(tokenized_prompts[i], ctx_server.mctx != nullptr);
  3846. // OAI-compat
  3847. task.params.oaicompat = oaicompat;
  3848. tasks.push_back(std::move(task));
  3849. }
  3850. task_ids = server_task::get_list_id(tasks);
  3851. ctx_server.queue_results.add_waiting_tasks(tasks);
  3852. ctx_server.queue_tasks.post(std::move(tasks));
  3853. }
  3854. // get the result
  3855. ctx_server.receive_multi_results(task_ids, [&](std::vector<server_task_result_ptr> & results) {
  3856. for (auto & res : results) {
  3857. GGML_ASSERT(dynamic_cast<server_task_result_embd*>(res.get()) != nullptr);
  3858. responses.push_back(res->to_json());
  3859. }
  3860. }, [&](const json & error_data) {
  3861. res_error(res, error_data);
  3862. error = true;
  3863. }, req.is_connection_closed);
  3864. ctx_server.queue_results.remove_waiting_task_ids(task_ids);
  3865. if (error) {
  3866. return;
  3867. }
  3868. // write JSON response
  3869. json root = oaicompat == OAICOMPAT_TYPE_EMBEDDING
  3870. ? format_embeddings_response_oaicompat(body, responses, use_base64)
  3871. : json(responses);
  3872. res_ok(res, root);
  3873. };
  3874. const auto handle_embeddings = [&handle_embeddings_impl](const httplib::Request & req, httplib::Response & res) {
  3875. handle_embeddings_impl(req, res, OAICOMPAT_TYPE_NONE);
  3876. };
  3877. const auto handle_embeddings_oai = [&handle_embeddings_impl](const httplib::Request & req, httplib::Response & res) {
  3878. handle_embeddings_impl(req, res, OAICOMPAT_TYPE_EMBEDDING);
  3879. };
  3880. const auto handle_rerank = [&ctx_server, &res_error, &res_ok](const httplib::Request & req, httplib::Response & res) {
  3881. if (!ctx_server.params_base.embedding || ctx_server.params_base.pooling_type != LLAMA_POOLING_TYPE_RANK) {
  3882. res_error(res, format_error_response("This server does not support reranking. Start it with `--reranking`", ERROR_TYPE_NOT_SUPPORTED));
  3883. return;
  3884. }
  3885. const json body = json::parse(req.body);
  3886. // TODO: implement
  3887. //int top_n = 1;
  3888. //if (body.count("top_n") != 1) {
  3889. // top_n = body.at("top_n");
  3890. //} else {
  3891. // res_error(res, format_error_response("\"top_n\" must be provided", ERROR_TYPE_INVALID_REQUEST));
  3892. // return;
  3893. //}
  3894. // if true, use TEI API format, otherwise use Jina API format
  3895. // Jina: https://jina.ai/reranker/
  3896. // TEI: https://huggingface.github.io/text-embeddings-inference/#/Text%20Embeddings%20Inference/rerank
  3897. bool is_tei_format = body.contains("texts");
  3898. json query;
  3899. if (body.count("query") == 1) {
  3900. query = body.at("query");
  3901. if (!query.is_string()) {
  3902. res_error(res, format_error_response("\"query\" must be a string", ERROR_TYPE_INVALID_REQUEST));
  3903. return;
  3904. }
  3905. } else {
  3906. res_error(res, format_error_response("\"query\" must be provided", ERROR_TYPE_INVALID_REQUEST));
  3907. return;
  3908. }
  3909. std::vector<std::string> documents = json_value(body, "documents",
  3910. json_value(body, "texts", std::vector<std::string>()));
  3911. if (documents.empty()) {
  3912. res_error(res, format_error_response("\"documents\" must be a non-empty string array", ERROR_TYPE_INVALID_REQUEST));
  3913. return;
  3914. }
  3915. llama_tokens tokenized_query = tokenize_input_prompts(ctx_server.vocab, query, /* add_special */ false, true)[0];
  3916. // create and queue the task
  3917. json responses = json::array();
  3918. bool error = false;
  3919. std::unordered_set<int> task_ids;
  3920. {
  3921. std::vector<server_task> tasks;
  3922. auto tokenized_docs = tokenize_input_prompts(ctx_server.vocab, documents, /* add_special */ false, true);
  3923. tasks.reserve(tokenized_docs.size());
  3924. for (size_t i = 0; i < tokenized_docs.size(); i++) {
  3925. auto tmp = format_rerank(ctx_server.vocab, tokenized_query, tokenized_docs[i]);
  3926. server_task task = server_task(SERVER_TASK_TYPE_RERANK);
  3927. task.id = ctx_server.queue_tasks.get_new_id();
  3928. task.index = i;
  3929. task.prompt_tokens = server_tokens(tmp, ctx_server.mctx != nullptr);
  3930. tasks.push_back(std::move(task));
  3931. }
  3932. task_ids = server_task::get_list_id(tasks);
  3933. ctx_server.queue_results.add_waiting_tasks(tasks);
  3934. ctx_server.queue_tasks.post(std::move(tasks));
  3935. }
  3936. ctx_server.receive_multi_results(task_ids, [&](std::vector<server_task_result_ptr> & results) {
  3937. for (auto & res : results) {
  3938. GGML_ASSERT(dynamic_cast<server_task_result_rerank*>(res.get()) != nullptr);
  3939. responses.push_back(res->to_json());
  3940. }
  3941. }, [&](const json & error_data) {
  3942. res_error(res, error_data);
  3943. error = true;
  3944. }, req.is_connection_closed);
  3945. if (error) {
  3946. return;
  3947. }
  3948. // write JSON response
  3949. json root = format_response_rerank(
  3950. body,
  3951. responses,
  3952. is_tei_format,
  3953. documents);
  3954. res_ok(res, root);
  3955. };
  3956. const auto handle_lora_adapters_list = [&](const httplib::Request &, httplib::Response & res) {
  3957. json result = json::array();
  3958. const auto & loras = ctx_server.params_base.lora_adapters;
  3959. for (size_t i = 0; i < loras.size(); ++i) {
  3960. auto & lora = loras[i];
  3961. result.push_back({
  3962. {"id", i},
  3963. {"path", lora.path},
  3964. {"scale", lora.scale},
  3965. });
  3966. }
  3967. res_ok(res, result);
  3968. res.status = 200; // HTTP OK
  3969. };
  3970. const auto handle_lora_adapters_apply = [&](const httplib::Request & req, httplib::Response & res) {
  3971. const json body = json::parse(req.body);
  3972. if (!body.is_array()) {
  3973. res_error(res, format_error_response("Request body must be an array", ERROR_TYPE_INVALID_REQUEST));
  3974. return;
  3975. }
  3976. int task_id = ctx_server.queue_tasks.get_new_id();
  3977. {
  3978. server_task task(SERVER_TASK_TYPE_SET_LORA);
  3979. task.id = task_id;
  3980. task.set_lora = parse_lora_request(ctx_server.params_base.lora_adapters, body);
  3981. ctx_server.queue_results.add_waiting_task_id(task_id);
  3982. ctx_server.queue_tasks.post(std::move(task));
  3983. }
  3984. // get the result
  3985. server_task_result_ptr result = ctx_server.queue_results.recv(task_id);
  3986. ctx_server.queue_results.remove_waiting_task_id(task_id);
  3987. if (result->is_error()) {
  3988. res_error(res, result->to_json());
  3989. return;
  3990. }
  3991. GGML_ASSERT(dynamic_cast<server_task_result_apply_lora*>(result.get()) != nullptr);
  3992. res_ok(res, result->to_json());
  3993. };
  3994. //
  3995. // Router
  3996. //
  3997. if (!params.webui) {
  3998. LOG_INF("Web UI is disabled\n");
  3999. } else {
  4000. // register static assets routes
  4001. if (!params.public_path.empty()) {
  4002. // Set the base directory for serving static files
  4003. bool is_found = svr->set_mount_point(params.api_prefix + "/", params.public_path);
  4004. if (!is_found) {
  4005. LOG_ERR("%s: static assets path not found: %s\n", __func__, params.public_path.c_str());
  4006. return 1;
  4007. }
  4008. } else {
  4009. // using embedded static index.html
  4010. svr->Get(params.api_prefix + "/", [](const httplib::Request & req, httplib::Response & res) {
  4011. if (req.get_header_value("Accept-Encoding").find("gzip") == std::string::npos) {
  4012. res.set_content("Error: gzip is not supported by this browser", "text/plain");
  4013. } else {
  4014. res.set_header("Content-Encoding", "gzip");
  4015. // COEP and COOP headers, required by pyodide (python interpreter)
  4016. res.set_header("Cross-Origin-Embedder-Policy", "require-corp");
  4017. res.set_header("Cross-Origin-Opener-Policy", "same-origin");
  4018. res.set_content(reinterpret_cast<const char*>(index_html_gz), index_html_gz_len, "text/html; charset=utf-8");
  4019. }
  4020. return false;
  4021. });
  4022. }
  4023. }
  4024. // register API routes
  4025. svr->Get (params.api_prefix + "/health", handle_health); // public endpoint (no API key check)
  4026. svr->Get (params.api_prefix + "/metrics", handle_metrics);
  4027. svr->Get (params.api_prefix + "/props", handle_props);
  4028. svr->Post(params.api_prefix + "/props", handle_props_change);
  4029. svr->Post(params.api_prefix + "/api/show", handle_api_show);
  4030. svr->Get (params.api_prefix + "/models", handle_models); // public endpoint (no API key check)
  4031. svr->Get (params.api_prefix + "/v1/models", handle_models); // public endpoint (no API key check)
  4032. svr->Get (params.api_prefix + "/api/tags", handle_models); // ollama specific endpoint. public endpoint (no API key check)
  4033. svr->Post(params.api_prefix + "/completion", handle_completions); // legacy
  4034. svr->Post(params.api_prefix + "/completions", handle_completions);
  4035. svr->Post(params.api_prefix + "/v1/completions", handle_completions_oai);
  4036. svr->Post(params.api_prefix + "/chat/completions", handle_chat_completions);
  4037. svr->Post(params.api_prefix + "/v1/chat/completions", handle_chat_completions);
  4038. svr->Post(params.api_prefix + "/api/chat", handle_chat_completions); // ollama specific endpoint
  4039. svr->Post(params.api_prefix + "/infill", handle_infill);
  4040. svr->Post(params.api_prefix + "/embedding", handle_embeddings); // legacy
  4041. svr->Post(params.api_prefix + "/embeddings", handle_embeddings);
  4042. svr->Post(params.api_prefix + "/v1/embeddings", handle_embeddings_oai);
  4043. svr->Post(params.api_prefix + "/rerank", handle_rerank);
  4044. svr->Post(params.api_prefix + "/reranking", handle_rerank);
  4045. svr->Post(params.api_prefix + "/v1/rerank", handle_rerank);
  4046. svr->Post(params.api_prefix + "/v1/reranking", handle_rerank);
  4047. svr->Post(params.api_prefix + "/tokenize", handle_tokenize);
  4048. svr->Post(params.api_prefix + "/detokenize", handle_detokenize);
  4049. svr->Post(params.api_prefix + "/apply-template", handle_apply_template);
  4050. // LoRA adapters hotswap
  4051. svr->Get (params.api_prefix + "/lora-adapters", handle_lora_adapters_list);
  4052. svr->Post(params.api_prefix + "/lora-adapters", handle_lora_adapters_apply);
  4053. // Save & load slots
  4054. svr->Get (params.api_prefix + "/slots", handle_slots);
  4055. svr->Post(params.api_prefix + "/slots/:id_slot", handle_slots_action);
  4056. //
  4057. // Start the server
  4058. //
  4059. if (params.n_threads_http < 1) {
  4060. // +2 threads for monitoring endpoints
  4061. params.n_threads_http = std::max(params.n_parallel + 2, (int32_t) std::thread::hardware_concurrency() - 1);
  4062. }
  4063. log_data["n_threads_http"] = std::to_string(params.n_threads_http);
  4064. svr->new_task_queue = [&params] { return new httplib::ThreadPool(params.n_threads_http); };
  4065. // clean up function, to be called before exit
  4066. auto clean_up = [&svr, &ctx_server]() {
  4067. SRV_INF("%s: cleaning up before exit...\n", __func__);
  4068. svr->stop();
  4069. ctx_server.queue_results.terminate();
  4070. llama_backend_free();
  4071. };
  4072. bool was_bound = false;
  4073. bool is_sock = false;
  4074. if (string_ends_with(std::string(params.hostname), ".sock")) {
  4075. is_sock = true;
  4076. LOG_INF("%s: setting address family to AF_UNIX\n", __func__);
  4077. svr->set_address_family(AF_UNIX);
  4078. // bind_to_port requires a second arg, any value other than 0 should
  4079. // simply get ignored
  4080. was_bound = svr->bind_to_port(params.hostname, 8080);
  4081. } else {
  4082. LOG_INF("%s: binding port with default address family\n", __func__);
  4083. // bind HTTP listen port
  4084. if (params.port == 0) {
  4085. int bound_port = svr->bind_to_any_port(params.hostname);
  4086. if ((was_bound = (bound_port >= 0))) {
  4087. params.port = bound_port;
  4088. }
  4089. } else {
  4090. was_bound = svr->bind_to_port(params.hostname, params.port);
  4091. }
  4092. }
  4093. if (!was_bound) {
  4094. LOG_ERR("%s: couldn't bind HTTP server socket, hostname: %s, port: %d\n", __func__, params.hostname.c_str(), params.port);
  4095. clean_up();
  4096. return 1;
  4097. }
  4098. // run the HTTP server in a thread
  4099. std::thread t([&]() { svr->listen_after_bind(); });
  4100. svr->wait_until_ready();
  4101. LOG_INF("%s: HTTP server is listening, hostname: %s, port: %d, http threads: %d\n", __func__, params.hostname.c_str(), params.port, params.n_threads_http);
  4102. // load the model
  4103. LOG_INF("%s: loading model\n", __func__);
  4104. if (!ctx_server.load_model(params)) {
  4105. clean_up();
  4106. t.join();
  4107. LOG_ERR("%s: exiting due to model loading error\n", __func__);
  4108. return 1;
  4109. }
  4110. ctx_server.init();
  4111. state.store(SERVER_STATE_READY);
  4112. LOG_INF("%s: model loaded\n", __func__);
  4113. // print sample chat example to make it clear which template is used
  4114. LOG_INF("%s: chat template, chat_template: %s, example_format: '%s'\n", __func__,
  4115. common_chat_templates_source(ctx_server.chat_templates.get()),
  4116. common_chat_format_example(ctx_server.chat_templates.get(), ctx_server.params_base.use_jinja).c_str());
  4117. ctx_server.queue_tasks.on_new_task([&ctx_server](server_task && task) {
  4118. ctx_server.process_single_task(std::move(task));
  4119. });
  4120. ctx_server.queue_tasks.on_update_slots([&ctx_server]() {
  4121. ctx_server.update_slots();
  4122. });
  4123. shutdown_handler = [&](int) {
  4124. // this will unblock start_loop()
  4125. ctx_server.queue_tasks.terminate();
  4126. };
  4127. #if defined (__unix__) || (defined (__APPLE__) && defined (__MACH__))
  4128. struct sigaction sigint_action;
  4129. sigint_action.sa_handler = signal_handler;
  4130. sigemptyset (&sigint_action.sa_mask);
  4131. sigint_action.sa_flags = 0;
  4132. sigaction(SIGINT, &sigint_action, NULL);
  4133. sigaction(SIGTERM, &sigint_action, NULL);
  4134. #elif defined (_WIN32)
  4135. auto console_ctrl_handler = +[](DWORD ctrl_type) -> BOOL {
  4136. return (ctrl_type == CTRL_C_EVENT) ? (signal_handler(SIGINT), true) : false;
  4137. };
  4138. SetConsoleCtrlHandler(reinterpret_cast<PHANDLER_ROUTINE>(console_ctrl_handler), true);
  4139. #endif
  4140. LOG_INF("%s: server is listening on %s - starting the main loop\n", __func__,
  4141. is_sock ? string_format("unix://%s", params.hostname.c_str()).c_str() :
  4142. string_format("http://%s:%d", params.hostname.c_str(), params.port).c_str());
  4143. // this call blocks the main thread until queue_tasks.terminate() is called
  4144. ctx_server.queue_tasks.start_loop();
  4145. clean_up();
  4146. t.join();
  4147. return 0;
  4148. }