server.cpp 190 KB

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