1
0

server.cpp 177 KB

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