server.cpp 154 KB

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