server.cpp 182 KB

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