server.cpp 178 KB

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