server.cpp 197 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004
  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. bool can_batch_with(server_slot & other_slot) const {
  1170. return task_type == other_slot.task_type && are_lora_equal(lora, other_slot.lora);
  1171. }
  1172. bool has_budget(const common_params & global_params) {
  1173. if (params.n_predict == -1 && global_params.n_predict == -1) {
  1174. return true; // limitless
  1175. }
  1176. n_remaining = -1;
  1177. if (params.n_predict != -1) {
  1178. n_remaining = params.n_predict - n_decoded;
  1179. } else if (global_params.n_predict != -1) {
  1180. n_remaining = global_params.n_predict - n_decoded;
  1181. }
  1182. return n_remaining > 0; // no budget
  1183. }
  1184. bool is_processing() const {
  1185. return state != SLOT_STATE_IDLE;
  1186. }
  1187. bool can_speculate() const {
  1188. return ctx_dft && params.speculative.n_max > 0 && params.cache_prompt;
  1189. }
  1190. void add_token(const completion_token_output & token) {
  1191. if (!is_processing()) {
  1192. SLT_WRN(*this, "%s", "slot is not processing\n");
  1193. return;
  1194. }
  1195. generated_token_probs.push_back(token);
  1196. }
  1197. void release() {
  1198. if (is_processing()) {
  1199. SLT_INF(*this, "stop processing: n_past = %d, truncated = %d\n", n_past, truncated);
  1200. t_last_used = ggml_time_us();
  1201. t_token_generation = (ggml_time_us() - t_start_generation) / 1e3;
  1202. state = SLOT_STATE_IDLE;
  1203. callback_on_release(id);
  1204. }
  1205. }
  1206. result_timings get_timings() const {
  1207. result_timings timings;
  1208. timings.prompt_n = n_prompt_tokens_processed;
  1209. timings.prompt_ms = t_prompt_processing;
  1210. timings.prompt_per_token_ms = t_prompt_processing / n_prompt_tokens_processed;
  1211. timings.prompt_per_second = 1e3 / t_prompt_processing * n_prompt_tokens_processed;
  1212. timings.predicted_n = n_decoded;
  1213. timings.predicted_ms = t_token_generation;
  1214. timings.predicted_per_token_ms = t_token_generation / n_decoded;
  1215. timings.predicted_per_second = 1e3 / t_token_generation * n_decoded;
  1216. // Add speculative metrics
  1217. if (n_draft_total > 0) {
  1218. timings.draft_n = n_draft_total;
  1219. timings.draft_n_accepted = n_draft_accepted;
  1220. }
  1221. return timings;
  1222. }
  1223. const common_chat_msg & update_chat_msg(std::vector<common_chat_msg_diff> & diffs) {
  1224. auto previous_msg = chat_msg;
  1225. SRV_DBG("Parsing chat message: %s\n", generated_text.c_str());
  1226. auto new_msg = common_chat_parse(
  1227. generated_text,
  1228. /* is_partial= */ stop != STOP_TYPE_EOS,
  1229. params.oaicompat_chat_syntax);
  1230. if (!new_msg.empty()) {
  1231. new_msg.ensure_tool_call_ids_set(generated_tool_call_ids, gen_tool_call_id);
  1232. chat_msg = new_msg;
  1233. diffs = common_chat_msg_diff::compute_diffs(previous_msg, new_msg.empty() ? previous_msg : new_msg);
  1234. }
  1235. return chat_msg;
  1236. }
  1237. size_t find_stopping_strings(const std::string & text, const size_t last_token_size, bool is_full_stop) {
  1238. size_t stop_pos = std::string::npos;
  1239. for (const std::string & word : params.antiprompt) {
  1240. size_t pos;
  1241. if (is_full_stop) {
  1242. const size_t tmp = word.size() + last_token_size;
  1243. const size_t from_pos = text.size() > tmp ? text.size() - tmp : 0;
  1244. pos = text.find(word, from_pos);
  1245. } else {
  1246. // otherwise, partial stop
  1247. pos = string_find_partial_stop(text, word);
  1248. }
  1249. if (pos != std::string::npos && (stop_pos == std::string::npos || pos < stop_pos)) {
  1250. if (is_full_stop) {
  1251. stop = STOP_TYPE_WORD;
  1252. stopping_word = word;
  1253. has_next_token = false;
  1254. }
  1255. stop_pos = pos;
  1256. }
  1257. }
  1258. return stop_pos;
  1259. }
  1260. void print_timings() const {
  1261. const double t_prompt = t_prompt_processing / n_prompt_tokens_processed;
  1262. const double n_prompt_second = 1e3 / t_prompt_processing * n_prompt_tokens_processed;
  1263. const double t_gen = t_token_generation / n_decoded;
  1264. const double n_gen_second = 1e3 / t_token_generation * n_decoded;
  1265. SLT_INF(*this,
  1266. "\n"
  1267. "prompt eval time = %10.2f ms / %5d tokens (%8.2f ms per token, %8.2f tokens per second)\n"
  1268. " eval time = %10.2f ms / %5d tokens (%8.2f ms per token, %8.2f tokens per second)\n"
  1269. " total time = %10.2f ms / %5d tokens\n",
  1270. t_prompt_processing, n_prompt_tokens_processed, t_prompt, n_prompt_second,
  1271. t_token_generation, n_decoded, t_gen, n_gen_second,
  1272. t_prompt_processing + t_token_generation, n_prompt_tokens_processed + n_decoded);
  1273. if (n_draft_total > 0) {
  1274. const float draft_ratio = (float) n_draft_accepted / n_draft_total;
  1275. SLT_INF(*this,
  1276. "\n"
  1277. "draft acceptance rate = %0.5f (%5d accepted / %5d generated)\n",
  1278. draft_ratio, n_draft_accepted, n_draft_total
  1279. );
  1280. }
  1281. }
  1282. json to_json() const {
  1283. return json {
  1284. {"id", id},
  1285. {"id_task", id_task},
  1286. {"n_ctx", n_ctx},
  1287. {"speculative", can_speculate()},
  1288. {"is_processing", is_processing()},
  1289. {"params", params.to_json()},
  1290. {"prompt", prompt_tokens.detokenize(ctx, true)},
  1291. {"next_token",
  1292. {
  1293. {"has_next_token", has_next_token},
  1294. {"has_new_line", has_new_line},
  1295. {"n_remain", n_remaining},
  1296. {"n_decoded", n_decoded},
  1297. {"stopping_word", stopping_word},
  1298. }
  1299. },
  1300. };
  1301. }
  1302. };
  1303. struct server_metrics {
  1304. int64_t t_start = 0;
  1305. uint64_t n_prompt_tokens_processed_total = 0;
  1306. uint64_t t_prompt_processing_total = 0;
  1307. uint64_t n_tokens_predicted_total = 0;
  1308. uint64_t t_tokens_generation_total = 0;
  1309. uint64_t n_prompt_tokens_processed = 0;
  1310. uint64_t t_prompt_processing = 0;
  1311. uint64_t n_tokens_predicted = 0;
  1312. uint64_t t_tokens_generation = 0;
  1313. uint64_t n_decode_total = 0;
  1314. uint64_t n_busy_slots_total = 0;
  1315. void init() {
  1316. t_start = ggml_time_us();
  1317. }
  1318. void on_prompt_eval(const server_slot & slot) {
  1319. n_prompt_tokens_processed_total += slot.n_prompt_tokens_processed;
  1320. n_prompt_tokens_processed += slot.n_prompt_tokens_processed;
  1321. t_prompt_processing += slot.t_prompt_processing;
  1322. t_prompt_processing_total += slot.t_prompt_processing;
  1323. }
  1324. void on_prediction(const server_slot & slot) {
  1325. n_tokens_predicted_total += slot.n_decoded;
  1326. n_tokens_predicted += slot.n_decoded;
  1327. t_tokens_generation += slot.t_token_generation;
  1328. t_tokens_generation_total += slot.t_token_generation;
  1329. }
  1330. void on_decoded(const std::vector<server_slot> & slots) {
  1331. n_decode_total++;
  1332. for (const auto & slot : slots) {
  1333. if (slot.is_processing()) {
  1334. n_busy_slots_total++;
  1335. }
  1336. }
  1337. }
  1338. void reset_bucket() {
  1339. n_prompt_tokens_processed = 0;
  1340. t_prompt_processing = 0;
  1341. n_tokens_predicted = 0;
  1342. t_tokens_generation = 0;
  1343. }
  1344. };
  1345. struct server_queue {
  1346. int id = 0;
  1347. bool running;
  1348. // queues
  1349. std::deque<server_task> queue_tasks;
  1350. std::deque<server_task> queue_tasks_deferred;
  1351. std::mutex mutex_tasks;
  1352. std::condition_variable condition_tasks;
  1353. // callback functions
  1354. std::function<void(server_task &&)> callback_new_task;
  1355. std::function<void(void)> callback_update_slots;
  1356. // Add a new task to the end of the queue
  1357. int post(server_task && task, bool front = false) {
  1358. std::unique_lock<std::mutex> lock(mutex_tasks);
  1359. GGML_ASSERT(task.id != -1);
  1360. // if this is cancel task make sure to clean up pending tasks
  1361. if (task.type == SERVER_TASK_TYPE_CANCEL) {
  1362. cleanup_pending_task(task.id_target);
  1363. }
  1364. const int task_id = task.id;
  1365. QUE_DBG("new task, id = %d, front = %d\n", task_id, front);
  1366. if (front) {
  1367. queue_tasks.push_front(std::move(task));
  1368. } else {
  1369. queue_tasks.push_back(std::move(task));
  1370. }
  1371. condition_tasks.notify_one();
  1372. return task_id;
  1373. }
  1374. // multi-task version of post()
  1375. int post(std::vector<server_task> && tasks, bool front = false) {
  1376. std::unique_lock<std::mutex> lock(mutex_tasks);
  1377. for (auto & task : tasks) {
  1378. if (task.id == -1) {
  1379. task.id = id++;
  1380. }
  1381. // if this is cancel task make sure to clean up pending tasks
  1382. if (task.type == SERVER_TASK_TYPE_CANCEL) {
  1383. cleanup_pending_task(task.id_target);
  1384. }
  1385. QUE_DBG("new task, id = %d/%d, front = %d\n", task.id, (int) tasks.size(), front);
  1386. if (front) {
  1387. queue_tasks.push_front(std::move(task));
  1388. } else {
  1389. queue_tasks.push_back(std::move(task));
  1390. }
  1391. }
  1392. condition_tasks.notify_one();
  1393. return 0;
  1394. }
  1395. // Add a new task, but defer until one slot is available
  1396. void defer(server_task && task) {
  1397. std::unique_lock<std::mutex> lock(mutex_tasks);
  1398. QUE_DBG("defer task, id = %d\n", task.id);
  1399. queue_tasks_deferred.push_back(std::move(task));
  1400. condition_tasks.notify_one();
  1401. }
  1402. // Get the next id for creating a new task
  1403. int get_new_id() {
  1404. std::unique_lock<std::mutex> lock(mutex_tasks);
  1405. int new_id = id++;
  1406. return new_id;
  1407. }
  1408. // Register function to process a new task
  1409. void on_new_task(std::function<void(server_task &&)> callback) {
  1410. callback_new_task = std::move(callback);
  1411. }
  1412. // Register the function to be called when all slots data is ready to be processed
  1413. void on_update_slots(std::function<void(void)> callback) {
  1414. callback_update_slots = std::move(callback);
  1415. }
  1416. // Call when the state of one slot is changed, it will move one task from deferred to main queue
  1417. void pop_deferred_task() {
  1418. std::unique_lock<std::mutex> lock(mutex_tasks);
  1419. if (!queue_tasks_deferred.empty()) {
  1420. queue_tasks.emplace_back(std::move(queue_tasks_deferred.front()));
  1421. queue_tasks_deferred.pop_front();
  1422. }
  1423. condition_tasks.notify_one();
  1424. }
  1425. // end the start_loop routine
  1426. void terminate() {
  1427. std::unique_lock<std::mutex> lock(mutex_tasks);
  1428. running = false;
  1429. condition_tasks.notify_all();
  1430. }
  1431. /**
  1432. * Main loop consists of these steps:
  1433. * - Wait until a new task arrives
  1434. * - Process the task (i.e. maybe copy data into slot)
  1435. * - Check if multitask is finished
  1436. * - Update all slots
  1437. */
  1438. void start_loop() {
  1439. running = true;
  1440. while (true) {
  1441. QUE_DBG("%s", "processing new tasks\n");
  1442. while (true) {
  1443. std::unique_lock<std::mutex> lock(mutex_tasks);
  1444. if (!running) {
  1445. QUE_DBG("%s", "terminate\n");
  1446. return;
  1447. }
  1448. if (queue_tasks.empty()) {
  1449. lock.unlock();
  1450. break;
  1451. }
  1452. server_task task = std::move(queue_tasks.front());
  1453. queue_tasks.pop_front();
  1454. lock.unlock();
  1455. QUE_DBG("processing task, id = %d\n", task.id);
  1456. callback_new_task(std::move(task));
  1457. }
  1458. // all tasks in the current loop is processed, slots data is now ready
  1459. QUE_DBG("%s", "update slots\n");
  1460. callback_update_slots();
  1461. QUE_DBG("%s", "waiting for new tasks\n");
  1462. {
  1463. std::unique_lock<std::mutex> lock(mutex_tasks);
  1464. if (!running) {
  1465. QUE_DBG("%s", "terminate\n");
  1466. return;
  1467. }
  1468. if (queue_tasks.empty()) {
  1469. condition_tasks.wait(lock, [&]{
  1470. return (!queue_tasks.empty() || !running);
  1471. });
  1472. }
  1473. }
  1474. }
  1475. }
  1476. private:
  1477. void cleanup_pending_task(int id_target) {
  1478. // no need lock because this is called exclusively by post()
  1479. auto rm_func = [id_target](const server_task & task) {
  1480. return task.id_target == id_target;
  1481. };
  1482. queue_tasks.erase(
  1483. std::remove_if(queue_tasks.begin(), queue_tasks.end(), rm_func),
  1484. queue_tasks.end());
  1485. queue_tasks_deferred.erase(
  1486. std::remove_if(queue_tasks_deferred.begin(), queue_tasks_deferred.end(), rm_func),
  1487. queue_tasks_deferred.end());
  1488. }
  1489. };
  1490. struct server_response {
  1491. bool running = true;
  1492. // for keeping track of all tasks waiting for the result
  1493. std::unordered_set<int> waiting_task_ids;
  1494. // the main result queue (using ptr for polymorphism)
  1495. std::vector<server_task_result_ptr> queue_results;
  1496. std::mutex mutex_results;
  1497. std::condition_variable condition_results;
  1498. // add the id_task to the list of tasks waiting for response
  1499. void add_waiting_task_id(int id_task) {
  1500. SRV_DBG("add task %d to waiting list. current waiting = %d (before add)\n", id_task, (int) waiting_task_ids.size());
  1501. std::unique_lock<std::mutex> lock(mutex_results);
  1502. waiting_task_ids.insert(id_task);
  1503. }
  1504. void add_waiting_tasks(const std::vector<server_task> & tasks) {
  1505. std::unique_lock<std::mutex> lock(mutex_results);
  1506. for (const auto & task : tasks) {
  1507. SRV_DBG("add task %d to waiting list. current waiting = %d (before add)\n", task.id, (int) waiting_task_ids.size());
  1508. waiting_task_ids.insert(task.id);
  1509. }
  1510. }
  1511. // when the request is finished, we can remove task associated with it
  1512. void remove_waiting_task_id(int id_task) {
  1513. SRV_DBG("remove task %d from waiting list. current waiting = %d (before remove)\n", id_task, (int) waiting_task_ids.size());
  1514. std::unique_lock<std::mutex> lock(mutex_results);
  1515. waiting_task_ids.erase(id_task);
  1516. // make sure to clean up all pending results
  1517. queue_results.erase(
  1518. std::remove_if(queue_results.begin(), queue_results.end(), [id_task](const server_task_result_ptr & res) {
  1519. return res->id == id_task;
  1520. }),
  1521. queue_results.end());
  1522. }
  1523. void remove_waiting_task_ids(const std::unordered_set<int> & id_tasks) {
  1524. std::unique_lock<std::mutex> lock(mutex_results);
  1525. for (const auto & id_task : id_tasks) {
  1526. SRV_DBG("remove task %d from waiting list. current waiting = %d (before remove)\n", id_task, (int) waiting_task_ids.size());
  1527. waiting_task_ids.erase(id_task);
  1528. }
  1529. }
  1530. // This function blocks the thread until there is a response for one of the id_tasks
  1531. server_task_result_ptr recv(const std::unordered_set<int> & id_tasks) {
  1532. while (true) {
  1533. std::unique_lock<std::mutex> lock(mutex_results);
  1534. condition_results.wait(lock, [&]{
  1535. if (!running) {
  1536. SRV_DBG("%s : queue result stop\n", __func__);
  1537. std::terminate(); // we cannot return here since the caller is HTTP code
  1538. }
  1539. return !queue_results.empty();
  1540. });
  1541. for (size_t i = 0; i < queue_results.size(); i++) {
  1542. if (id_tasks.find(queue_results[i]->id) != id_tasks.end()) {
  1543. server_task_result_ptr res = std::move(queue_results[i]);
  1544. queue_results.erase(queue_results.begin() + i);
  1545. return res;
  1546. }
  1547. }
  1548. }
  1549. // should never reach here
  1550. }
  1551. // same as recv(), but have timeout in seconds
  1552. // if timeout is reached, nullptr is returned
  1553. server_task_result_ptr recv_with_timeout(const std::unordered_set<int> & id_tasks, int timeout) {
  1554. while (true) {
  1555. std::unique_lock<std::mutex> lock(mutex_results);
  1556. for (int i = 0; i < (int) queue_results.size(); i++) {
  1557. if (id_tasks.find(queue_results[i]->id) != id_tasks.end()) {
  1558. server_task_result_ptr res = std::move(queue_results[i]);
  1559. queue_results.erase(queue_results.begin() + i);
  1560. return res;
  1561. }
  1562. }
  1563. std::cv_status cr_res = condition_results.wait_for(lock, std::chrono::seconds(timeout));
  1564. if (!running) {
  1565. SRV_DBG("%s : queue result stop\n", __func__);
  1566. std::terminate(); // we cannot return here since the caller is HTTP code
  1567. }
  1568. if (cr_res == std::cv_status::timeout) {
  1569. return nullptr;
  1570. }
  1571. }
  1572. // should never reach here
  1573. }
  1574. // single-task version of recv()
  1575. server_task_result_ptr recv(int id_task) {
  1576. std::unordered_set<int> id_tasks = {id_task};
  1577. return recv(id_tasks);
  1578. }
  1579. // Send a new result to a waiting id_task
  1580. void send(server_task_result_ptr && result) {
  1581. SRV_DBG("sending result for task id = %d\n", result->id);
  1582. std::unique_lock<std::mutex> lock(mutex_results);
  1583. for (const auto & id_task : waiting_task_ids) {
  1584. if (result->id == id_task) {
  1585. SRV_DBG("task id = %d pushed to result queue\n", result->id);
  1586. queue_results.emplace_back(std::move(result));
  1587. condition_results.notify_all();
  1588. return;
  1589. }
  1590. }
  1591. }
  1592. // terminate the waiting loop
  1593. void terminate() {
  1594. running = false;
  1595. condition_results.notify_all();
  1596. }
  1597. };
  1598. struct server_context {
  1599. common_params params_base;
  1600. // note: keep these alive - they determine the lifetime of the model, context, etc.
  1601. common_init_result llama_init;
  1602. common_init_result llama_init_dft;
  1603. llama_model * model = nullptr;
  1604. llama_context * ctx = nullptr;
  1605. // multimodal
  1606. mtmd_context * mctx = nullptr;
  1607. const llama_vocab * vocab = nullptr;
  1608. llama_model * model_dft = nullptr;
  1609. llama_context_params cparams_dft;
  1610. llama_batch batch {};
  1611. bool clean_kv_cache = true;
  1612. bool add_bos_token = true;
  1613. bool has_eos_token = false;
  1614. int32_t n_ctx; // total context for all clients / slots
  1615. // slots / clients
  1616. std::vector<server_slot> slots;
  1617. json default_generation_settings_for_props;
  1618. server_queue queue_tasks;
  1619. server_response queue_results;
  1620. server_metrics metrics;
  1621. // Necessary similarity of prompt for slot selection
  1622. float slot_prompt_similarity = 0.0f;
  1623. common_chat_templates_ptr chat_templates;
  1624. oaicompat_parser_options oai_parser_opt;
  1625. ~server_context() {
  1626. mtmd_free(mctx);
  1627. // Clear any sampling context
  1628. for (server_slot & slot : slots) {
  1629. common_sampler_free(slot.smpl);
  1630. slot.smpl = nullptr;
  1631. llama_free(slot.ctx_dft);
  1632. slot.ctx_dft = nullptr;
  1633. common_speculative_free(slot.spec);
  1634. slot.spec = nullptr;
  1635. llama_batch_free(slot.batch_spec);
  1636. }
  1637. llama_batch_free(batch);
  1638. }
  1639. // if the context does not have a memory module then all embeddings have to be computed within a single ubatch
  1640. // also we cannot split if the pooling would require any past tokens
  1641. bool can_split() const {
  1642. return
  1643. !llama_get_embeddings(ctx) ||
  1644. (llama_get_memory(ctx) && llama_pooling_type(ctx) == LLAMA_POOLING_TYPE_LAST);
  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. // force F16 KV cache for the draft model for extra performance
  1669. params_dft.cache_type_k = GGML_TYPE_F16;
  1670. params_dft.cache_type_v = GGML_TYPE_F16;
  1671. llama_init_dft = common_init_from_params(params_dft);
  1672. model_dft = llama_init_dft.model.get();
  1673. if (model_dft == nullptr) {
  1674. SRV_ERR("failed to load draft model, '%s'\n", params_base.speculative.model.path.c_str());
  1675. return false;
  1676. }
  1677. if (!common_speculative_are_compatible(ctx, llama_init_dft.context.get())) {
  1678. 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());
  1679. return false;
  1680. }
  1681. const int n_ctx_dft = llama_n_ctx(llama_init_dft.context.get());
  1682. cparams_dft = common_context_params_to_llama(params_dft);
  1683. cparams_dft.n_batch = n_ctx_dft;
  1684. // the context is not needed - we will create one for each slot
  1685. llama_init_dft.context.reset();
  1686. }
  1687. chat_templates = common_chat_templates_init(model, params_base.chat_template);
  1688. try {
  1689. common_chat_format_example(chat_templates.get(), params.use_jinja);
  1690. } catch (const std::exception & e) {
  1691. SRV_WRN("%s: Chat template parsing error: %s\n", __func__, e.what());
  1692. 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__);
  1693. chat_templates = common_chat_templates_init(model, "chatml");
  1694. }
  1695. std::string & mmproj_path = params_base.mmproj.path;
  1696. if (!mmproj_path.empty()) {
  1697. mtmd_context_params mparams = mtmd_context_params_default();
  1698. mparams.use_gpu = params_base.mmproj_use_gpu;
  1699. mparams.print_timings = false;
  1700. mparams.n_threads = params_base.cpuparams.n_threads;
  1701. mparams.verbosity = params_base.verbosity > 0 ? GGML_LOG_LEVEL_DEBUG : GGML_LOG_LEVEL_INFO;
  1702. mctx = mtmd_init_from_file(mmproj_path.c_str(), model, mparams);
  1703. if (mctx == nullptr) {
  1704. SRV_ERR("failed to load multimodal model, '%s'\n", mmproj_path.c_str());
  1705. return false;
  1706. }
  1707. SRV_INF("loaded multimodal model, '%s'\n", mmproj_path.c_str());
  1708. if (params_base.ctx_shift) {
  1709. params_base.ctx_shift = false;
  1710. SRV_WRN("%s\n", "ctx_shift is not supported by multimodal, it will be disabled");
  1711. }
  1712. if (params_base.n_cache_reuse) {
  1713. params_base.n_cache_reuse = 0;
  1714. SRV_WRN("%s\n", "cache_reuse is not supported by multimodal, it will be disabled");
  1715. }
  1716. if (!params_base.speculative.model.path.empty()) {
  1717. SRV_ERR("%s\n", "err: speculative decode is not supported by multimodal");
  1718. return false;
  1719. }
  1720. }
  1721. if (!llama_memory_can_shift(llama_get_memory(ctx))) {
  1722. if (params_base.ctx_shift) {
  1723. params_base.ctx_shift = false;
  1724. SRV_WRN("%s\n", "ctx_shift is not supported by this context, it will be disabled");
  1725. }
  1726. if (params_base.n_cache_reuse) {
  1727. params_base.n_cache_reuse = 0;
  1728. SRV_WRN("%s\n", "cache_reuse is not supported by this context, it will be disabled");
  1729. }
  1730. }
  1731. return true;
  1732. }
  1733. void init() {
  1734. const int32_t n_ctx_slot = n_ctx / params_base.n_parallel;
  1735. SRV_INF("initializing slots, n_slots = %d\n", params_base.n_parallel);
  1736. for (int i = 0; i < params_base.n_parallel; i++) {
  1737. server_slot slot;
  1738. slot.id = i;
  1739. slot.ctx = ctx;
  1740. slot.n_ctx = n_ctx_slot;
  1741. slot.n_predict = params_base.n_predict;
  1742. slot.mctx = mctx;
  1743. slot.cache_tokens.has_mtmd = mctx != nullptr;
  1744. if (model_dft) {
  1745. slot.batch_spec = llama_batch_init(params_base.speculative.n_max + 1, 0, 1);
  1746. slot.ctx_dft = llama_init_from_model(model_dft, cparams_dft);
  1747. if (slot.ctx_dft == nullptr) {
  1748. SRV_ERR("%s", "failed to create draft context\n");
  1749. return;
  1750. }
  1751. slot.spec = common_speculative_init(slot.ctx_dft);
  1752. if (slot.spec == nullptr) {
  1753. SRV_ERR("%s", "failed to create speculator\n");
  1754. return;
  1755. }
  1756. }
  1757. SLT_INF(slot, "new slot n_ctx_slot = %d\n", slot.n_ctx);
  1758. slot.params.sampling = params_base.sampling;
  1759. slot.params.n_keep = params_base.n_keep;
  1760. slot.callback_on_release = [this](int) {
  1761. queue_tasks.pop_deferred_task();
  1762. };
  1763. slot.reset();
  1764. slots.push_back(std::move(slot));
  1765. }
  1766. default_generation_settings_for_props = slots[0].to_json();
  1767. // the update_slots() logic will always submit a maximum of n_batch or n_parallel tokens
  1768. // 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)
  1769. {
  1770. const int32_t n_batch = llama_n_batch(ctx);
  1771. batch = llama_batch_init(std::max(n_batch, params_base.n_parallel), 0, 1);
  1772. }
  1773. metrics.init();
  1774. oai_parser_opt = {
  1775. /* use_jinja */ params_base.use_jinja,
  1776. /* prefill_assistant */ params_base.prefill_assistant,
  1777. /* reasoning_format */ params_base.reasoning_format,
  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 = llama_get_embeddings_seq(ctx, batch.seq_id[i][0]);
  2156. if (embd == NULL) {
  2157. embd = llama_get_embeddings_ith(ctx, i);
  2158. }
  2159. if (embd == NULL) {
  2160. SLT_ERR(slot, "failed to get embeddings, token = %d, seq_id = %d\n", batch.token[i], batch.seq_id[i][0]);
  2161. res->embedding.push_back(std::vector<float>(n_embd, 0.0f));
  2162. continue;
  2163. }
  2164. // normalize only when there is pooling
  2165. // TODO: configurable
  2166. if (llama_pooling_type(slot.ctx) != LLAMA_POOLING_TYPE_NONE) {
  2167. common_embd_normalize(embd, embd_res.data(), n_embd, 2);
  2168. res->embedding.push_back(embd_res);
  2169. } else {
  2170. res->embedding.push_back({ embd, embd + n_embd });
  2171. }
  2172. }
  2173. SLT_DBG(slot, "%s", "sending embeddings\n");
  2174. queue_results.send(std::move(res));
  2175. }
  2176. void send_rerank(const server_slot & slot, const llama_batch & batch) {
  2177. auto res = std::make_unique<server_task_result_rerank>();
  2178. res->id = slot.id_task;
  2179. res->index = slot.index;
  2180. res->n_tokens = slot.n_prompt_tokens;
  2181. for (int i = 0; i < batch.n_tokens; ++i) {
  2182. if (!batch.logits[i] || batch.seq_id[i][0] != slot.id) {
  2183. continue;
  2184. }
  2185. const float * embd = llama_get_embeddings_seq(ctx, batch.seq_id[i][0]);
  2186. if (embd == NULL) {
  2187. embd = llama_get_embeddings_ith(ctx, i);
  2188. }
  2189. if (embd == NULL) {
  2190. SLT_ERR(slot, "failed to get embeddings, token = %d, seq_id = %d\n", batch.token[i], batch.seq_id[i][0]);
  2191. res->score = -1e6;
  2192. continue;
  2193. }
  2194. res->score = embd[0];
  2195. }
  2196. SLT_DBG(slot, "sending rerank result, res.score = %f\n", res->score);
  2197. queue_results.send(std::move(res));
  2198. }
  2199. //
  2200. // Functions to create new task(s) and receive result(s)
  2201. //
  2202. void cancel_tasks(const std::unordered_set<int> & id_tasks) {
  2203. std::vector<server_task> cancel_tasks;
  2204. cancel_tasks.reserve(id_tasks.size());
  2205. for (const auto & id_task : id_tasks) {
  2206. SRV_WRN("cancel task, id_task = %d\n", id_task);
  2207. server_task task(SERVER_TASK_TYPE_CANCEL);
  2208. task.id_target = id_task;
  2209. queue_results.remove_waiting_task_id(id_task);
  2210. cancel_tasks.push_back(std::move(task));
  2211. }
  2212. // push to beginning of the queue, so it has highest priority
  2213. queue_tasks.post(std::move(cancel_tasks), true);
  2214. }
  2215. // receive the results from task(s)
  2216. void receive_multi_results(
  2217. const std::unordered_set<int> & id_tasks,
  2218. const std::function<void(std::vector<server_task_result_ptr>&)> & result_handler,
  2219. const std::function<void(json)> & error_handler,
  2220. const std::function<bool()> & is_connection_closed) {
  2221. std::vector<server_task_result_ptr> results(id_tasks.size());
  2222. for (int i = 0; i < (int)id_tasks.size(); i++) {
  2223. server_task_result_ptr result = queue_results.recv_with_timeout(id_tasks, HTTP_POLLING_SECONDS);
  2224. if (is_connection_closed()) {
  2225. cancel_tasks(id_tasks);
  2226. return;
  2227. }
  2228. if (result == nullptr) {
  2229. i--; // retry
  2230. continue;
  2231. }
  2232. if (result->is_error()) {
  2233. error_handler(result->to_json());
  2234. cancel_tasks(id_tasks);
  2235. return;
  2236. }
  2237. GGML_ASSERT(
  2238. dynamic_cast<server_task_result_cmpl_final*>(result.get()) != nullptr
  2239. || dynamic_cast<server_task_result_embd*>(result.get()) != nullptr
  2240. || dynamic_cast<server_task_result_rerank*>(result.get()) != nullptr
  2241. );
  2242. const size_t idx = result->get_index();
  2243. GGML_ASSERT(idx < results.size() && "index out of range");
  2244. results[idx] = std::move(result);
  2245. }
  2246. result_handler(results);
  2247. }
  2248. // receive the results from task(s), in stream mode
  2249. void receive_cmpl_results_stream(
  2250. const std::unordered_set<int> & id_tasks,
  2251. const std::function<bool(server_task_result_ptr&)> & result_handler,
  2252. const std::function<void(json)> & error_handler,
  2253. const std::function<bool()> & is_connection_closed) {
  2254. size_t n_finished = 0;
  2255. while (true) {
  2256. server_task_result_ptr result = queue_results.recv_with_timeout(id_tasks, HTTP_POLLING_SECONDS);
  2257. if (is_connection_closed()) {
  2258. cancel_tasks(id_tasks);
  2259. return;
  2260. }
  2261. if (result == nullptr) {
  2262. continue; // retry
  2263. }
  2264. if (result->is_error()) {
  2265. error_handler(result->to_json());
  2266. cancel_tasks(id_tasks);
  2267. return;
  2268. }
  2269. GGML_ASSERT(
  2270. dynamic_cast<server_task_result_cmpl_partial*>(result.get()) != nullptr
  2271. || dynamic_cast<server_task_result_cmpl_final*>(result.get()) != nullptr
  2272. );
  2273. if (!result_handler(result)) {
  2274. cancel_tasks(id_tasks);
  2275. break;
  2276. }
  2277. if (result->is_stop()) {
  2278. if (++n_finished == id_tasks.size()) {
  2279. break;
  2280. }
  2281. }
  2282. }
  2283. }
  2284. //
  2285. // Functions to process the task
  2286. //
  2287. void process_single_task(server_task && task) {
  2288. switch (task.type) {
  2289. case SERVER_TASK_TYPE_COMPLETION:
  2290. case SERVER_TASK_TYPE_INFILL:
  2291. case SERVER_TASK_TYPE_EMBEDDING:
  2292. case SERVER_TASK_TYPE_RERANK:
  2293. {
  2294. const int id_slot = task.id_selected_slot;
  2295. server_slot * slot = id_slot != -1 ? get_slot_by_id(id_slot) : get_available_slot(task);
  2296. if (slot == nullptr) {
  2297. // if no slot is available, we defer this task for processing later
  2298. SRV_DBG("no slot is available, defer task, id_task = %d\n", task.id);
  2299. queue_tasks.defer(std::move(task));
  2300. break;
  2301. }
  2302. if (slot->is_processing()) {
  2303. // if requested slot is unavailable, we defer this task for processing later
  2304. SRV_DBG("requested slot is unavailable, defer task, id_task = %d\n", task.id);
  2305. queue_tasks.defer(std::move(task));
  2306. break;
  2307. }
  2308. if (!launch_slot_with_task(*slot, std::move(task))) {
  2309. SRV_ERR("failed to launch slot with task, id_task = %d\n", task.id);
  2310. break;
  2311. }
  2312. } break;
  2313. case SERVER_TASK_TYPE_CANCEL:
  2314. {
  2315. // release slot linked with the task id
  2316. for (auto & slot : slots) {
  2317. if (slot.id_task == task.id_target) {
  2318. slot.release();
  2319. break;
  2320. }
  2321. }
  2322. } break;
  2323. case SERVER_TASK_TYPE_NEXT_RESPONSE:
  2324. {
  2325. // do nothing
  2326. } break;
  2327. case SERVER_TASK_TYPE_METRICS:
  2328. {
  2329. json slots_data = json::array();
  2330. int n_idle_slots = 0;
  2331. int n_processing_slots = 0;
  2332. for (server_slot & slot : slots) {
  2333. json slot_data = slot.to_json();
  2334. if (slot.is_processing()) {
  2335. n_processing_slots++;
  2336. } else {
  2337. n_idle_slots++;
  2338. }
  2339. slots_data.push_back(slot_data);
  2340. }
  2341. SRV_DBG("n_idle_slots = %d, n_processing_slots = %d\n", n_idle_slots, n_processing_slots);
  2342. auto res = std::make_unique<server_task_result_metrics>();
  2343. res->id = task.id;
  2344. res->slots_data = std::move(slots_data);
  2345. res->n_idle_slots = n_idle_slots;
  2346. res->n_processing_slots = n_processing_slots;
  2347. res->n_tasks_deferred = queue_tasks.queue_tasks_deferred.size();
  2348. res->t_start = metrics.t_start;
  2349. res->n_prompt_tokens_processed_total = metrics.n_prompt_tokens_processed_total;
  2350. res->t_prompt_processing_total = metrics.t_prompt_processing_total;
  2351. res->n_tokens_predicted_total = metrics.n_tokens_predicted_total;
  2352. res->t_tokens_generation_total = metrics.t_tokens_generation_total;
  2353. res->n_prompt_tokens_processed = metrics.n_prompt_tokens_processed;
  2354. res->t_prompt_processing = metrics.t_prompt_processing;
  2355. res->n_tokens_predicted = metrics.n_tokens_predicted;
  2356. res->t_tokens_generation = metrics.t_tokens_generation;
  2357. res->n_decode_total = metrics.n_decode_total;
  2358. res->n_busy_slots_total = metrics.n_busy_slots_total;
  2359. if (task.metrics_reset_bucket) {
  2360. metrics.reset_bucket();
  2361. }
  2362. queue_results.send(std::move(res));
  2363. } break;
  2364. case SERVER_TASK_TYPE_SLOT_SAVE:
  2365. {
  2366. if (!ensure_no_mtmd(task.id)) {
  2367. break;
  2368. }
  2369. int id_slot = task.slot_action.slot_id;
  2370. server_slot * slot = get_slot_by_id(id_slot);
  2371. if (slot == nullptr) {
  2372. send_error(task, "Invalid slot ID", ERROR_TYPE_INVALID_REQUEST);
  2373. break;
  2374. }
  2375. if (slot->is_processing()) {
  2376. // if requested slot is unavailable, we defer this task for processing later
  2377. SRV_DBG("requested slot is unavailable, defer task, id_task = %d\n", task.id);
  2378. queue_tasks.defer(std::move(task));
  2379. break;
  2380. }
  2381. const size_t token_count = slot->cache_tokens.size();
  2382. const int64_t t_start = ggml_time_us();
  2383. std::string filename = task.slot_action.filename;
  2384. std::string filepath = task.slot_action.filepath;
  2385. const llama_tokens & tokens = slot->cache_tokens.get_text_tokens();
  2386. const size_t nwrite = llama_state_seq_save_file(ctx, filepath.c_str(), slot->id, tokens.data(), token_count);
  2387. const int64_t t_end = ggml_time_us();
  2388. const double t_save_ms = (t_end - t_start) / 1000.0;
  2389. auto res = std::make_unique<server_task_result_slot_save_load>();
  2390. res->id = task.id;
  2391. res->id_slot = id_slot;
  2392. res->filename = filename;
  2393. res->is_save = true;
  2394. res->n_tokens = token_count;
  2395. res->n_bytes = nwrite;
  2396. res->t_ms = t_save_ms;
  2397. queue_results.send(std::move(res));
  2398. } break;
  2399. case SERVER_TASK_TYPE_SLOT_RESTORE:
  2400. {
  2401. if (!ensure_no_mtmd(task.id)) break;
  2402. int id_slot = task.slot_action.slot_id;
  2403. server_slot * slot = get_slot_by_id(id_slot);
  2404. if (slot == nullptr) {
  2405. send_error(task, "Invalid slot ID", ERROR_TYPE_INVALID_REQUEST);
  2406. break;
  2407. }
  2408. if (slot->is_processing()) {
  2409. // if requested slot is unavailable, we defer this task for processing later
  2410. SRV_DBG("requested slot is unavailable, defer task, id_task = %d\n", task.id);
  2411. queue_tasks.defer(std::move(task));
  2412. break;
  2413. }
  2414. const int64_t t_start = ggml_time_us();
  2415. std::string filename = task.slot_action.filename;
  2416. std::string filepath = task.slot_action.filepath;
  2417. llama_tokens tokens;
  2418. tokens.resize(slot->n_ctx);
  2419. size_t token_count = 0;
  2420. size_t nread = llama_state_seq_load_file(ctx, filepath.c_str(), slot->id, tokens.data(), tokens.size(), &token_count);
  2421. if (nread == 0) {
  2422. slot->cache_tokens.clear(); // KV may already been invalidated?
  2423. send_error(task, "Unable to restore slot, no available space in KV cache or invalid slot save file", ERROR_TYPE_INVALID_REQUEST);
  2424. break;
  2425. }
  2426. tokens.resize(token_count);
  2427. slot->cache_tokens.clear();
  2428. slot->cache_tokens.insert(tokens);
  2429. const int64_t t_end = ggml_time_us();
  2430. const double t_restore_ms = (t_end - t_start) / 1000.0;
  2431. auto res = std::make_unique<server_task_result_slot_save_load>();
  2432. res->id = task.id;
  2433. res->id_slot = id_slot;
  2434. res->filename = filename;
  2435. res->is_save = false;
  2436. res->n_tokens = token_count;
  2437. res->n_bytes = nread;
  2438. res->t_ms = t_restore_ms;
  2439. queue_results.send(std::move(res));
  2440. } break;
  2441. case SERVER_TASK_TYPE_SLOT_ERASE:
  2442. {
  2443. if (!ensure_no_mtmd(task.id)) break;
  2444. int id_slot = task.slot_action.slot_id;
  2445. server_slot * slot = get_slot_by_id(id_slot);
  2446. if (slot == nullptr) {
  2447. send_error(task, "Invalid slot ID", ERROR_TYPE_INVALID_REQUEST);
  2448. break;
  2449. }
  2450. if (slot->is_processing()) {
  2451. // if requested slot is unavailable, we defer this task for processing later
  2452. SRV_DBG("requested slot is unavailable, defer task, id_task = %d\n", task.id);
  2453. queue_tasks.defer(std::move(task));
  2454. break;
  2455. }
  2456. // Erase token cache
  2457. const size_t n_erased = slot->cache_tokens.size();
  2458. llama_memory_seq_rm(llama_get_memory(ctx), slot->id, -1, -1);
  2459. slot->cache_tokens.clear();
  2460. auto res = std::make_unique<server_task_result_slot_erase>();
  2461. res->id = task.id;
  2462. res->id_slot = id_slot;
  2463. res->n_erased = n_erased;
  2464. queue_results.send(std::move(res));
  2465. } break;
  2466. case SERVER_TASK_TYPE_SET_LORA:
  2467. {
  2468. params_base.lora_adapters = std::move(task.set_lora);
  2469. auto res = std::make_unique<server_task_result_apply_lora>();
  2470. res->id = task.id;
  2471. queue_results.send(std::move(res));
  2472. } break;
  2473. }
  2474. }
  2475. void update_slots() {
  2476. // check if all slots are idle
  2477. {
  2478. bool all_idle = true;
  2479. for (auto & slot : slots) {
  2480. if (slot.is_processing()) {
  2481. all_idle = false;
  2482. break;
  2483. }
  2484. }
  2485. if (all_idle) {
  2486. SRV_INF("%s", "all slots are idle\n");
  2487. if (clean_kv_cache) {
  2488. kv_cache_clear();
  2489. }
  2490. return;
  2491. }
  2492. }
  2493. {
  2494. SRV_DBG("%s", "posting NEXT_RESPONSE\n");
  2495. server_task task(SERVER_TASK_TYPE_NEXT_RESPONSE);
  2496. task.id = queue_tasks.get_new_id();
  2497. queue_tasks.post(std::move(task));
  2498. }
  2499. // apply context-shift if needed
  2500. // TODO: simplify and improve
  2501. for (server_slot & slot : slots) {
  2502. if (slot.is_processing() && slot.n_past + 1 >= slot.n_ctx) {
  2503. if (!params_base.ctx_shift) {
  2504. // this check is redundant (for good)
  2505. // we should never get here, because generation should already stopped in process_token()
  2506. slot.release();
  2507. send_error(slot, "context shift is disabled", ERROR_TYPE_SERVER);
  2508. continue;
  2509. }
  2510. if (mctx) {
  2511. // we should never reach this because params_base.ctx_shift is automatically disabled if mmproj is loaded
  2512. // we don't support ctx_shift because an image chunk may contains multiple tokens
  2513. GGML_ABORT("not supported by multimodal");
  2514. }
  2515. // Shift context
  2516. const int n_keep = slot.params.n_keep + add_bos_token;
  2517. const int n_left = slot.n_past - n_keep;
  2518. const int n_discard = slot.params.n_discard ? slot.params.n_discard : (n_left / 2);
  2519. SLT_WRN(slot, "slot context shift, n_keep = %d, n_left = %d, n_discard = %d\n", n_keep, n_left, n_discard);
  2520. llama_memory_seq_rm (llama_get_memory(ctx), slot.id, n_keep , n_keep + n_discard);
  2521. llama_memory_seq_add(llama_get_memory(ctx), slot.id, n_keep + n_discard, slot.n_past, -n_discard);
  2522. // add generated tokens to cache
  2523. {
  2524. llama_tokens new_tokens = slot.cache_tokens.get_text_tokens(); // copy
  2525. for (size_t i = n_keep + n_discard; i < new_tokens.size(); i++) {
  2526. new_tokens[i - n_discard] = new_tokens[i];
  2527. }
  2528. new_tokens.resize(slot.cache_tokens.size() - n_discard);
  2529. slot.cache_tokens.clear();
  2530. slot.cache_tokens.insert(new_tokens);
  2531. }
  2532. slot.n_past -= n_discard;
  2533. slot.truncated = true;
  2534. }
  2535. }
  2536. // start populating the batch for this iteration
  2537. common_batch_clear(batch);
  2538. // track if given slot can be batched with slots already in the batch
  2539. server_slot * slot_batched = nullptr;
  2540. auto accept_special_token = [&](server_slot & slot, llama_token token) {
  2541. return params_base.special || slot.params.sampling.preserved_tokens.find(token) != slot.params.sampling.preserved_tokens.end();
  2542. };
  2543. // frist, add sampled tokens from any ongoing sequences
  2544. for (auto & slot : slots) {
  2545. if (slot.state != SLOT_STATE_GENERATING) {
  2546. continue;
  2547. }
  2548. // check if we can batch this slot with the previous one
  2549. if (!slot_batched) {
  2550. slot_batched = &slot;
  2551. } else if (!slot_batched->can_batch_with(slot)) {
  2552. continue;
  2553. }
  2554. slot.i_batch = batch.n_tokens;
  2555. common_batch_add(batch, slot.sampled, slot.n_past, { slot.id }, true);
  2556. slot.n_past += 1;
  2557. slot.cache_tokens.push_back(slot.sampled);
  2558. SLT_DBG(slot, "slot decode token, n_ctx = %d, n_past = %d, n_cache_tokens = %d, truncated = %d\n",
  2559. slot.n_ctx, slot.n_past, (int) slot.cache_tokens.size(), slot.truncated);
  2560. }
  2561. // process in chunks of params.n_batch
  2562. int32_t n_batch = llama_n_batch(ctx);
  2563. int32_t n_ubatch = llama_n_ubatch(ctx);
  2564. // next, batch any pending prompts without exceeding n_batch
  2565. if (params_base.cont_batching || batch.n_tokens == 0) {
  2566. for (auto & slot : slots) {
  2567. // check if we can batch this slot with the previous one
  2568. if (slot.is_processing()) {
  2569. if (!slot_batched) {
  2570. slot_batched = &slot;
  2571. } else if (!slot_batched->can_batch_with(slot)) {
  2572. continue;
  2573. }
  2574. }
  2575. // this slot still has a prompt to be processed
  2576. if (slot.state == SLOT_STATE_PROCESSING_PROMPT || slot.state == SLOT_STATE_STARTED) {
  2577. auto & prompt_tokens = slot.prompt_tokens;
  2578. // TODO: maybe move branch to outside of this loop in the future
  2579. if (slot.state == SLOT_STATE_STARTED) {
  2580. slot.t_start_process_prompt = ggml_time_us();
  2581. slot.t_start_generation = 0;
  2582. slot.n_past = 0;
  2583. slot.n_prompt_tokens = prompt_tokens.size();
  2584. slot.state = SLOT_STATE_PROCESSING_PROMPT;
  2585. 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);
  2586. // print prompt tokens (for debugging)
  2587. /*if (1) {
  2588. // first 16 tokens (avoid flooding logs)
  2589. for (int i = 0; i < std::min<int>(16, prompt_tokens.size()); i++) {
  2590. SLT_DBG(slot, "prompt token %3d: %6d '%s'\n", i, prompt_tokens[i], common_token_to_piece(ctx, prompt_tokens[i]).c_str());
  2591. }
  2592. } else {
  2593. // all
  2594. for (int i = 0; i < (int) prompt_tokens.size(); i++) {
  2595. SLT_DBG(slot, "prompt token %3d: %6d '%s'\n", i, prompt_tokens[i], common_token_to_piece(ctx, prompt_tokens[i]).c_str());
  2596. }
  2597. }*/
  2598. // empty prompt passed -> release the slot and send empty response
  2599. if (prompt_tokens.empty()) {
  2600. SLT_WRN(slot, "%s", "empty prompt - releasing slot\n");
  2601. slot.release();
  2602. slot.print_timings();
  2603. send_final_response(slot);
  2604. continue;
  2605. }
  2606. // TODO: support memory-less logits computation
  2607. if (slot.need_logits() && !llama_get_memory(ctx)) {
  2608. slot.release();
  2609. send_error(slot, "the current context does not logits computation. skipping", ERROR_TYPE_SERVER);
  2610. continue;
  2611. }
  2612. if (!can_split()) {
  2613. if (slot.n_prompt_tokens > n_ubatch) {
  2614. slot.release();
  2615. send_error(slot, "input is too large to process. increase the physical batch size", ERROR_TYPE_SERVER);
  2616. continue;
  2617. }
  2618. if (slot.n_prompt_tokens > slot.n_ctx) {
  2619. slot.release();
  2620. send_error(slot, "input is larger than the max context size. skipping", ERROR_TYPE_SERVER);
  2621. continue;
  2622. }
  2623. } else {
  2624. if (!params_base.ctx_shift) {
  2625. // if context shift is disabled, we make sure prompt size is smaller than KV size
  2626. // TODO: there should be a separate parameter that control prompt truncation
  2627. // context shift should be applied only during the generation phase
  2628. if (slot.n_prompt_tokens >= slot.n_ctx) {
  2629. slot.release();
  2630. send_error(slot, "the request exceeds the available context size. try increasing the context size or enable context shift", ERROR_TYPE_INVALID_REQUEST);
  2631. continue;
  2632. }
  2633. }
  2634. if (slot.params.n_keep < 0) {
  2635. slot.params.n_keep = slot.n_prompt_tokens;
  2636. }
  2637. slot.params.n_keep = std::min(slot.n_ctx - 4, slot.params.n_keep);
  2638. // if input prompt is too big, truncate it
  2639. if (slot.n_prompt_tokens >= slot.n_ctx) {
  2640. if (mctx) {
  2641. // we should never reach this
  2642. GGML_ABORT("not supported by multimodal");
  2643. }
  2644. const int n_left = slot.n_ctx - slot.params.n_keep;
  2645. const int n_block_size = n_left / 2;
  2646. const int erased_blocks = (slot.n_prompt_tokens - slot.params.n_keep - n_block_size) / n_block_size;
  2647. const llama_tokens & curr_tokens = slot.prompt_tokens.get_text_tokens();
  2648. llama_tokens new_tokens(
  2649. curr_tokens.begin(),
  2650. curr_tokens.begin() + slot.params.n_keep);
  2651. new_tokens.insert(
  2652. new_tokens.end(),
  2653. curr_tokens.begin() + slot.params.n_keep + erased_blocks * n_block_size,
  2654. curr_tokens.end());
  2655. prompt_tokens.clear();
  2656. prompt_tokens.insert(new_tokens);
  2657. slot.truncated = true;
  2658. slot.n_prompt_tokens = prompt_tokens.size();
  2659. 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);
  2660. GGML_ASSERT(slot.n_prompt_tokens < slot.n_ctx);
  2661. }
  2662. if (slot.params.cache_prompt) {
  2663. // reuse any previously computed tokens that are common with the new prompt
  2664. slot.n_past = slot.cache_tokens.get_common_prefix(prompt_tokens);
  2665. // reuse chunks from the cached prompt by shifting their KV cache in the new position
  2666. if (params_base.n_cache_reuse > 0) {
  2667. size_t head_c = slot.n_past; // cache
  2668. size_t head_p = slot.n_past; // current prompt
  2669. if (mctx) {
  2670. // we should never reach this
  2671. GGML_ABORT("not supported by multimodal");
  2672. }
  2673. SLT_DBG(slot, "trying to reuse chunks with size > %d, slot.n_past = %d\n", params_base.n_cache_reuse, slot.n_past);
  2674. while (head_c < slot.cache_tokens.size() &&
  2675. head_p < prompt_tokens.size()) {
  2676. size_t n_match = 0;
  2677. while (head_c + n_match < slot.cache_tokens.size() &&
  2678. head_p + n_match < prompt_tokens.size() &&
  2679. slot.cache_tokens[head_c + n_match] == prompt_tokens[head_p + n_match]) {
  2680. n_match++;
  2681. }
  2682. if (n_match >= (size_t) params_base.n_cache_reuse) {
  2683. 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);
  2684. //for (size_t i = head_p; i < head_p + n_match; i++) {
  2685. // SLT_DBG(slot, "cache token %3zu: %6d '%s'\n", i, prompt_tokens[i], common_token_to_piece(ctx, prompt_tokens[i]).c_str());
  2686. //}
  2687. const int64_t kv_shift = (int64_t) head_p - (int64_t) head_c;
  2688. llama_memory_seq_rm (llama_get_memory(ctx), slot.id, head_p, head_c);
  2689. llama_memory_seq_add(llama_get_memory(ctx), slot.id, head_c, head_c + n_match, kv_shift);
  2690. for (size_t i = 0; i < n_match; i++) {
  2691. slot.cache_tokens.set_token(head_p + i, slot.cache_tokens[head_c + i]);
  2692. slot.n_past++;
  2693. }
  2694. head_c += n_match;
  2695. head_p += n_match;
  2696. } else {
  2697. head_c += 1;
  2698. }
  2699. }
  2700. SLT_DBG(slot, "after context reuse, new slot.n_past = %d\n", slot.n_past);
  2701. }
  2702. } else {
  2703. // if we don't cache the prompt, we have to remove the entire KV cache
  2704. slot.n_past = 0;
  2705. }
  2706. if (slot.n_past > 0 && slot.n_past < (int) slot.cache_tokens.size()) {
  2707. const auto pos_min = llama_memory_seq_pos_min(llama_get_memory(ctx), slot.id);
  2708. if (pos_min == -1) {
  2709. 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);
  2710. GGML_ABORT("pos_min == -1, but n_past > 0 - should not happen: https://github.com/ggml-org/llama.cpp/pull/13833#discussion_r2116181237");
  2711. }
  2712. const auto n_swa = llama_model_n_swa(model);
  2713. if (pos_min > std::max(0, slot.n_past - n_swa)) {
  2714. 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);
  2715. SLT_WRN(slot, "forcing full prompt re-processing due to lack of cache data (likely due to SWA, see %s)\n",
  2716. "https://github.com/ggml-org/llama.cpp/pull/13194#issuecomment-2868343055");
  2717. slot.n_past = 0;
  2718. }
  2719. }
  2720. }
  2721. if (slot.n_past == slot.n_prompt_tokens && slot.n_past > 0) {
  2722. 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);
  2723. slot.n_past--;
  2724. }
  2725. slot.n_prompt_tokens_processed = 0;
  2726. }
  2727. if (!can_split()) {
  2728. // cannot fit the prompt in the current batch - will try next iter
  2729. if (batch.n_tokens + slot.n_prompt_tokens > n_batch) {
  2730. continue;
  2731. }
  2732. }
  2733. // keep only the common part
  2734. if (!llama_memory_seq_rm(llama_get_memory(ctx), slot.id, slot.n_past, -1)) {
  2735. // could not partially delete (likely using a non-Transformer model)
  2736. llama_memory_seq_rm(llama_get_memory(ctx), slot.id, -1, -1);
  2737. // there is no common part left
  2738. slot.n_past = 0;
  2739. }
  2740. SLT_INF(slot, "kv cache rm [%d, end)\n", slot.n_past);
  2741. // remove the non-common part from the cache
  2742. slot.cache_tokens.keep_first(slot.n_past);
  2743. // check if we should process the image
  2744. if (slot.n_past < slot.n_prompt_tokens && slot.prompt_tokens[slot.n_past] == LLAMA_TOKEN_NULL) {
  2745. // process the image
  2746. int32_t new_n_past;
  2747. int32_t res = slot.prompt_tokens.process_chunk(ctx, mctx, slot.n_past, slot.id, new_n_past);
  2748. int32_t n_pos = new_n_past - slot.n_past;
  2749. if (res != 0) {
  2750. SLT_ERR(slot, "failed to process image, res = %d\n", res);
  2751. slot.release();
  2752. send_error(slot, "failed to process image", ERROR_TYPE_SERVER);
  2753. continue;
  2754. }
  2755. // add the image chunk to cache
  2756. {
  2757. const auto & chunk = slot.prompt_tokens.find_chunk(slot.n_past);
  2758. slot.cache_tokens.push_back(chunk.get()); // copy
  2759. }
  2760. slot.n_past += n_pos;
  2761. slot.n_prompt_tokens_processed += n_pos;
  2762. }
  2763. // add prompt tokens for processing in the current batch
  2764. while (slot.n_past < slot.n_prompt_tokens && batch.n_tokens < n_batch) {
  2765. // get next token to process
  2766. llama_token cur_tok = slot.prompt_tokens[slot.n_past];
  2767. if (cur_tok == LLAMA_TOKEN_NULL) {
  2768. break; // end of text chunk
  2769. }
  2770. // embedding requires all tokens in the batch to be output
  2771. const bool need_embd = server_task_type_need_embd(slot.task_type);
  2772. common_batch_add(batch, cur_tok, slot.n_past, { slot.id }, need_embd);
  2773. slot.cache_tokens.push_back(cur_tok);
  2774. slot.n_prompt_tokens_processed++;
  2775. slot.n_past++;
  2776. }
  2777. // SLT_INF(slot, "new cache_tokens: %s\n", slot.cache_tokens.str().c_str());
  2778. 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);
  2779. // entire prompt has been processed
  2780. if (slot.n_past == slot.n_prompt_tokens) {
  2781. slot.state = SLOT_STATE_DONE_PROMPT;
  2782. GGML_ASSERT(batch.n_tokens > 0);
  2783. GGML_ASSERT((size_t) slot.n_prompt_tokens == slot.prompt_tokens.size());
  2784. common_sampler_reset(slot.smpl);
  2785. // Process all prompt tokens through sampler system
  2786. for (int i = 0; i < slot.n_prompt_tokens; ++i) {
  2787. llama_token id = slot.prompt_tokens[i];
  2788. if (id != LLAMA_TOKEN_NULL) {
  2789. common_sampler_accept(slot.smpl, id, false);
  2790. }
  2791. }
  2792. // extract the logits only for the last token
  2793. batch.logits[batch.n_tokens - 1] = true;
  2794. slot.n_decoded = 0;
  2795. slot.i_batch = batch.n_tokens - 1;
  2796. SLT_INF(slot, "prompt done, n_past = %d, n_tokens = %d\n", slot.n_past, batch.n_tokens);
  2797. }
  2798. }
  2799. if (batch.n_tokens >= n_batch) {
  2800. break;
  2801. }
  2802. }
  2803. }
  2804. if (batch.n_tokens == 0) {
  2805. SRV_WRN("%s", "no tokens to decode\n");
  2806. return;
  2807. }
  2808. SRV_DBG("decoding batch, n_tokens = %d\n", batch.n_tokens);
  2809. if (slot_batched) {
  2810. // apply lora, only need to do it once per batch
  2811. common_set_adapter_lora(ctx, slot_batched->lora);
  2812. llama_set_embeddings(ctx, slot_batched->need_embd());
  2813. }
  2814. // pad the batch so that batch.n_tokens >= n_slots
  2815. // TODO: temporary workaround for https://github.com/ggml-org/llama.cpp/issues/13689
  2816. if (slot_batched->need_embd()) {
  2817. const int n_slots = slots.size();
  2818. if (batch.n_tokens < n_slots) {
  2819. std::set<llama_seq_id> seq_ids;
  2820. for (int j = 0; j < batch.n_tokens; ++j) {
  2821. seq_ids.insert(batch.seq_id[j][0]);
  2822. }
  2823. // find unused sequence id
  2824. llama_seq_id seq_id = -1;
  2825. for (int i = 0; i < n_slots; ++i) {
  2826. if (seq_ids.find(i) == seq_ids.end()) {
  2827. seq_id = i;
  2828. }
  2829. }
  2830. const int n_add = n_slots - batch.n_tokens;
  2831. SRV_WRN("adding %d dummy tokens to the batch, seq_id = %d\n", n_add, seq_id);
  2832. for (int j = 0; j < n_add; ++j) {
  2833. common_batch_add(batch, 0, j, { seq_id }, true);
  2834. }
  2835. slots[seq_id].cache_tokens.clear();
  2836. llama_memory_seq_rm(llama_get_memory(ctx), seq_id, -1, -1);
  2837. }
  2838. }
  2839. int32_t i_next = 0;
  2840. // process the created batch of tokens
  2841. for (int32_t i = 0; i < batch.n_tokens; i = i_next) {
  2842. const int32_t n_tokens = std::min(n_batch, batch.n_tokens - i);
  2843. llama_batch batch_view = {
  2844. n_tokens,
  2845. batch.token + i,
  2846. nullptr,
  2847. batch.pos + i,
  2848. batch.n_seq_id + i,
  2849. batch.seq_id + i,
  2850. batch.logits + i,
  2851. };
  2852. const int ret = llama_decode(ctx, batch_view);
  2853. metrics.on_decoded(slots);
  2854. if (ret != 0) {
  2855. {
  2856. std::string err;
  2857. if (n_batch == 1 && ret == 1) {
  2858. err = "Context size has been exceeded.";
  2859. }
  2860. if (ret == -1) {
  2861. err = "Invalid input batch.";
  2862. }
  2863. if (ret < -1) {
  2864. err = "Compute error.";
  2865. }
  2866. if (!err.empty()) {
  2867. SRV_ERR("%s, i = %d, n_batch = %d, ret = %d\n", err.c_str(), i, n_batch, ret);
  2868. for (auto & slot : slots) {
  2869. slot.release();
  2870. send_error(slot, err);
  2871. }
  2872. break;
  2873. }
  2874. }
  2875. // retry with half the batch size to try to find a free slot in the KV cache
  2876. n_batch /= 2;
  2877. 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);
  2878. continue; // continue loop of n_batch
  2879. }
  2880. // move the head of the batch forward with the number of tokens we just processed
  2881. i_next = i + n_tokens;
  2882. // on successful decode, restore the original batch size
  2883. n_batch = llama_n_batch(ctx);
  2884. for (auto & slot : slots) {
  2885. if (slot.i_batch < (int) i || slot.i_batch >= (int) (i + n_tokens)) {
  2886. continue; // continue loop of slots
  2887. }
  2888. if (slot.state == SLOT_STATE_DONE_PROMPT) {
  2889. if (slot.task_type == SERVER_TASK_TYPE_EMBEDDING) {
  2890. // prompt evaluated for embedding
  2891. send_embedding(slot, batch_view);
  2892. slot.release();
  2893. slot.i_batch = -1;
  2894. continue; // continue loop of slots
  2895. }
  2896. if (slot.task_type == SERVER_TASK_TYPE_RERANK) {
  2897. send_rerank(slot, batch_view);
  2898. slot.release();
  2899. slot.i_batch = -1;
  2900. continue; // continue loop of slots
  2901. }
  2902. // prompt evaluated for next-token prediction
  2903. slot.state = SLOT_STATE_GENERATING;
  2904. } else if (slot.state != SLOT_STATE_GENERATING) {
  2905. continue; // continue loop of slots
  2906. }
  2907. const int tok_idx = slot.i_batch - i;
  2908. llama_token id = common_sampler_sample(slot.smpl, ctx, tok_idx);
  2909. slot.i_batch = -1;
  2910. common_sampler_accept(slot.smpl, id, true);
  2911. slot.n_decoded += 1;
  2912. const int64_t t_current = ggml_time_us();
  2913. if (slot.n_decoded == 1) {
  2914. slot.t_start_generation = t_current;
  2915. slot.t_prompt_processing = (slot.t_start_generation - slot.t_start_process_prompt) / 1e3;
  2916. metrics.on_prompt_eval(slot);
  2917. }
  2918. slot.t_token_generation = (t_current - slot.t_start_generation) / 1e3;
  2919. completion_token_output result;
  2920. result.tok = id;
  2921. result.text_to_send = common_token_to_piece(ctx, result.tok, accept_special_token(slot, result.tok));
  2922. result.prob = 1.0f; // TODO: set it here instead of doing inside populate_token_probs
  2923. if (slot.params.sampling.n_probs > 0) {
  2924. populate_token_probs(slot, result, slot.params.post_sampling_probs, params_base.special, tok_idx);
  2925. }
  2926. if (!process_token(result, slot)) {
  2927. // release slot because of stop condition
  2928. slot.release();
  2929. slot.print_timings();
  2930. send_final_response(slot);
  2931. metrics.on_prediction(slot);
  2932. continue;
  2933. }
  2934. }
  2935. // do speculative decoding
  2936. for (auto & slot : slots) {
  2937. if (!slot.is_processing() || !slot.can_speculate()) {
  2938. continue;
  2939. }
  2940. if (slot.state != SLOT_STATE_GENERATING) {
  2941. continue;
  2942. }
  2943. if (mctx) {
  2944. // we should never reach this, as speculative is automatically disabled if mmproj is loaded
  2945. GGML_ABORT("not supported by multimodal");
  2946. }
  2947. // determine the max draft that fits the current slot state
  2948. int n_draft_max = slot.params.speculative.n_max;
  2949. // note: n_past is not yet increased for the `id` token sampled above
  2950. // also, need to leave space for 1 extra token to allow context shifts
  2951. n_draft_max = std::min(n_draft_max, slot.n_ctx - slot.n_past - 2);
  2952. if (slot.n_remaining > 0) {
  2953. n_draft_max = std::min(n_draft_max, slot.n_remaining - 1);
  2954. }
  2955. SLT_DBG(slot, "max possible draft: %d\n", n_draft_max);
  2956. if (n_draft_max < slot.params.speculative.n_min) {
  2957. SLT_DBG(slot, "the max possible draft is too small: %d < %d - skipping speculative decoding\n", n_draft_max, slot.params.speculative.n_min);
  2958. continue;
  2959. }
  2960. llama_token id = slot.sampled;
  2961. struct common_speculative_params params_spec;
  2962. params_spec.n_draft = n_draft_max;
  2963. params_spec.n_reuse = llama_n_ctx(slot.ctx_dft) - slot.params.speculative.n_max;
  2964. params_spec.p_min = slot.params.speculative.p_min;
  2965. const llama_tokens & cached_text_tokens = slot.cache_tokens.get_text_tokens();
  2966. llama_tokens draft = common_speculative_gen_draft(slot.spec, params_spec, cached_text_tokens, id);
  2967. // ignore small drafts
  2968. if (slot.params.speculative.n_min > (int) draft.size()) {
  2969. SLT_DBG(slot, "ignoring small draft: %d < %d\n", (int) draft.size(), slot.params.speculative.n_min);
  2970. continue;
  2971. }
  2972. // keep track of total number of drafted tokens tested
  2973. slot.n_draft_total += draft.size();
  2974. // construct the speculation batch
  2975. common_batch_clear(slot.batch_spec);
  2976. common_batch_add (slot.batch_spec, id, slot.n_past, { slot.id }, true);
  2977. for (size_t i = 0; i < draft.size(); ++i) {
  2978. common_batch_add(slot.batch_spec, draft[i], slot.n_past + 1 + i, { slot.id }, true);
  2979. }
  2980. SLT_DBG(slot, "decoding speculative batch, size = %d\n", slot.batch_spec.n_tokens);
  2981. llama_decode(ctx, slot.batch_spec);
  2982. // the accepted tokens from the speculation
  2983. const auto ids = common_sampler_sample_and_accept_n(slot.smpl, ctx, draft);
  2984. slot.n_past += ids.size();
  2985. slot.n_decoded += ids.size();
  2986. // update how many tokens out of those tested were accepted
  2987. slot.n_draft_accepted += ids.size() - 1;
  2988. slot.cache_tokens.push_back(id);
  2989. slot.cache_tokens.insert({ids.begin(), ids.end() - 1});
  2990. llama_memory_seq_rm(llama_get_memory(ctx), slot.id, slot.n_past, -1);
  2991. for (size_t i = 0; i < ids.size(); ++i) {
  2992. completion_token_output result;
  2993. result.tok = ids[i];
  2994. result.text_to_send = common_token_to_piece(ctx, result.tok, accept_special_token(slot, result.tok));
  2995. result.prob = 1.0f; // set later
  2996. // TODO: set result.probs
  2997. if (!process_token(result, slot)) {
  2998. // release slot because of stop condition
  2999. slot.release();
  3000. slot.print_timings();
  3001. send_final_response(slot);
  3002. metrics.on_prediction(slot);
  3003. break;
  3004. }
  3005. }
  3006. SLT_DBG(slot, "accepted %d/%d draft tokens, new n_past = %d\n", (int) ids.size() - 1, (int) draft.size(), slot.n_past);
  3007. }
  3008. }
  3009. SRV_DBG("%s", "run slots completed\n");
  3010. }
  3011. json model_meta() const {
  3012. return json {
  3013. {"vocab_type", llama_vocab_type (vocab)},
  3014. {"n_vocab", llama_vocab_n_tokens (vocab)},
  3015. {"n_ctx_train", llama_model_n_ctx_train(model)},
  3016. {"n_embd", llama_model_n_embd (model)},
  3017. {"n_params", llama_model_n_params (model)},
  3018. {"size", llama_model_size (model)},
  3019. };
  3020. }
  3021. };
  3022. static void log_server_request(const httplib::Request & req, const httplib::Response & res) {
  3023. // skip GH copilot requests when using default port
  3024. if (req.path == "/v1/health" || req.path == "/v1/completions") {
  3025. return;
  3026. }
  3027. // reminder: this function is not covered by httplib's exception handler; if someone does more complicated stuff, think about wrapping it in try-catch
  3028. SRV_INF("request: %s %s %s %d\n", req.method.c_str(), req.path.c_str(), req.remote_addr.c_str(), res.status);
  3029. SRV_DBG("request: %s\n", req.body.c_str());
  3030. SRV_DBG("response: %s\n", res.body.c_str());
  3031. }
  3032. std::function<void(int)> shutdown_handler;
  3033. std::atomic_flag is_terminating = ATOMIC_FLAG_INIT;
  3034. inline void signal_handler(int signal) {
  3035. if (is_terminating.test_and_set()) {
  3036. // in case it hangs, we can force terminate the server by hitting Ctrl+C twice
  3037. // this is for better developer experience, we can remove when the server is stable enough
  3038. fprintf(stderr, "Received second interrupt, terminating immediately.\n");
  3039. exit(1);
  3040. }
  3041. shutdown_handler(signal);
  3042. }
  3043. int main(int argc, char ** argv) {
  3044. // own arguments required by this example
  3045. common_params params;
  3046. if (!common_params_parse(argc, argv, params, LLAMA_EXAMPLE_SERVER)) {
  3047. return 1;
  3048. }
  3049. common_init();
  3050. // struct that contains llama context and inference
  3051. server_context ctx_server;
  3052. llama_backend_init();
  3053. llama_numa_init(params.numa);
  3054. 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());
  3055. LOG_INF("\n");
  3056. LOG_INF("%s\n", common_params_get_system_info(params).c_str());
  3057. LOG_INF("\n");
  3058. std::unique_ptr<httplib::Server> svr;
  3059. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  3060. if (params.ssl_file_key != "" && params.ssl_file_cert != "") {
  3061. LOG_INF("Running with SSL: key = %s, cert = %s\n", params.ssl_file_key.c_str(), params.ssl_file_cert.c_str());
  3062. svr.reset(
  3063. new httplib::SSLServer(params.ssl_file_cert.c_str(), params.ssl_file_key.c_str())
  3064. );
  3065. } else {
  3066. LOG_INF("Running without SSL\n");
  3067. svr.reset(new httplib::Server());
  3068. }
  3069. #else
  3070. if (params.ssl_file_key != "" && params.ssl_file_cert != "") {
  3071. LOG_ERR("Server is built without SSL support\n");
  3072. return 1;
  3073. }
  3074. svr.reset(new httplib::Server());
  3075. #endif
  3076. std::atomic<server_state> state{SERVER_STATE_LOADING_MODEL};
  3077. svr->set_default_headers({{"Server", "llama.cpp"}});
  3078. svr->set_logger(log_server_request);
  3079. auto res_error = [](httplib::Response & res, const json & error_data) {
  3080. json final_response {{"error", error_data}};
  3081. res.set_content(safe_json_to_str(final_response), MIMETYPE_JSON);
  3082. res.status = json_value(error_data, "code", 500);
  3083. };
  3084. auto res_ok = [](httplib::Response & res, const json & data) {
  3085. res.set_content(safe_json_to_str(data), MIMETYPE_JSON);
  3086. res.status = 200;
  3087. };
  3088. svr->set_exception_handler([&res_error](const httplib::Request &, httplib::Response & res, const std::exception_ptr & ep) {
  3089. std::string message;
  3090. try {
  3091. std::rethrow_exception(ep);
  3092. } catch (const std::exception & e) {
  3093. message = e.what();
  3094. } catch (...) {
  3095. message = "Unknown Exception";
  3096. }
  3097. try {
  3098. json formatted_error = format_error_response(message, ERROR_TYPE_SERVER);
  3099. LOG_WRN("got exception: %s\n", formatted_error.dump().c_str());
  3100. res_error(res, formatted_error);
  3101. } catch (const std::exception & e) {
  3102. LOG_ERR("got another exception: %s | while hanlding exception: %s\n", e.what(), message.c_str());
  3103. }
  3104. });
  3105. svr->set_error_handler([&res_error](const httplib::Request &, httplib::Response & res) {
  3106. if (res.status == 404) {
  3107. res_error(res, format_error_response("File Not Found", ERROR_TYPE_NOT_FOUND));
  3108. }
  3109. // for other error codes, we skip processing here because it's already done by res_error()
  3110. });
  3111. // set timeouts and change hostname and port
  3112. svr->set_read_timeout (params.timeout_read);
  3113. svr->set_write_timeout(params.timeout_write);
  3114. std::unordered_map<std::string, std::string> log_data;
  3115. log_data["hostname"] = params.hostname;
  3116. log_data["port"] = std::to_string(params.port);
  3117. if (params.api_keys.size() == 1) {
  3118. auto key = params.api_keys[0];
  3119. log_data["api_key"] = "api_key: ****" + key.substr(std::max((int)(key.length() - 4), 0));
  3120. } else if (params.api_keys.size() > 1) {
  3121. log_data["api_key"] = "api_key: " + std::to_string(params.api_keys.size()) + " keys loaded";
  3122. }
  3123. // Necessary similarity of prompt for slot selection
  3124. ctx_server.slot_prompt_similarity = params.slot_prompt_similarity;
  3125. //
  3126. // Middlewares
  3127. //
  3128. auto middleware_validate_api_key = [&params, &res_error](const httplib::Request & req, httplib::Response & res) {
  3129. static const std::unordered_set<std::string> public_endpoints = {
  3130. "/health",
  3131. "/models",
  3132. "/v1/models",
  3133. "/api/tags"
  3134. };
  3135. // If API key is not set, skip validation
  3136. if (params.api_keys.empty()) {
  3137. return true;
  3138. }
  3139. // If path is public or is static file, skip validation
  3140. if (public_endpoints.find(req.path) != public_endpoints.end() || req.path == "/") {
  3141. return true;
  3142. }
  3143. // Check for API key in the header
  3144. auto auth_header = req.get_header_value("Authorization");
  3145. std::string prefix = "Bearer ";
  3146. if (auth_header.substr(0, prefix.size()) == prefix) {
  3147. std::string received_api_key = auth_header.substr(prefix.size());
  3148. if (std::find(params.api_keys.begin(), params.api_keys.end(), received_api_key) != params.api_keys.end()) {
  3149. return true; // API key is valid
  3150. }
  3151. }
  3152. // API key is invalid or not provided
  3153. res_error(res, format_error_response("Invalid API Key", ERROR_TYPE_AUTHENTICATION));
  3154. LOG_WRN("Unauthorized: Invalid API Key\n");
  3155. return false;
  3156. };
  3157. auto middleware_server_state = [&res_error, &state](const httplib::Request & req, httplib::Response & res) {
  3158. server_state current_state = state.load();
  3159. if (current_state == SERVER_STATE_LOADING_MODEL) {
  3160. auto tmp = string_split<std::string>(req.path, '.');
  3161. if (req.path == "/" || tmp.back() == "html") {
  3162. res.set_content(reinterpret_cast<const char*>(loading_html), loading_html_len, "text/html; charset=utf-8");
  3163. res.status = 503;
  3164. } else if (req.path == "/models" || req.path == "/v1/models" || req.path == "/api/tags") {
  3165. // allow the models endpoint to be accessed during loading
  3166. return true;
  3167. } else {
  3168. res_error(res, format_error_response("Loading model", ERROR_TYPE_UNAVAILABLE));
  3169. }
  3170. return false;
  3171. }
  3172. return true;
  3173. };
  3174. // register server middlewares
  3175. svr->set_pre_routing_handler([&middleware_validate_api_key, &middleware_server_state](const httplib::Request & req, httplib::Response & res) {
  3176. res.set_header("Access-Control-Allow-Origin", req.get_header_value("Origin"));
  3177. // If this is OPTIONS request, skip validation because browsers don't include Authorization header
  3178. if (req.method == "OPTIONS") {
  3179. res.set_header("Access-Control-Allow-Credentials", "true");
  3180. res.set_header("Access-Control-Allow-Methods", "GET, POST");
  3181. res.set_header("Access-Control-Allow-Headers", "*");
  3182. res.set_content("", "text/html"); // blank response, no data
  3183. return httplib::Server::HandlerResponse::Handled; // skip further processing
  3184. }
  3185. if (!middleware_server_state(req, res)) {
  3186. return httplib::Server::HandlerResponse::Handled;
  3187. }
  3188. if (!middleware_validate_api_key(req, res)) {
  3189. return httplib::Server::HandlerResponse::Handled;
  3190. }
  3191. return httplib::Server::HandlerResponse::Unhandled;
  3192. });
  3193. //
  3194. // Route handlers (or controllers)
  3195. //
  3196. const auto handle_health = [&](const httplib::Request &, httplib::Response & res) {
  3197. // error and loading states are handled by middleware
  3198. json health = {{"status", "ok"}};
  3199. res_ok(res, health);
  3200. };
  3201. const auto handle_slots = [&](const httplib::Request & req, httplib::Response & res) {
  3202. if (!params.endpoint_slots) {
  3203. res_error(res, format_error_response("This server does not support slots endpoint. Start it with `--slots`", ERROR_TYPE_NOT_SUPPORTED));
  3204. return;
  3205. }
  3206. // request slots data using task queue
  3207. int task_id = ctx_server.queue_tasks.get_new_id();
  3208. {
  3209. server_task task(SERVER_TASK_TYPE_METRICS);
  3210. task.id = task_id;
  3211. ctx_server.queue_results.add_waiting_task_id(task_id);
  3212. ctx_server.queue_tasks.post(std::move(task), true); // high-priority task
  3213. }
  3214. // get the result
  3215. server_task_result_ptr result = ctx_server.queue_results.recv(task_id);
  3216. ctx_server.queue_results.remove_waiting_task_id(task_id);
  3217. if (result->is_error()) {
  3218. res_error(res, result->to_json());
  3219. return;
  3220. }
  3221. // TODO: get rid of this dynamic_cast
  3222. auto res_metrics = dynamic_cast<server_task_result_metrics*>(result.get());
  3223. GGML_ASSERT(res_metrics != nullptr);
  3224. // optionally return "fail_on_no_slot" error
  3225. if (req.has_param("fail_on_no_slot")) {
  3226. if (res_metrics->n_idle_slots == 0) {
  3227. res_error(res, format_error_response("no slot available", ERROR_TYPE_UNAVAILABLE));
  3228. return;
  3229. }
  3230. }
  3231. res_ok(res, res_metrics->slots_data);
  3232. };
  3233. const auto handle_metrics = [&](const httplib::Request &, httplib::Response & res) {
  3234. if (!params.endpoint_metrics) {
  3235. res_error(res, format_error_response("This server does not support metrics endpoint. Start it with `--metrics`", ERROR_TYPE_NOT_SUPPORTED));
  3236. return;
  3237. }
  3238. // request slots data using task queue
  3239. int task_id = ctx_server.queue_tasks.get_new_id();
  3240. {
  3241. server_task task(SERVER_TASK_TYPE_METRICS);
  3242. task.id = task_id;
  3243. ctx_server.queue_results.add_waiting_task_id(task_id);
  3244. ctx_server.queue_tasks.post(std::move(task), true); // high-priority task
  3245. }
  3246. // get the result
  3247. server_task_result_ptr result = ctx_server.queue_results.recv(task_id);
  3248. ctx_server.queue_results.remove_waiting_task_id(task_id);
  3249. if (result->is_error()) {
  3250. res_error(res, result->to_json());
  3251. return;
  3252. }
  3253. // TODO: get rid of this dynamic_cast
  3254. auto res_metrics = dynamic_cast<server_task_result_metrics*>(result.get());
  3255. GGML_ASSERT(res_metrics != nullptr);
  3256. // metrics definition: https://prometheus.io/docs/practices/naming/#metric-names
  3257. json all_metrics_def = json {
  3258. {"counter", {{
  3259. {"name", "prompt_tokens_total"},
  3260. {"help", "Number of prompt tokens processed."},
  3261. {"value", (uint64_t) res_metrics->n_prompt_tokens_processed_total}
  3262. }, {
  3263. {"name", "prompt_seconds_total"},
  3264. {"help", "Prompt process time"},
  3265. {"value", (uint64_t) res_metrics->t_prompt_processing_total / 1.e3}
  3266. }, {
  3267. {"name", "tokens_predicted_total"},
  3268. {"help", "Number of generation tokens processed."},
  3269. {"value", (uint64_t) res_metrics->n_tokens_predicted_total}
  3270. }, {
  3271. {"name", "tokens_predicted_seconds_total"},
  3272. {"help", "Predict process time"},
  3273. {"value", (uint64_t) res_metrics->t_tokens_generation_total / 1.e3}
  3274. }, {
  3275. {"name", "n_decode_total"},
  3276. {"help", "Total number of llama_decode() calls"},
  3277. {"value", res_metrics->n_decode_total}
  3278. }, {
  3279. {"name", "n_busy_slots_per_decode"},
  3280. {"help", "Average number of busy slots per llama_decode() call"},
  3281. {"value", (float) res_metrics->n_busy_slots_total / std::max((float) res_metrics->n_decode_total, 1.f)}
  3282. }}},
  3283. {"gauge", {{
  3284. {"name", "prompt_tokens_seconds"},
  3285. {"help", "Average prompt throughput in tokens/s."},
  3286. {"value", res_metrics->n_prompt_tokens_processed ? 1.e3 / res_metrics->t_prompt_processing * res_metrics->n_prompt_tokens_processed : 0.}
  3287. },{
  3288. {"name", "predicted_tokens_seconds"},
  3289. {"help", "Average generation throughput in tokens/s."},
  3290. {"value", res_metrics->n_tokens_predicted ? 1.e3 / res_metrics->t_tokens_generation * res_metrics->n_tokens_predicted : 0.}
  3291. },{
  3292. {"name", "requests_processing"},
  3293. {"help", "Number of requests processing."},
  3294. {"value", (uint64_t) res_metrics->n_processing_slots}
  3295. },{
  3296. {"name", "requests_deferred"},
  3297. {"help", "Number of requests deferred."},
  3298. {"value", (uint64_t) res_metrics->n_tasks_deferred}
  3299. }}}
  3300. };
  3301. std::stringstream prometheus;
  3302. for (const auto & el : all_metrics_def.items()) {
  3303. const auto & type = el.key();
  3304. const auto & metrics_def = el.value();
  3305. for (const auto & metric_def : metrics_def) {
  3306. const std::string name = metric_def.at("name");
  3307. const std::string help = metric_def.at("help");
  3308. auto value = json_value(metric_def, "value", 0.);
  3309. prometheus << "# HELP llamacpp:" << name << " " << help << "\n"
  3310. << "# TYPE llamacpp:" << name << " " << type << "\n"
  3311. << "llamacpp:" << name << " " << value << "\n";
  3312. }
  3313. }
  3314. res.set_header("Process-Start-Time-Unix", std::to_string(res_metrics->t_start));
  3315. res.set_content(prometheus.str(), "text/plain; version=0.0.4");
  3316. res.status = 200; // HTTP OK
  3317. };
  3318. const auto handle_slots_save = [&ctx_server, &res_error, &res_ok, &params](const httplib::Request & req, httplib::Response & res, int id_slot) {
  3319. json request_data = json::parse(req.body);
  3320. std::string filename = request_data.at("filename");
  3321. if (!fs_validate_filename(filename)) {
  3322. res_error(res, format_error_response("Invalid filename", ERROR_TYPE_INVALID_REQUEST));
  3323. return;
  3324. }
  3325. std::string filepath = params.slot_save_path + filename;
  3326. int task_id = ctx_server.queue_tasks.get_new_id();
  3327. {
  3328. server_task task(SERVER_TASK_TYPE_SLOT_SAVE);
  3329. task.id = task_id;
  3330. task.slot_action.slot_id = id_slot;
  3331. task.slot_action.filename = filename;
  3332. task.slot_action.filepath = filepath;
  3333. ctx_server.queue_results.add_waiting_task_id(task_id);
  3334. ctx_server.queue_tasks.post(std::move(task));
  3335. }
  3336. server_task_result_ptr result = ctx_server.queue_results.recv(task_id);
  3337. ctx_server.queue_results.remove_waiting_task_id(task_id);
  3338. if (result->is_error()) {
  3339. res_error(res, result->to_json());
  3340. return;
  3341. }
  3342. res_ok(res, result->to_json());
  3343. };
  3344. const auto handle_slots_restore = [&ctx_server, &res_error, &res_ok, &params](const httplib::Request & req, httplib::Response & res, int id_slot) {
  3345. json request_data = json::parse(req.body);
  3346. std::string filename = request_data.at("filename");
  3347. if (!fs_validate_filename(filename)) {
  3348. res_error(res, format_error_response("Invalid filename", ERROR_TYPE_INVALID_REQUEST));
  3349. return;
  3350. }
  3351. std::string filepath = params.slot_save_path + filename;
  3352. int task_id = ctx_server.queue_tasks.get_new_id();
  3353. {
  3354. server_task task(SERVER_TASK_TYPE_SLOT_RESTORE);
  3355. task.id = task_id;
  3356. task.slot_action.slot_id = id_slot;
  3357. task.slot_action.filename = filename;
  3358. task.slot_action.filepath = filepath;
  3359. ctx_server.queue_results.add_waiting_task_id(task_id);
  3360. ctx_server.queue_tasks.post(std::move(task));
  3361. }
  3362. server_task_result_ptr result = ctx_server.queue_results.recv(task_id);
  3363. ctx_server.queue_results.remove_waiting_task_id(task_id);
  3364. if (result->is_error()) {
  3365. res_error(res, result->to_json());
  3366. return;
  3367. }
  3368. GGML_ASSERT(dynamic_cast<server_task_result_slot_save_load*>(result.get()) != nullptr);
  3369. res_ok(res, result->to_json());
  3370. };
  3371. const auto handle_slots_erase = [&ctx_server, &res_error, &res_ok](const httplib::Request & /* req */, httplib::Response & res, int id_slot) {
  3372. int task_id = ctx_server.queue_tasks.get_new_id();
  3373. {
  3374. server_task task(SERVER_TASK_TYPE_SLOT_ERASE);
  3375. task.id = task_id;
  3376. task.slot_action.slot_id = id_slot;
  3377. ctx_server.queue_results.add_waiting_task_id(task_id);
  3378. ctx_server.queue_tasks.post(std::move(task));
  3379. }
  3380. server_task_result_ptr result = ctx_server.queue_results.recv(task_id);
  3381. ctx_server.queue_results.remove_waiting_task_id(task_id);
  3382. if (result->is_error()) {
  3383. res_error(res, result->to_json());
  3384. return;
  3385. }
  3386. GGML_ASSERT(dynamic_cast<server_task_result_slot_erase*>(result.get()) != nullptr);
  3387. res_ok(res, result->to_json());
  3388. };
  3389. const auto handle_slots_action = [&params, &res_error, &handle_slots_save, &handle_slots_restore, &handle_slots_erase](const httplib::Request & req, httplib::Response & res) {
  3390. if (params.slot_save_path.empty()) {
  3391. res_error(res, format_error_response("This server does not support slots action. Start it with `--slot-save-path`", ERROR_TYPE_NOT_SUPPORTED));
  3392. return;
  3393. }
  3394. std::string id_slot_str = req.path_params.at("id_slot");
  3395. int id_slot;
  3396. try {
  3397. id_slot = std::stoi(id_slot_str);
  3398. } catch (const std::exception &) {
  3399. res_error(res, format_error_response("Invalid slot ID", ERROR_TYPE_INVALID_REQUEST));
  3400. return;
  3401. }
  3402. std::string action = req.get_param_value("action");
  3403. if (action == "save") {
  3404. handle_slots_save(req, res, id_slot);
  3405. } else if (action == "restore") {
  3406. handle_slots_restore(req, res, id_slot);
  3407. } else if (action == "erase") {
  3408. handle_slots_erase(req, res, id_slot);
  3409. } else {
  3410. res_error(res, format_error_response("Invalid action", ERROR_TYPE_INVALID_REQUEST));
  3411. }
  3412. };
  3413. const auto handle_props = [&ctx_server, &res_ok](const httplib::Request &, httplib::Response & res) {
  3414. // this endpoint is publicly available, please only return what is safe to be exposed
  3415. json data = {
  3416. { "default_generation_settings", ctx_server.default_generation_settings_for_props },
  3417. { "total_slots", ctx_server.params_base.n_parallel },
  3418. { "model_path", ctx_server.params_base.model.path },
  3419. { "modalities", json{
  3420. {"vision", ctx_server.oai_parser_opt.allow_image},
  3421. {"audio", ctx_server.oai_parser_opt.allow_audio},
  3422. } },
  3423. { "chat_template", common_chat_templates_source(ctx_server.chat_templates.get()) },
  3424. { "bos_token", common_token_to_piece(ctx_server.ctx, llama_vocab_bos(ctx_server.vocab), /* special= */ true)},
  3425. { "eos_token", common_token_to_piece(ctx_server.ctx, llama_vocab_eos(ctx_server.vocab), /* special= */ true)},
  3426. { "build_info", build_info },
  3427. };
  3428. if (ctx_server.params_base.use_jinja) {
  3429. if (auto tool_use_src = common_chat_templates_source(ctx_server.chat_templates.get(), "tool_use")) {
  3430. data["chat_template_tool_use"] = tool_use_src;
  3431. }
  3432. }
  3433. res_ok(res, data);
  3434. };
  3435. const auto handle_props_change = [&ctx_server, &res_error, &res_ok](const httplib::Request & req, httplib::Response & res) {
  3436. if (!ctx_server.params_base.endpoint_props) {
  3437. res_error(res, format_error_response("This server does not support changing global properties. Start it with `--props`", ERROR_TYPE_NOT_SUPPORTED));
  3438. return;
  3439. }
  3440. json data = json::parse(req.body);
  3441. // update any props here
  3442. res_ok(res, {{ "success", true }});
  3443. };
  3444. const auto handle_api_show = [&ctx_server, &res_ok](const httplib::Request &, httplib::Response & res) {
  3445. json data = {
  3446. {
  3447. "template", common_chat_templates_source(ctx_server.chat_templates.get()),
  3448. },
  3449. {
  3450. "model_info", {
  3451. { "llama.context_length", ctx_server.slots.back().n_ctx, },
  3452. }
  3453. },
  3454. {"modelfile", ""},
  3455. {"parameters", ""},
  3456. {"template", common_chat_templates_source(ctx_server.chat_templates.get())},
  3457. {"details", {
  3458. {"parent_model", ""},
  3459. {"format", "gguf"},
  3460. {"family", ""},
  3461. {"families", {""}},
  3462. {"parameter_size", ""},
  3463. {"quantization_level", ""}
  3464. }},
  3465. {"model_info", ""},
  3466. {"capabilities", {"completion"}}
  3467. };
  3468. res_ok(res, data);
  3469. };
  3470. // handle completion-like requests (completion, chat, infill)
  3471. // we can optionally provide a custom format for partial results and final results
  3472. const auto handle_completions_impl = [&ctx_server, &res_error, &res_ok](
  3473. server_task_type type,
  3474. json & data,
  3475. const std::vector<raw_buffer> & files,
  3476. const std::function<bool()> & is_connection_closed,
  3477. httplib::Response & res,
  3478. oaicompat_type oaicompat) -> void {
  3479. GGML_ASSERT(type == SERVER_TASK_TYPE_COMPLETION || type == SERVER_TASK_TYPE_INFILL);
  3480. auto completion_id = gen_chatcmplid();
  3481. std::unordered_set<int> task_ids;
  3482. try {
  3483. std::vector<server_task> tasks;
  3484. const auto & prompt = data.at("prompt");
  3485. // TODO: this log can become very long, put it behind a flag or think about a more compact format
  3486. //SRV_DBG("Prompt: %s\n", prompt.is_string() ? prompt.get<std::string>().c_str() : prompt.dump(2).c_str());
  3487. // process files
  3488. mtmd::bitmaps bitmaps;
  3489. const bool has_mtmd = ctx_server.mctx != nullptr;
  3490. {
  3491. if (!has_mtmd && !files.empty()) {
  3492. throw std::runtime_error("This server does not support multimodal");
  3493. }
  3494. for (auto & file : files) {
  3495. mtmd::bitmap bmp(mtmd_helper_bitmap_init_from_buf(ctx_server.mctx, file.data(), file.size()));
  3496. if (!bmp.ptr) {
  3497. throw std::runtime_error("Failed to load image or audio file");
  3498. }
  3499. // calculate bitmap hash (for KV caching)
  3500. std::string hash = fnv_hash(bmp.data(), bmp.n_bytes());
  3501. bmp.set_id(hash.c_str());
  3502. bitmaps.entries.push_back(std::move(bmp));
  3503. }
  3504. }
  3505. // process prompt
  3506. std::vector<server_tokens> inputs;
  3507. if (oaicompat && !prompt.is_string()) {
  3508. throw std::runtime_error("prompt must be a string");
  3509. }
  3510. if (oaicompat && has_mtmd) {
  3511. // multimodal
  3512. std::string prompt_str = prompt.get<std::string>();
  3513. mtmd_input_text inp_txt = {
  3514. prompt_str.c_str(),
  3515. /* add_special */ true,
  3516. /* parse_special */ true,
  3517. };
  3518. mtmd::input_chunks chunks(mtmd_input_chunks_init());
  3519. auto bitmaps_c_ptr = bitmaps.c_ptr();
  3520. int32_t tokenized = mtmd_tokenize(ctx_server.mctx,
  3521. chunks.ptr.get(),
  3522. &inp_txt,
  3523. bitmaps_c_ptr.data(),
  3524. bitmaps_c_ptr.size());
  3525. if (tokenized != 0) {
  3526. throw std::runtime_error("Failed to tokenize prompt");
  3527. }
  3528. server_tokens tmp(chunks, true);
  3529. inputs.push_back(std::move(tmp));
  3530. } else {
  3531. // non-multimodal version
  3532. auto tokenized_prompts = tokenize_input_prompts(ctx_server.vocab, prompt, true, true);
  3533. for (auto & p : tokenized_prompts) {
  3534. auto tmp = server_tokens(p, ctx_server.mctx != nullptr);
  3535. inputs.push_back(std::move(tmp));
  3536. }
  3537. }
  3538. tasks.reserve(inputs.size());
  3539. for (size_t i = 0; i < inputs.size(); i++) {
  3540. server_task task = server_task(type);
  3541. task.id = ctx_server.queue_tasks.get_new_id();
  3542. task.index = i;
  3543. task.prompt_tokens = std::move(inputs[i]);
  3544. task.params = server_task::params_from_json_cmpl(
  3545. ctx_server.ctx,
  3546. ctx_server.params_base,
  3547. data);
  3548. task.id_selected_slot = json_value(data, "id_slot", -1);
  3549. // OAI-compat
  3550. task.params.oaicompat = oaicompat;
  3551. task.params.oaicompat_cmpl_id = completion_id;
  3552. // oaicompat_model is already populated by params_from_json_cmpl
  3553. tasks.push_back(std::move(task));
  3554. }
  3555. task_ids = server_task::get_list_id(tasks);
  3556. ctx_server.queue_results.add_waiting_tasks(tasks);
  3557. ctx_server.queue_tasks.post(std::move(tasks));
  3558. } catch (const std::exception & e) {
  3559. res_error(res, format_error_response(e.what(), ERROR_TYPE_INVALID_REQUEST));
  3560. return;
  3561. }
  3562. bool stream = json_value(data, "stream", false);
  3563. if (!stream) {
  3564. ctx_server.receive_multi_results(task_ids, [&](std::vector<server_task_result_ptr> & results) {
  3565. if (results.size() == 1) {
  3566. // single result
  3567. res_ok(res, results[0]->to_json());
  3568. } else {
  3569. // multiple results (multitask)
  3570. json arr = json::array();
  3571. for (auto & res : results) {
  3572. arr.push_back(res->to_json());
  3573. }
  3574. res_ok(res, arr);
  3575. }
  3576. }, [&](const json & error_data) {
  3577. res_error(res, error_data);
  3578. }, is_connection_closed);
  3579. ctx_server.queue_results.remove_waiting_task_ids(task_ids);
  3580. } else {
  3581. const auto chunked_content_provider = [task_ids, &ctx_server, oaicompat](size_t, httplib::DataSink & sink) {
  3582. ctx_server.receive_cmpl_results_stream(task_ids, [&](server_task_result_ptr & result) -> bool {
  3583. json res_json = result->to_json();
  3584. if (res_json.is_array()) {
  3585. for (const auto & res : res_json) {
  3586. if (!server_sent_event(sink, "data", res)) {
  3587. // sending failed (HTTP connection closed), cancel the generation
  3588. return false;
  3589. }
  3590. }
  3591. return true;
  3592. } else {
  3593. return server_sent_event(sink, "data", res_json);
  3594. }
  3595. }, [&](const json & error_data) {
  3596. server_sent_event(sink, "error", error_data);
  3597. }, [&sink]() {
  3598. // note: do not use req.is_connection_closed here because req is already destroyed
  3599. return !sink.is_writable();
  3600. });
  3601. if (oaicompat != OAICOMPAT_TYPE_NONE) {
  3602. static const std::string ev_done = "data: [DONE]\n\n";
  3603. sink.write(ev_done.data(), ev_done.size());
  3604. }
  3605. sink.done();
  3606. return false;
  3607. };
  3608. auto on_complete = [task_ids, &ctx_server] (bool) {
  3609. ctx_server.queue_results.remove_waiting_task_ids(task_ids);
  3610. };
  3611. res.set_chunked_content_provider("text/event-stream", chunked_content_provider, on_complete);
  3612. }
  3613. };
  3614. const auto handle_completions = [&handle_completions_impl](const httplib::Request & req, httplib::Response & res) {
  3615. json data = json::parse(req.body);
  3616. std::vector<raw_buffer> files; // dummy
  3617. handle_completions_impl(
  3618. SERVER_TASK_TYPE_COMPLETION,
  3619. data,
  3620. files,
  3621. req.is_connection_closed,
  3622. res,
  3623. OAICOMPAT_TYPE_NONE);
  3624. };
  3625. const auto handle_completions_oai = [&handle_completions_impl](const httplib::Request & req, httplib::Response & res) {
  3626. json data = oaicompat_completion_params_parse(json::parse(req.body));
  3627. std::vector<raw_buffer> files; // dummy
  3628. handle_completions_impl(
  3629. SERVER_TASK_TYPE_COMPLETION,
  3630. data,
  3631. files,
  3632. req.is_connection_closed,
  3633. res,
  3634. OAICOMPAT_TYPE_COMPLETION);
  3635. };
  3636. const auto handle_infill = [&ctx_server, &res_error, &handle_completions_impl](const httplib::Request & req, httplib::Response & res) {
  3637. // check model compatibility
  3638. std::string err;
  3639. if (llama_vocab_fim_pre(ctx_server.vocab) == LLAMA_TOKEN_NULL) {
  3640. err += "prefix token is missing. ";
  3641. }
  3642. if (llama_vocab_fim_suf(ctx_server.vocab) == LLAMA_TOKEN_NULL) {
  3643. err += "suffix token is missing. ";
  3644. }
  3645. if (llama_vocab_fim_mid(ctx_server.vocab) == LLAMA_TOKEN_NULL) {
  3646. err += "middle token is missing. ";
  3647. }
  3648. if (!err.empty()) {
  3649. res_error(res, format_error_response(string_format("Infill is not supported by this model: %s", err.c_str()), ERROR_TYPE_NOT_SUPPORTED));
  3650. return;
  3651. }
  3652. json data = json::parse(req.body);
  3653. // validate input
  3654. if (data.contains("prompt") && !data.at("prompt").is_string()) {
  3655. // prompt is optional
  3656. res_error(res, format_error_response("\"prompt\" must be a string", ERROR_TYPE_INVALID_REQUEST));
  3657. }
  3658. if (!data.contains("input_prefix")) {
  3659. res_error(res, format_error_response("\"input_prefix\" is required", ERROR_TYPE_INVALID_REQUEST));
  3660. }
  3661. if (!data.contains("input_suffix")) {
  3662. res_error(res, format_error_response("\"input_suffix\" is required", ERROR_TYPE_INVALID_REQUEST));
  3663. }
  3664. if (data.contains("input_extra") && !data.at("input_extra").is_array()) {
  3665. // input_extra is optional
  3666. res_error(res, format_error_response("\"input_extra\" must be an array of {\"filename\": string, \"text\": string}", ERROR_TYPE_INVALID_REQUEST));
  3667. return;
  3668. }
  3669. json input_extra = json_value(data, "input_extra", json::array());
  3670. for (const auto & chunk : input_extra) {
  3671. // { "text": string, "filename": string }
  3672. if (!chunk.contains("text") || !chunk.at("text").is_string()) {
  3673. res_error(res, format_error_response("extra_context chunk must contain a \"text\" field with a string value", ERROR_TYPE_INVALID_REQUEST));
  3674. return;
  3675. }
  3676. // filename is optional
  3677. if (chunk.contains("filename") && !chunk.at("filename").is_string()) {
  3678. res_error(res, format_error_response("extra_context chunk's \"filename\" field must be a string", ERROR_TYPE_INVALID_REQUEST));
  3679. return;
  3680. }
  3681. }
  3682. data["input_extra"] = input_extra; // default to empty array if it's not exist
  3683. std::string prompt = json_value(data, "prompt", std::string());
  3684. std::vector<llama_tokens> tokenized_prompts = tokenize_input_prompts(ctx_server.vocab, prompt, false, true);
  3685. SRV_DBG("creating infill tasks, n_prompts = %d\n", (int) tokenized_prompts.size());
  3686. data["prompt"] = format_infill(
  3687. ctx_server.vocab,
  3688. data.at("input_prefix"),
  3689. data.at("input_suffix"),
  3690. data.at("input_extra"),
  3691. ctx_server.params_base.n_batch,
  3692. ctx_server.params_base.n_predict,
  3693. ctx_server.slots[0].n_ctx, // TODO: there should be a better way
  3694. ctx_server.params_base.spm_infill,
  3695. tokenized_prompts[0]
  3696. );
  3697. std::vector<raw_buffer> files; // dummy
  3698. handle_completions_impl(
  3699. SERVER_TASK_TYPE_INFILL,
  3700. data,
  3701. files,
  3702. req.is_connection_closed,
  3703. res,
  3704. OAICOMPAT_TYPE_NONE); // infill is not OAI compatible
  3705. };
  3706. const auto handle_chat_completions = [&ctx_server, &handle_completions_impl](const httplib::Request & req, httplib::Response & res) {
  3707. LOG_DBG("request: %s\n", req.body.c_str());
  3708. auto body = json::parse(req.body);
  3709. std::vector<raw_buffer> files;
  3710. json data = oaicompat_chat_params_parse(
  3711. body,
  3712. ctx_server.oai_parser_opt,
  3713. files);
  3714. handle_completions_impl(
  3715. SERVER_TASK_TYPE_COMPLETION,
  3716. data,
  3717. files,
  3718. req.is_connection_closed,
  3719. res,
  3720. OAICOMPAT_TYPE_CHAT);
  3721. };
  3722. // same with handle_chat_completions, but without inference part
  3723. const auto handle_apply_template = [&ctx_server, &res_ok](const httplib::Request & req, httplib::Response & res) {
  3724. auto body = json::parse(req.body);
  3725. std::vector<raw_buffer> files; // dummy, unused
  3726. json data = oaicompat_chat_params_parse(
  3727. body,
  3728. ctx_server.oai_parser_opt,
  3729. files);
  3730. res_ok(res, {{ "prompt", std::move(data.at("prompt")) }});
  3731. };
  3732. const auto handle_models = [&params, &ctx_server, &state, &res_ok](const httplib::Request &, httplib::Response & res) {
  3733. server_state current_state = state.load();
  3734. json model_meta = nullptr;
  3735. if (current_state == SERVER_STATE_READY) {
  3736. model_meta = ctx_server.model_meta();
  3737. }
  3738. json models = {
  3739. {"models", {
  3740. {
  3741. {"name", params.model_alias.empty() ? params.model.path : params.model_alias},
  3742. {"model", params.model_alias.empty() ? params.model.path : params.model_alias},
  3743. {"modified_at", ""},
  3744. {"size", ""},
  3745. {"digest", ""}, // dummy value, llama.cpp does not support managing model file's hash
  3746. {"type", "model"},
  3747. {"description", ""},
  3748. {"tags", {""}},
  3749. {"capabilities", {"completion"}},
  3750. {"parameters", ""},
  3751. {"details", {
  3752. {"parent_model", ""},
  3753. {"format", "gguf"},
  3754. {"family", ""},
  3755. {"families", {""}},
  3756. {"parameter_size", ""},
  3757. {"quantization_level", ""}
  3758. }}
  3759. }
  3760. }},
  3761. {"object", "list"},
  3762. {"data", {
  3763. {
  3764. {"id", params.model_alias.empty() ? params.model.path : params.model_alias},
  3765. {"object", "model"},
  3766. {"created", std::time(0)},
  3767. {"owned_by", "llamacpp"},
  3768. {"meta", model_meta},
  3769. },
  3770. }}
  3771. };
  3772. res_ok(res, models);
  3773. };
  3774. const auto handle_tokenize = [&ctx_server, &res_ok](const httplib::Request & req, httplib::Response & res) {
  3775. const json body = json::parse(req.body);
  3776. json tokens_response = json::array();
  3777. if (body.count("content") != 0) {
  3778. const bool add_special = json_value(body, "add_special", false);
  3779. const bool with_pieces = json_value(body, "with_pieces", false);
  3780. llama_tokens tokens = tokenize_mixed(ctx_server.vocab, body.at("content"), add_special, true);
  3781. if (with_pieces) {
  3782. for (const auto& token : tokens) {
  3783. std::string piece = common_token_to_piece(ctx_server.ctx, token);
  3784. json piece_json;
  3785. // Check if the piece is valid UTF-8
  3786. if (is_valid_utf8(piece)) {
  3787. piece_json = piece;
  3788. } else {
  3789. // If not valid UTF-8, store as array of byte values
  3790. piece_json = json::array();
  3791. for (unsigned char c : piece) {
  3792. piece_json.push_back(static_cast<int>(c));
  3793. }
  3794. }
  3795. tokens_response.push_back({
  3796. {"id", token},
  3797. {"piece", piece_json}
  3798. });
  3799. }
  3800. } else {
  3801. tokens_response = tokens;
  3802. }
  3803. }
  3804. const json data = format_tokenizer_response(tokens_response);
  3805. res_ok(res, data);
  3806. };
  3807. const auto handle_detokenize = [&ctx_server, &res_ok](const httplib::Request & req, httplib::Response & res) {
  3808. const json body = json::parse(req.body);
  3809. std::string content;
  3810. if (body.count("tokens") != 0) {
  3811. const llama_tokens tokens = body.at("tokens");
  3812. content = tokens_to_str(ctx_server.ctx, tokens.cbegin(), tokens.cend());
  3813. }
  3814. const json data = format_detokenized_response(content);
  3815. res_ok(res, data);
  3816. };
  3817. const auto handle_embeddings_impl = [&ctx_server, &res_error, &res_ok](const httplib::Request & req, httplib::Response & res, oaicompat_type oaicompat) {
  3818. if (!ctx_server.params_base.embedding) {
  3819. res_error(res, format_error_response("This server does not support embeddings. Start it with `--embeddings`", ERROR_TYPE_NOT_SUPPORTED));
  3820. return;
  3821. }
  3822. if (oaicompat != OAICOMPAT_TYPE_NONE && llama_pooling_type(ctx_server.ctx) == LLAMA_POOLING_TYPE_NONE) {
  3823. res_error(res, format_error_response("Pooling type 'none' is not OAI compatible. Please use a different pooling type", ERROR_TYPE_INVALID_REQUEST));
  3824. return;
  3825. }
  3826. const json body = json::parse(req.body);
  3827. // for the shape of input/content, see tokenize_input_prompts()
  3828. json prompt;
  3829. if (body.count("input") != 0) {
  3830. prompt = body.at("input");
  3831. } else if (body.contains("content")) {
  3832. oaicompat = OAICOMPAT_TYPE_NONE; // "content" field is not OAI compatible
  3833. prompt = body.at("content");
  3834. } else {
  3835. res_error(res, format_error_response("\"input\" or \"content\" must be provided", ERROR_TYPE_INVALID_REQUEST));
  3836. return;
  3837. }
  3838. bool use_base64 = false;
  3839. if (body.count("encoding_format") != 0) {
  3840. const std::string& format = body.at("encoding_format");
  3841. if (format == "base64") {
  3842. use_base64 = true;
  3843. } else if (format != "float") {
  3844. res_error(res, format_error_response("The format to return the embeddings in. Can be either float or base64", ERROR_TYPE_INVALID_REQUEST));
  3845. return;
  3846. }
  3847. }
  3848. auto tokenized_prompts = tokenize_input_prompts(ctx_server.vocab, prompt, true, true);
  3849. for (const auto & tokens : tokenized_prompts) {
  3850. // this check is necessary for models that do not add BOS token to the input
  3851. if (tokens.empty()) {
  3852. res_error(res, format_error_response("Input content cannot be empty", ERROR_TYPE_INVALID_REQUEST));
  3853. return;
  3854. }
  3855. }
  3856. // create and queue the task
  3857. json responses = json::array();
  3858. bool error = false;
  3859. std::unordered_set<int> task_ids;
  3860. {
  3861. std::vector<server_task> tasks;
  3862. for (size_t i = 0; i < tokenized_prompts.size(); i++) {
  3863. server_task task = server_task(SERVER_TASK_TYPE_EMBEDDING);
  3864. task.id = ctx_server.queue_tasks.get_new_id();
  3865. task.index = i;
  3866. task.prompt_tokens = server_tokens(tokenized_prompts[i], ctx_server.mctx != nullptr);
  3867. // OAI-compat
  3868. task.params.oaicompat = oaicompat;
  3869. tasks.push_back(std::move(task));
  3870. }
  3871. task_ids = server_task::get_list_id(tasks);
  3872. ctx_server.queue_results.add_waiting_tasks(tasks);
  3873. ctx_server.queue_tasks.post(std::move(tasks));
  3874. }
  3875. // get the result
  3876. ctx_server.receive_multi_results(task_ids, [&](std::vector<server_task_result_ptr> & results) {
  3877. for (auto & res : results) {
  3878. GGML_ASSERT(dynamic_cast<server_task_result_embd*>(res.get()) != nullptr);
  3879. responses.push_back(res->to_json());
  3880. }
  3881. }, [&](const json & error_data) {
  3882. res_error(res, error_data);
  3883. error = true;
  3884. }, req.is_connection_closed);
  3885. ctx_server.queue_results.remove_waiting_task_ids(task_ids);
  3886. if (error) {
  3887. return;
  3888. }
  3889. // write JSON response
  3890. json root = oaicompat == OAICOMPAT_TYPE_EMBEDDING
  3891. ? format_embeddings_response_oaicompat(body, responses, use_base64)
  3892. : json(responses);
  3893. res_ok(res, root);
  3894. };
  3895. const auto handle_embeddings = [&handle_embeddings_impl](const httplib::Request & req, httplib::Response & res) {
  3896. handle_embeddings_impl(req, res, OAICOMPAT_TYPE_NONE);
  3897. };
  3898. const auto handle_embeddings_oai = [&handle_embeddings_impl](const httplib::Request & req, httplib::Response & res) {
  3899. handle_embeddings_impl(req, res, OAICOMPAT_TYPE_EMBEDDING);
  3900. };
  3901. const auto handle_rerank = [&ctx_server, &res_error, &res_ok](const httplib::Request & req, httplib::Response & res) {
  3902. if (!ctx_server.params_base.embedding || ctx_server.params_base.pooling_type != LLAMA_POOLING_TYPE_RANK) {
  3903. res_error(res, format_error_response("This server does not support reranking. Start it with `--reranking`", ERROR_TYPE_NOT_SUPPORTED));
  3904. return;
  3905. }
  3906. const json body = json::parse(req.body);
  3907. // TODO: implement
  3908. //int top_n = 1;
  3909. //if (body.count("top_n") != 1) {
  3910. // top_n = body.at("top_n");
  3911. //} else {
  3912. // res_error(res, format_error_response("\"top_n\" must be provided", ERROR_TYPE_INVALID_REQUEST));
  3913. // return;
  3914. //}
  3915. // if true, use TEI API format, otherwise use Jina API format
  3916. // Jina: https://jina.ai/reranker/
  3917. // TEI: https://huggingface.github.io/text-embeddings-inference/#/Text%20Embeddings%20Inference/rerank
  3918. bool is_tei_format = body.contains("texts");
  3919. json query;
  3920. if (body.count("query") == 1) {
  3921. query = body.at("query");
  3922. if (!query.is_string()) {
  3923. res_error(res, format_error_response("\"query\" must be a string", ERROR_TYPE_INVALID_REQUEST));
  3924. return;
  3925. }
  3926. } else {
  3927. res_error(res, format_error_response("\"query\" must be provided", ERROR_TYPE_INVALID_REQUEST));
  3928. return;
  3929. }
  3930. std::vector<std::string> documents = json_value(body, "documents",
  3931. json_value(body, "texts", std::vector<std::string>()));
  3932. if (documents.empty()) {
  3933. res_error(res, format_error_response("\"documents\" must be a non-empty string array", ERROR_TYPE_INVALID_REQUEST));
  3934. return;
  3935. }
  3936. llama_tokens tokenized_query = tokenize_input_prompts(ctx_server.vocab, query, /* add_special */ false, true)[0];
  3937. // create and queue the task
  3938. json responses = json::array();
  3939. bool error = false;
  3940. std::unordered_set<int> task_ids;
  3941. {
  3942. std::vector<server_task> tasks;
  3943. auto tokenized_docs = tokenize_input_prompts(ctx_server.vocab, documents, /* add_special */ false, true);
  3944. tasks.reserve(tokenized_docs.size());
  3945. for (size_t i = 0; i < tokenized_docs.size(); i++) {
  3946. auto tmp = format_rerank(ctx_server.vocab, tokenized_query, tokenized_docs[i]);
  3947. server_task task = server_task(SERVER_TASK_TYPE_RERANK);
  3948. task.id = ctx_server.queue_tasks.get_new_id();
  3949. task.index = i;
  3950. task.prompt_tokens = server_tokens(tmp, ctx_server.mctx != nullptr);
  3951. tasks.push_back(std::move(task));
  3952. }
  3953. task_ids = server_task::get_list_id(tasks);
  3954. ctx_server.queue_results.add_waiting_tasks(tasks);
  3955. ctx_server.queue_tasks.post(std::move(tasks));
  3956. }
  3957. ctx_server.receive_multi_results(task_ids, [&](std::vector<server_task_result_ptr> & results) {
  3958. for (auto & res : results) {
  3959. GGML_ASSERT(dynamic_cast<server_task_result_rerank*>(res.get()) != nullptr);
  3960. responses.push_back(res->to_json());
  3961. }
  3962. }, [&](const json & error_data) {
  3963. res_error(res, error_data);
  3964. error = true;
  3965. }, req.is_connection_closed);
  3966. if (error) {
  3967. return;
  3968. }
  3969. // write JSON response
  3970. json root = format_response_rerank(
  3971. body,
  3972. responses,
  3973. is_tei_format,
  3974. documents);
  3975. res_ok(res, root);
  3976. };
  3977. const auto handle_lora_adapters_list = [&](const httplib::Request &, httplib::Response & res) {
  3978. json result = json::array();
  3979. const auto & loras = ctx_server.params_base.lora_adapters;
  3980. for (size_t i = 0; i < loras.size(); ++i) {
  3981. auto & lora = loras[i];
  3982. result.push_back({
  3983. {"id", i},
  3984. {"path", lora.path},
  3985. {"scale", lora.scale},
  3986. });
  3987. }
  3988. res_ok(res, result);
  3989. res.status = 200; // HTTP OK
  3990. };
  3991. const auto handle_lora_adapters_apply = [&](const httplib::Request & req, httplib::Response & res) {
  3992. const json body = json::parse(req.body);
  3993. if (!body.is_array()) {
  3994. res_error(res, format_error_response("Request body must be an array", ERROR_TYPE_INVALID_REQUEST));
  3995. return;
  3996. }
  3997. int task_id = ctx_server.queue_tasks.get_new_id();
  3998. {
  3999. server_task task(SERVER_TASK_TYPE_SET_LORA);
  4000. task.id = task_id;
  4001. task.set_lora = parse_lora_request(ctx_server.params_base.lora_adapters, body);
  4002. ctx_server.queue_results.add_waiting_task_id(task_id);
  4003. ctx_server.queue_tasks.post(std::move(task));
  4004. }
  4005. // get the result
  4006. server_task_result_ptr result = ctx_server.queue_results.recv(task_id);
  4007. ctx_server.queue_results.remove_waiting_task_id(task_id);
  4008. if (result->is_error()) {
  4009. res_error(res, result->to_json());
  4010. return;
  4011. }
  4012. GGML_ASSERT(dynamic_cast<server_task_result_apply_lora*>(result.get()) != nullptr);
  4013. res_ok(res, result->to_json());
  4014. };
  4015. //
  4016. // Router
  4017. //
  4018. if (!params.webui) {
  4019. LOG_INF("Web UI is disabled\n");
  4020. } else {
  4021. // register static assets routes
  4022. if (!params.public_path.empty()) {
  4023. // Set the base directory for serving static files
  4024. bool is_found = svr->set_mount_point("/", params.public_path);
  4025. if (!is_found) {
  4026. LOG_ERR("%s: static assets path not found: %s\n", __func__, params.public_path.c_str());
  4027. return 1;
  4028. }
  4029. } else {
  4030. // using embedded static index.html
  4031. svr->Get("/", [](const httplib::Request & req, httplib::Response & res) {
  4032. if (req.get_header_value("Accept-Encoding").find("gzip") == std::string::npos) {
  4033. res.set_content("Error: gzip is not supported by this browser", "text/plain");
  4034. } else {
  4035. res.set_header("Content-Encoding", "gzip");
  4036. // COEP and COOP headers, required by pyodide (python interpreter)
  4037. res.set_header("Cross-Origin-Embedder-Policy", "require-corp");
  4038. res.set_header("Cross-Origin-Opener-Policy", "same-origin");
  4039. res.set_content(reinterpret_cast<const char*>(index_html_gz), index_html_gz_len, "text/html; charset=utf-8");
  4040. }
  4041. return false;
  4042. });
  4043. }
  4044. }
  4045. // register API routes
  4046. svr->Get ("/health", handle_health); // public endpoint (no API key check)
  4047. svr->Get ("/metrics", handle_metrics);
  4048. svr->Get ("/props", handle_props);
  4049. svr->Post("/props", handle_props_change);
  4050. svr->Post("/api/show", handle_api_show);
  4051. svr->Get ("/models", handle_models); // public endpoint (no API key check)
  4052. svr->Get ("/v1/models", handle_models); // public endpoint (no API key check)
  4053. svr->Get ("/api/tags", handle_models); // ollama specific endpoint. public endpoint (no API key check)
  4054. svr->Post("/completion", handle_completions); // legacy
  4055. svr->Post("/completions", handle_completions);
  4056. svr->Post("/v1/completions", handle_completions_oai);
  4057. svr->Post("/chat/completions", handle_chat_completions);
  4058. svr->Post("/v1/chat/completions", handle_chat_completions);
  4059. svr->Post("/api/chat", handle_chat_completions); // ollama specific endpoint
  4060. svr->Post("/infill", handle_infill);
  4061. svr->Post("/embedding", handle_embeddings); // legacy
  4062. svr->Post("/embeddings", handle_embeddings);
  4063. svr->Post("/v1/embeddings", handle_embeddings_oai);
  4064. svr->Post("/rerank", handle_rerank);
  4065. svr->Post("/reranking", handle_rerank);
  4066. svr->Post("/v1/rerank", handle_rerank);
  4067. svr->Post("/v1/reranking", handle_rerank);
  4068. svr->Post("/tokenize", handle_tokenize);
  4069. svr->Post("/detokenize", handle_detokenize);
  4070. svr->Post("/apply-template", handle_apply_template);
  4071. // LoRA adapters hotswap
  4072. svr->Get ("/lora-adapters", handle_lora_adapters_list);
  4073. svr->Post("/lora-adapters", handle_lora_adapters_apply);
  4074. // Save & load slots
  4075. svr->Get ("/slots", handle_slots);
  4076. svr->Post("/slots/:id_slot", handle_slots_action);
  4077. //
  4078. // Start the server
  4079. //
  4080. if (params.n_threads_http < 1) {
  4081. // +2 threads for monitoring endpoints
  4082. params.n_threads_http = std::max(params.n_parallel + 2, (int32_t) std::thread::hardware_concurrency() - 1);
  4083. }
  4084. log_data["n_threads_http"] = std::to_string(params.n_threads_http);
  4085. svr->new_task_queue = [&params] { return new httplib::ThreadPool(params.n_threads_http); };
  4086. // clean up function, to be called before exit
  4087. auto clean_up = [&svr, &ctx_server]() {
  4088. SRV_INF("%s: cleaning up before exit...\n", __func__);
  4089. svr->stop();
  4090. ctx_server.queue_results.terminate();
  4091. llama_backend_free();
  4092. };
  4093. bool was_bound = false;
  4094. bool is_sock = false;
  4095. if (string_ends_with(std::string(params.hostname), ".sock")) {
  4096. is_sock = true;
  4097. LOG_INF("%s: setting address family to AF_UNIX\n", __func__);
  4098. svr->set_address_family(AF_UNIX);
  4099. // bind_to_port requires a second arg, any value other than 0 should
  4100. // simply get ignored
  4101. was_bound = svr->bind_to_port(params.hostname, 8080);
  4102. } else {
  4103. LOG_INF("%s: binding port with default address family\n", __func__);
  4104. // bind HTTP listen port
  4105. if (params.port == 0) {
  4106. int bound_port = svr->bind_to_any_port(params.hostname);
  4107. if ((was_bound = (bound_port >= 0))) {
  4108. params.port = bound_port;
  4109. }
  4110. } else {
  4111. was_bound = svr->bind_to_port(params.hostname, params.port);
  4112. }
  4113. }
  4114. if (!was_bound) {
  4115. LOG_ERR("%s: couldn't bind HTTP server socket, hostname: %s, port: %d\n", __func__, params.hostname.c_str(), params.port);
  4116. clean_up();
  4117. return 1;
  4118. }
  4119. // run the HTTP server in a thread
  4120. std::thread t([&]() { svr->listen_after_bind(); });
  4121. svr->wait_until_ready();
  4122. 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);
  4123. // load the model
  4124. LOG_INF("%s: loading model\n", __func__);
  4125. if (!ctx_server.load_model(params)) {
  4126. clean_up();
  4127. t.join();
  4128. LOG_ERR("%s: exiting due to model loading error\n", __func__);
  4129. return 1;
  4130. }
  4131. ctx_server.init();
  4132. state.store(SERVER_STATE_READY);
  4133. LOG_INF("%s: model loaded\n", __func__);
  4134. // print sample chat example to make it clear which template is used
  4135. LOG_INF("%s: chat template, chat_template: %s, example_format: '%s'\n", __func__,
  4136. common_chat_templates_source(ctx_server.chat_templates.get()),
  4137. common_chat_format_example(ctx_server.chat_templates.get(), ctx_server.params_base.use_jinja).c_str());
  4138. ctx_server.queue_tasks.on_new_task([&ctx_server](server_task && task) {
  4139. ctx_server.process_single_task(std::move(task));
  4140. });
  4141. ctx_server.queue_tasks.on_update_slots([&ctx_server]() {
  4142. ctx_server.update_slots();
  4143. });
  4144. shutdown_handler = [&](int) {
  4145. // this will unblock start_loop()
  4146. ctx_server.queue_tasks.terminate();
  4147. };
  4148. #if defined (__unix__) || (defined (__APPLE__) && defined (__MACH__))
  4149. struct sigaction sigint_action;
  4150. sigint_action.sa_handler = signal_handler;
  4151. sigemptyset (&sigint_action.sa_mask);
  4152. sigint_action.sa_flags = 0;
  4153. sigaction(SIGINT, &sigint_action, NULL);
  4154. sigaction(SIGTERM, &sigint_action, NULL);
  4155. #elif defined (_WIN32)
  4156. auto console_ctrl_handler = +[](DWORD ctrl_type) -> BOOL {
  4157. return (ctrl_type == CTRL_C_EVENT) ? (signal_handler(SIGINT), true) : false;
  4158. };
  4159. SetConsoleCtrlHandler(reinterpret_cast<PHANDLER_ROUTINE>(console_ctrl_handler), true);
  4160. #endif
  4161. LOG_INF("%s: server is listening on %s - starting the main loop\n", __func__,
  4162. is_sock ? string_format("unix://%s", params.hostname.c_str()).c_str() :
  4163. string_format("http://%s:%d", params.hostname.c_str(), params.port).c_str());
  4164. // this call blocks the main thread until queue_tasks.terminate() is called
  4165. ctx_server.queue_tasks.start_loop();
  4166. clean_up();
  4167. t.join();
  4168. return 0;
  4169. }