server.cpp 197 KB

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