server.cpp 165 KB

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