server.cpp 136 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393
  1. #include "utils.hpp"
  2. #include "arg.h"
  3. #include "common.h"
  4. #include "log.h"
  5. #include "sampling.h"
  6. #include "json-schema-to-grammar.h"
  7. #include "llama.h"
  8. // Change JSON_ASSERT from assert() to GGML_ASSERT:
  9. #define JSON_ASSERT GGML_ASSERT
  10. #include "json.hpp"
  11. // mime type for sending response
  12. #define MIMETYPE_JSON "application/json; charset=utf-8"
  13. // auto generated files (update with ./deps.sh)
  14. #include "colorthemes.css.hpp"
  15. #include "style.css.hpp"
  16. #include "theme-beeninorder.css.hpp"
  17. #include "theme-ketivah.css.hpp"
  18. #include "theme-mangotango.css.hpp"
  19. #include "theme-playground.css.hpp"
  20. #include "theme-polarnight.css.hpp"
  21. #include "theme-snowstorm.css.hpp"
  22. #include "index.html.hpp"
  23. #include "index-new.html.hpp"
  24. #include "index.js.hpp"
  25. #include "completion.js.hpp"
  26. #include "system-prompts.js.hpp"
  27. #include "prompt-formats.js.hpp"
  28. #include "json-schema-to-grammar.mjs.hpp"
  29. #include "loading.html.hpp"
  30. #include <atomic>
  31. #include <condition_variable>
  32. #include <cstddef>
  33. #include <cinttypes>
  34. #include <deque>
  35. #include <memory>
  36. #include <mutex>
  37. #include <signal.h>
  38. #include <thread>
  39. #include <unordered_map>
  40. #include <unordered_set>
  41. #define SLT_INF(slot, fmt, ...) LOG_INF("slot %12.*s: id %2d | task %d | " fmt, 12, __func__, (slot).id, (slot).id_task, __VA_ARGS__)
  42. #define SLT_WRN(slot, fmt, ...) LOG_WRN("slot %12.*s: id %2d | task %d | " fmt, 12, __func__, (slot).id, (slot).id_task, __VA_ARGS__)
  43. #define SLT_ERR(slot, fmt, ...) LOG_ERR("slot %12.*s: id %2d | task %d | " fmt, 12, __func__, (slot).id, (slot).id_task, __VA_ARGS__)
  44. #define SLT_DBG(slot, fmt, ...) LOG_DBG("slot %12.*s: id %2d | task %d | " fmt, 12, __func__, (slot).id, (slot).id_task, __VA_ARGS__)
  45. #define SRV_INF(fmt, ...) LOG_INF("srv %12.*s: " fmt, 12, __func__, __VA_ARGS__)
  46. #define SRV_WRN(fmt, ...) LOG_WRN("srv %12.*s: " fmt, 12, __func__, __VA_ARGS__)
  47. #define SRV_ERR(fmt, ...) LOG_ERR("srv %12.*s: " fmt, 12, __func__, __VA_ARGS__)
  48. #define SRV_DBG(fmt, ...) LOG_DBG("srv %12.*s: " fmt, 12, __func__, __VA_ARGS__)
  49. #define QUE_INF(fmt, ...) LOG_INF("que %12.*s: " fmt, 12, __func__, __VA_ARGS__)
  50. #define QUE_WRN(fmt, ...) LOG_WRN("que %12.*s: " fmt, 12, __func__, __VA_ARGS__)
  51. #define QUE_ERR(fmt, ...) LOG_ERR("que %12.*s: " fmt, 12, __func__, __VA_ARGS__)
  52. #define QUE_DBG(fmt, ...) LOG_DBG("que %12.*s: " fmt, 12, __func__, __VA_ARGS__)
  53. using json = nlohmann::ordered_json;
  54. enum stop_type {
  55. STOP_TYPE_FULL,
  56. STOP_TYPE_PARTIAL,
  57. };
  58. // state diagram: https://github.com/ggerganov/llama.cpp/pull/9283
  59. enum slot_state {
  60. SLOT_STATE_IDLE,
  61. SLOT_STATE_PROCESSING_PROMPT,
  62. SLOT_STATE_DONE_PROMPT,
  63. SLOT_STATE_GENERATING,
  64. };
  65. enum server_state {
  66. SERVER_STATE_LOADING_MODEL, // Server is starting up, model not fully loaded yet
  67. SERVER_STATE_READY, // Server is ready and model is loaded
  68. };
  69. enum server_task_type {
  70. SERVER_TASK_TYPE_COMPLETION,
  71. SERVER_TASK_TYPE_CANCEL,
  72. SERVER_TASK_TYPE_NEXT_RESPONSE,
  73. SERVER_TASK_TYPE_METRICS,
  74. SERVER_TASK_TYPE_SLOT_SAVE,
  75. SERVER_TASK_TYPE_SLOT_RESTORE,
  76. SERVER_TASK_TYPE_SLOT_ERASE,
  77. SERVER_TASK_TYPE_SET_LORA,
  78. };
  79. enum server_task_cmpl_type {
  80. SERVER_TASK_CMPL_TYPE_NORMAL,
  81. SERVER_TASK_CMPL_TYPE_EMBEDDING,
  82. SERVER_TASK_CMPL_TYPE_RERANK,
  83. SERVER_TASK_CMPL_TYPE_INFILL,
  84. };
  85. struct server_task {
  86. int id = -1; // to be filled by server_queue
  87. int id_target = -1; // used by SERVER_TASK_TYPE_CANCEL
  88. server_task_type type;
  89. json data;
  90. server_task_cmpl_type cmpl_type = SERVER_TASK_CMPL_TYPE_NORMAL;
  91. // utility function
  92. static std::unordered_set<int> get_list_id(const std::vector<server_task> & tasks) {
  93. std::unordered_set<int> ids(tasks.size());
  94. for (size_t i = 0; i < tasks.size(); i++) {
  95. ids.insert(tasks[i].id);
  96. }
  97. return ids;
  98. }
  99. };
  100. struct server_task_result {
  101. int id = -1;
  102. json data;
  103. bool stop;
  104. bool error;
  105. };
  106. struct slot_params {
  107. bool stream = true;
  108. bool cache_prompt = false; // remember the prompt to avoid reprocessing all prompt
  109. int32_t n_keep = 0; // number of tokens to keep from initial prompt
  110. int32_t n_discard = 0; // number of tokens after n_keep that may be discarded when shifting context, 0 defaults to half
  111. int32_t n_predict = -1; // new tokens to predict
  112. std::vector<std::string> antiprompt;
  113. json input_prefix;
  114. json input_suffix;
  115. };
  116. struct server_slot {
  117. int id;
  118. int id_task = -1;
  119. // the index relative to completion multi-task request
  120. size_t index = 0;
  121. struct slot_params params;
  122. slot_state state = SLOT_STATE_IDLE;
  123. // used to determine the slot that has been used the longest
  124. int64_t t_last_used = -1;
  125. // generation props
  126. int32_t n_ctx = 0; // context size per slot
  127. int32_t n_past = 0;
  128. int32_t n_decoded = 0;
  129. int32_t n_remaining = -1;
  130. int32_t i_batch = -1;
  131. int32_t n_predict = -1; // TODO: disambiguate from params.n_predict
  132. int32_t n_prompt_tokens = 0;
  133. int32_t n_prompt_tokens_processed = 0;
  134. json prompt; // can be either a string, array of strings or array of token ids
  135. // when a task is submitted, we first tokenize the prompt and store it here
  136. std::vector<llama_token> prompt_tokens;
  137. std::string generated_text;
  138. std::vector<llama_token> cache_tokens;
  139. std::vector<completion_token_output> generated_token_probs;
  140. server_task_cmpl_type cmpl_type = SERVER_TASK_CMPL_TYPE_NORMAL;
  141. bool has_next_token = true;
  142. bool truncated = false;
  143. bool stopped_eos = false;
  144. bool stopped_word = false;
  145. bool stopped_limit = false;
  146. bool oaicompat = false;
  147. std::string oaicompat_model;
  148. std::string stopping_word;
  149. // sampling
  150. json json_schema;
  151. struct common_sampler_params sparams;
  152. struct common_sampler * smpl = nullptr;
  153. llama_token sampled;
  154. int32_t ga_i = 0; // group-attention state
  155. int32_t ga_n = 1; // group-attention factor
  156. int32_t ga_w = 512; // group-attention width
  157. int32_t n_past_se = 0; // self-extend
  158. // stats
  159. size_t n_sent_text = 0; // number of sent text character
  160. size_t n_sent_token_probs = 0;
  161. int64_t t_start_process_prompt;
  162. int64_t t_start_generation;
  163. double t_prompt_processing; // ms
  164. double t_token_generation; // ms
  165. std::function<void(int)> callback_on_release;
  166. void reset() {
  167. SLT_DBG(*this, "%s", "\n");
  168. n_prompt_tokens = 0;
  169. generated_text = "";
  170. truncated = false;
  171. stopped_eos = false;
  172. stopped_word = false;
  173. stopped_limit = false;
  174. stopping_word = "";
  175. n_past = 0;
  176. n_sent_text = 0;
  177. n_sent_token_probs = 0;
  178. cmpl_type = SERVER_TASK_CMPL_TYPE_NORMAL;
  179. ga_i = 0;
  180. n_past_se = 0;
  181. generated_token_probs.clear();
  182. }
  183. bool has_budget(common_params &global_params) {
  184. if (params.n_predict == -1 && global_params.n_predict == -1) {
  185. return true; // limitless
  186. }
  187. n_remaining = -1;
  188. if (params.n_predict != -1) {
  189. n_remaining = params.n_predict - n_decoded;
  190. } else if (global_params.n_predict != -1) {
  191. n_remaining = global_params.n_predict - n_decoded;
  192. }
  193. return n_remaining > 0; // no budget
  194. }
  195. bool is_processing() const {
  196. return state != SLOT_STATE_IDLE;
  197. }
  198. void add_token(const completion_token_output & token) {
  199. if (!is_processing()) {
  200. SLT_WRN(*this, "%s", "slot is not processing\n");
  201. return;
  202. }
  203. generated_token_probs.push_back(token);
  204. }
  205. void release() {
  206. if (is_processing()) {
  207. SLT_INF(*this, "stop processing: n_past = %d, truncated = %d\n", n_past, truncated);
  208. t_token_generation = (ggml_time_us() - t_start_generation) / 1e3;
  209. state = SLOT_STATE_IDLE;
  210. callback_on_release(id);
  211. }
  212. }
  213. json get_formated_timings() const {
  214. return json {
  215. {"prompt_n", n_prompt_tokens_processed},
  216. {"prompt_ms", t_prompt_processing},
  217. {"prompt_per_token_ms", t_prompt_processing / n_prompt_tokens_processed},
  218. {"prompt_per_second", 1e3 / t_prompt_processing * n_prompt_tokens_processed},
  219. {"predicted_n", n_decoded},
  220. {"predicted_ms", t_token_generation},
  221. {"predicted_per_token_ms", t_token_generation / n_decoded},
  222. {"predicted_per_second", 1e3 / t_token_generation * n_decoded},
  223. };
  224. }
  225. size_t find_stopping_strings(const std::string & text, const size_t last_token_size, const stop_type type) {
  226. size_t stop_pos = std::string::npos;
  227. for (const std::string & word : params.antiprompt) {
  228. size_t pos;
  229. if (type == STOP_TYPE_FULL) {
  230. const size_t tmp = word.size() + last_token_size;
  231. const size_t from_pos = text.size() > tmp ? text.size() - tmp : 0;
  232. pos = text.find(word, from_pos);
  233. } else {
  234. pos = find_partial_stop_string(word, text);
  235. }
  236. if (pos != std::string::npos && (stop_pos == std::string::npos || pos < stop_pos)) {
  237. if (type == STOP_TYPE_FULL) {
  238. stopped_word = true;
  239. stopping_word = word;
  240. has_next_token = false;
  241. }
  242. stop_pos = pos;
  243. }
  244. }
  245. return stop_pos;
  246. }
  247. void print_timings() const {
  248. const double t_prompt = t_prompt_processing / n_prompt_tokens_processed;
  249. const double n_prompt_second = 1e3 / t_prompt_processing * n_prompt_tokens_processed;
  250. const double t_gen = t_token_generation / n_decoded;
  251. const double n_gen_second = 1e3 / t_token_generation * n_decoded;
  252. SLT_INF(*this,
  253. "\n"
  254. "\rprompt eval time = %10.2f ms / %5d tokens (%8.2f ms per token, %8.2f tokens per second)\n"
  255. "\r eval time = %10.2f ms / %5d tokens (%8.2f ms per token, %8.2f tokens per second)\n"
  256. "\r total time = %10.2f ms / %5d tokens\n",
  257. t_prompt_processing, n_prompt_tokens_processed, t_prompt, n_prompt_second,
  258. t_token_generation, n_decoded, t_gen, n_gen_second,
  259. t_prompt_processing + t_token_generation, n_prompt_tokens_processed + n_decoded);
  260. }
  261. };
  262. struct server_metrics {
  263. int64_t t_start = 0;
  264. uint64_t n_prompt_tokens_processed_total = 0;
  265. uint64_t t_prompt_processing_total = 0;
  266. uint64_t n_tokens_predicted_total = 0;
  267. uint64_t t_tokens_generation_total = 0;
  268. uint64_t n_prompt_tokens_processed = 0;
  269. uint64_t t_prompt_processing = 0;
  270. uint64_t n_tokens_predicted = 0;
  271. uint64_t t_tokens_generation = 0;
  272. uint64_t n_decode_total = 0;
  273. uint64_t n_busy_slots_total = 0;
  274. void init() {
  275. t_start = ggml_time_us();
  276. }
  277. void on_prompt_eval(const server_slot & slot) {
  278. n_prompt_tokens_processed_total += slot.n_prompt_tokens_processed;
  279. n_prompt_tokens_processed += slot.n_prompt_tokens_processed;
  280. t_prompt_processing += slot.t_prompt_processing;
  281. t_prompt_processing_total += slot.t_prompt_processing;
  282. }
  283. void on_prediction(const server_slot & slot) {
  284. n_tokens_predicted_total += slot.n_decoded;
  285. n_tokens_predicted += slot.n_decoded;
  286. t_tokens_generation += slot.t_token_generation;
  287. t_tokens_generation_total += slot.t_token_generation;
  288. }
  289. void on_decoded(const std::vector<server_slot> & slots) {
  290. n_decode_total++;
  291. for (const auto & slot : slots) {
  292. if (slot.is_processing()) {
  293. n_busy_slots_total++;
  294. }
  295. }
  296. }
  297. void reset_bucket() {
  298. n_prompt_tokens_processed = 0;
  299. t_prompt_processing = 0;
  300. n_tokens_predicted = 0;
  301. t_tokens_generation = 0;
  302. }
  303. };
  304. struct server_queue {
  305. int id = 0;
  306. bool running;
  307. // queues
  308. std::deque<server_task> queue_tasks;
  309. std::deque<server_task> queue_tasks_deferred;
  310. std::mutex mutex_tasks;
  311. std::condition_variable condition_tasks;
  312. // callback functions
  313. std::function<void(server_task&)> callback_new_task;
  314. std::function<void(void)> callback_update_slots;
  315. // Add a new task to the end of the queue
  316. int post(server_task task, bool front = false) {
  317. std::unique_lock<std::mutex> lock(mutex_tasks);
  318. if (task.id == -1) {
  319. task.id = id++;
  320. }
  321. QUE_DBG("new task, id = %d, front = %d\n", task.id, front);
  322. if (front) {
  323. queue_tasks.push_front(std::move(task));
  324. } else {
  325. queue_tasks.push_back(std::move(task));
  326. }
  327. condition_tasks.notify_one();
  328. return task.id;
  329. }
  330. // multi-task version of post()
  331. int post(std::vector<server_task> & tasks, bool front = false) {
  332. std::unique_lock<std::mutex> lock(mutex_tasks);
  333. for (auto & task : tasks) {
  334. if (task.id == -1) {
  335. task.id = id++;
  336. }
  337. QUE_DBG("new task, id = %d/%d, front = %d\n", task.id, (int) tasks.size(), front);
  338. if (front) {
  339. queue_tasks.push_front(std::move(task));
  340. } else {
  341. queue_tasks.push_back(std::move(task));
  342. }
  343. }
  344. condition_tasks.notify_one();
  345. return 0;
  346. }
  347. // Add a new task, but defer until one slot is available
  348. void defer(server_task task) {
  349. std::unique_lock<std::mutex> lock(mutex_tasks);
  350. QUE_DBG("defer task, id = %d\n", task.id);
  351. queue_tasks_deferred.push_back(std::move(task));
  352. condition_tasks.notify_one();
  353. }
  354. // Get the next id for creating a new task
  355. int get_new_id() {
  356. std::unique_lock<std::mutex> lock(mutex_tasks);
  357. int new_id = id++;
  358. return new_id;
  359. }
  360. // Register function to process a new task
  361. void on_new_task(std::function<void(server_task &)> callback) {
  362. callback_new_task = std::move(callback);
  363. }
  364. // Register the function to be called when all slots data is ready to be processed
  365. void on_update_slots(std::function<void(void)> callback) {
  366. callback_update_slots = std::move(callback);
  367. }
  368. // Call when the state of one slot is changed, it will move one task from deferred to main queue
  369. void pop_deferred_task() {
  370. std::unique_lock<std::mutex> lock(mutex_tasks);
  371. if (!queue_tasks_deferred.empty()) {
  372. queue_tasks.emplace_back(std::move(queue_tasks_deferred.front()));
  373. queue_tasks_deferred.pop_front();
  374. }
  375. condition_tasks.notify_one();
  376. }
  377. // end the start_loop routine
  378. void terminate() {
  379. std::unique_lock<std::mutex> lock(mutex_tasks);
  380. running = false;
  381. condition_tasks.notify_all();
  382. }
  383. /**
  384. * Main loop consists of these steps:
  385. * - Wait until a new task arrives
  386. * - Process the task (i.e. maybe copy data into slot)
  387. * - Check if multitask is finished
  388. * - Update all slots
  389. */
  390. void start_loop() {
  391. running = true;
  392. while (true) {
  393. QUE_DBG("%s", "processing new tasks\n");
  394. while (true) {
  395. std::unique_lock<std::mutex> lock(mutex_tasks);
  396. if (queue_tasks.empty()) {
  397. lock.unlock();
  398. break;
  399. }
  400. server_task task = queue_tasks.front();
  401. queue_tasks.pop_front();
  402. lock.unlock();
  403. QUE_DBG("processing task, id = %d\n", task.id);
  404. callback_new_task(task);
  405. }
  406. // all tasks in the current loop is processed, slots data is now ready
  407. QUE_DBG("%s", "update slots\n");
  408. callback_update_slots();
  409. QUE_DBG("%s", "waiting for new tasks\n");
  410. {
  411. std::unique_lock<std::mutex> lock(mutex_tasks);
  412. if (queue_tasks.empty()) {
  413. if (!running) {
  414. QUE_DBG("%s", "terminate\n");
  415. return;
  416. }
  417. condition_tasks.wait(lock, [&]{
  418. return (!queue_tasks.empty() || !running);
  419. });
  420. }
  421. }
  422. }
  423. }
  424. };
  425. struct server_response {
  426. // for keeping track of all tasks waiting for the result
  427. std::unordered_set<int> waiting_task_ids;
  428. // the main result queue
  429. std::vector<server_task_result> queue_results;
  430. std::mutex mutex_results;
  431. std::condition_variable condition_results;
  432. // add the id_task to the list of tasks waiting for response
  433. void add_waiting_task_id(int id_task) {
  434. SRV_DBG("add task %d to waiting list. current waiting = %d (before add)\n", id_task, (int) waiting_task_ids.size());
  435. std::unique_lock<std::mutex> lock(mutex_results);
  436. waiting_task_ids.insert(id_task);
  437. }
  438. void add_waiting_tasks(const std::vector<server_task> & tasks) {
  439. std::unique_lock<std::mutex> lock(mutex_results);
  440. for (const auto & task : tasks) {
  441. SRV_DBG("add task %d to waiting list. current waiting = %d (before add)\n", task.id, (int) waiting_task_ids.size());
  442. waiting_task_ids.insert(task.id);
  443. }
  444. }
  445. // when the request is finished, we can remove task associated with it
  446. void remove_waiting_task_id(int id_task) {
  447. SRV_DBG("remove task %d from waiting list. current waiting = %d (before remove)\n", id_task, (int) waiting_task_ids.size());
  448. std::unique_lock<std::mutex> lock(mutex_results);
  449. waiting_task_ids.erase(id_task);
  450. }
  451. void remove_waiting_task_ids(const std::unordered_set<int> & id_tasks) {
  452. std::unique_lock<std::mutex> lock(mutex_results);
  453. for (const auto & id_task : id_tasks) {
  454. SRV_DBG("remove task %d from waiting list. current waiting = %d (before remove)\n", id_task, (int) waiting_task_ids.size());
  455. waiting_task_ids.erase(id_task);
  456. }
  457. }
  458. // This function blocks the thread until there is a response for one of the id_tasks
  459. server_task_result recv(const std::unordered_set<int> & id_tasks) {
  460. while (true) {
  461. std::unique_lock<std::mutex> lock(mutex_results);
  462. condition_results.wait(lock, [&]{
  463. return !queue_results.empty();
  464. });
  465. for (int i = 0; i < (int) queue_results.size(); i++) {
  466. if (id_tasks.find(queue_results[i].id) != id_tasks.end()) {
  467. server_task_result res = queue_results[i];
  468. queue_results.erase(queue_results.begin() + i);
  469. return res;
  470. }
  471. }
  472. }
  473. // should never reach here
  474. }
  475. // single-task version of recv()
  476. server_task_result recv(int id_task) {
  477. std::unordered_set<int> id_tasks = {id_task};
  478. return recv(id_tasks);
  479. }
  480. // Send a new result to a waiting id_task
  481. void send(server_task_result & result) {
  482. SRV_DBG("sending result for task id = %d\n", result.id);
  483. std::unique_lock<std::mutex> lock(mutex_results);
  484. for (const auto & id_task : waiting_task_ids) {
  485. if (result.id == id_task) {
  486. SRV_DBG("task id = %d moved to result queue\n", result.id);
  487. queue_results.push_back(std::move(result));
  488. condition_results.notify_all();
  489. return;
  490. }
  491. }
  492. }
  493. };
  494. struct server_context {
  495. llama_model * model = nullptr;
  496. llama_context * ctx = nullptr;
  497. std::vector<common_lora_adapter_container> loras;
  498. common_params params;
  499. llama_batch batch = {};
  500. bool clean_kv_cache = true;
  501. bool add_bos_token = true;
  502. bool has_eos_token = false;
  503. int32_t n_ctx; // total context for all clients / slots
  504. // system prompt
  505. bool system_need_update = false;
  506. std::string system_prompt;
  507. std::vector<llama_token> system_tokens;
  508. // slots / clients
  509. std::vector<server_slot> slots;
  510. json default_generation_settings_for_props;
  511. server_queue queue_tasks;
  512. server_response queue_results;
  513. server_metrics metrics;
  514. // Necessary similarity of prompt for slot selection
  515. float slot_prompt_similarity = 0.0f;
  516. ~server_context() {
  517. if (ctx) {
  518. llama_free(ctx);
  519. ctx = nullptr;
  520. }
  521. if (model) {
  522. llama_free_model(model);
  523. model = nullptr;
  524. }
  525. // Clear any sampling context
  526. for (server_slot & slot : slots) {
  527. if (slot.smpl != nullptr) {
  528. common_sampler_free(slot.smpl);
  529. }
  530. }
  531. llama_batch_free(batch);
  532. }
  533. bool load_model(const common_params & params_) {
  534. params = params_;
  535. // dedicate one sequence to the system prompt
  536. params.n_parallel += 1;
  537. common_init_result llama_init = common_init_from_params(params);
  538. model = llama_init.model;
  539. ctx = llama_init.context;
  540. loras = llama_init.lora_adapters;
  541. params.n_parallel -= 1; // but be sneaky about it
  542. if (model == nullptr) {
  543. SRV_ERR("failed to load model, '%s'\n", params.model.c_str());
  544. return false;
  545. }
  546. n_ctx = llama_n_ctx(ctx);
  547. add_bos_token = llama_add_bos_token(model);
  548. has_eos_token = !llama_add_eos_token(model);
  549. return true;
  550. }
  551. bool validate_model_chat_template() const {
  552. llama_chat_message chat[] = {{"user", "test"}};
  553. const int res = llama_chat_apply_template(model, nullptr, chat, 1, true, nullptr, 0);
  554. return res > 0;
  555. }
  556. void init() {
  557. const int32_t n_ctx_slot = n_ctx / params.n_parallel;
  558. SRV_INF("initializing slots, n_slots = %d\n", params.n_parallel);
  559. for (int i = 0; i < params.n_parallel; i++) {
  560. server_slot slot;
  561. slot.id = i;
  562. slot.n_ctx = n_ctx_slot;
  563. slot.n_predict = params.n_predict;
  564. SLT_INF(slot, "new slot n_ctx_slot = %d\n", slot.n_ctx);
  565. const int ga_n = params.grp_attn_n;
  566. const int ga_w = params.grp_attn_w;
  567. if (ga_n != 1) {
  568. GGML_ASSERT(ga_n > 0 && "ga_n must be positive"); // NOLINT
  569. GGML_ASSERT(ga_w % ga_n == 0 && "ga_w must be a multiple of ga_n"); // NOLINT
  570. //GGML_ASSERT(n_ctx_train % ga_w == 0 && "n_ctx_train must be a multiple of ga_w"); // NOLINT
  571. //GGML_ASSERT(n_ctx >= n_ctx_train * ga_n && "n_ctx must be at least n_ctx_train * ga_n"); // NOLINT
  572. SLT_INF(slot, "slot self-extend: ga_n = %d, ga_w = %d\n", ga_n, ga_w);
  573. }
  574. slot.ga_i = 0;
  575. slot.ga_n = ga_n;
  576. slot.ga_w = ga_w;
  577. slot.sparams = params.sparams;
  578. slot.callback_on_release = [this](int) {
  579. queue_tasks.pop_deferred_task();
  580. };
  581. slot.reset();
  582. slots.push_back(slot);
  583. }
  584. default_generation_settings_for_props = get_formated_generation(slots.front());
  585. default_generation_settings_for_props["seed"] = -1;
  586. // the update_slots() logic will always submit a maximum of n_batch or n_parallel tokens
  587. // 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)
  588. {
  589. const int32_t n_batch = llama_n_batch(ctx);
  590. // only a single seq_id per token is needed
  591. batch = llama_batch_init(std::max(n_batch, params.n_parallel), 0, 1);
  592. }
  593. metrics.init();
  594. }
  595. std::vector<llama_token> tokenize(const json & json_prompt, bool add_special) const {
  596. // TODO: currently, we tokenize using special tokens by default
  597. // this is not always correct (see https://github.com/ggerganov/llama.cpp/pull/4160#issuecomment-1824826216)
  598. // but it's better compared to completely ignoring ChatML and other chat templates
  599. const bool TMP_FORCE_SPECIAL = true;
  600. // If `add_bos` is true, we only add BOS, when json_prompt is a string,
  601. // or the first element of the json_prompt array is a string.
  602. std::vector<llama_token> prompt_tokens;
  603. if (json_prompt.is_array()) {
  604. bool first = true;
  605. for (const auto & p : json_prompt) {
  606. if (p.is_string()) {
  607. auto s = p.template get<std::string>();
  608. std::vector<llama_token> p;
  609. if (first) {
  610. p = common_tokenize(ctx, s, add_special, TMP_FORCE_SPECIAL);
  611. first = false;
  612. } else {
  613. p = common_tokenize(ctx, s, false, TMP_FORCE_SPECIAL);
  614. }
  615. prompt_tokens.insert(prompt_tokens.end(), p.begin(), p.end());
  616. } else {
  617. if (first) {
  618. first = false;
  619. }
  620. prompt_tokens.push_back(p.template get<llama_token>());
  621. }
  622. }
  623. } else {
  624. auto s = json_prompt.template get<std::string>();
  625. prompt_tokens = common_tokenize(ctx, s, add_special, TMP_FORCE_SPECIAL);
  626. }
  627. return prompt_tokens;
  628. }
  629. server_slot * get_slot_by_id(int id) {
  630. for (server_slot & slot : slots) {
  631. if (slot.id == id) {
  632. return &slot;
  633. }
  634. }
  635. return nullptr;
  636. }
  637. server_slot * get_available_slot(const std::string & prompt) {
  638. server_slot * ret = nullptr;
  639. // find the slot that has at least n% prompt similarity
  640. if (ret == nullptr && slot_prompt_similarity != 0.0f && !prompt.empty()) {
  641. int max_lcp_len = 0;
  642. float similarity = 0;
  643. for (server_slot & slot : slots) {
  644. // skip the slot if it is not available
  645. if (slot.is_processing()) {
  646. continue;
  647. }
  648. // skip the slot if it does not contains prompt
  649. if (!slot.prompt.is_string()) {
  650. continue;
  651. }
  652. // current slot's prompt
  653. std::string slot_prompt = slot.prompt.get<std::string>();
  654. // length of the current slot's prompt
  655. int slot_prompt_len = slot_prompt.size();
  656. // length of the Longest Common Prefix between the current slot's prompt and the input prompt
  657. int lcp_len = common_part(slot_prompt, prompt);
  658. // fraction of the common substring length compared to the current slot's prompt length
  659. similarity = static_cast<float>(lcp_len) / slot_prompt_len;
  660. // select the current slot if the criteria match
  661. if (lcp_len > max_lcp_len && similarity > slot_prompt_similarity) {
  662. max_lcp_len = lcp_len;
  663. ret = &slot;
  664. }
  665. }
  666. if (ret != nullptr) {
  667. SLT_DBG(*ret, "selected slot by lcp similarity, max_lcp_len = %d, similarity = %f\n", max_lcp_len, similarity);
  668. }
  669. }
  670. // find the slot that has been least recently used
  671. if (ret == nullptr) {
  672. int64_t t_last = ggml_time_us();
  673. for (server_slot & slot : slots) {
  674. // skip the slot if it is not available
  675. if (slot.is_processing()) {
  676. continue;
  677. }
  678. // select the current slot if the criteria match
  679. if (slot.t_last_used < t_last) {
  680. t_last = slot.t_last_used;
  681. ret = &slot;
  682. }
  683. }
  684. if (ret != nullptr) {
  685. SLT_DBG(*ret, "selected slot by lru, t_last = %" PRId64 "\n", t_last);
  686. }
  687. }
  688. return ret;
  689. }
  690. bool launch_slot_with_task(server_slot & slot, const server_task & task) {
  691. slot_params default_params;
  692. // Sampling parameter defaults are loaded from the global server context (but individual requests can still override them)
  693. auto default_sparams = params.sparams;
  694. const auto & data = task.data;
  695. if (data.count("__oaicompat") != 0) {
  696. slot.oaicompat = true;
  697. slot.oaicompat_model = json_value(data, "model", std::string(DEFAULT_OAICOMPAT_MODEL));
  698. } else {
  699. slot.oaicompat = false;
  700. slot.oaicompat_model = "";
  701. }
  702. slot.params.stream = json_value(data, "stream", false);
  703. slot.params.cache_prompt = json_value(data, "cache_prompt", false);
  704. slot.params.n_predict = json_value(data, "n_predict", json_value(data, "max_tokens", default_params.n_predict));
  705. slot.sparams.top_k = json_value(data, "top_k", default_sparams.top_k);
  706. slot.sparams.top_p = json_value(data, "top_p", default_sparams.top_p);
  707. slot.sparams.min_p = json_value(data, "min_p", default_sparams.min_p);
  708. slot.sparams.tfs_z = json_value(data, "tfs_z", default_sparams.tfs_z);
  709. slot.sparams.typ_p = json_value(data, "typical_p", default_sparams.typ_p);
  710. slot.sparams.temp = json_value(data, "temperature", default_sparams.temp);
  711. slot.sparams.dynatemp_range = json_value(data, "dynatemp_range", default_sparams.dynatemp_range);
  712. slot.sparams.dynatemp_exponent = json_value(data, "dynatemp_exponent", default_sparams.dynatemp_exponent);
  713. slot.sparams.penalty_last_n = json_value(data, "repeat_last_n", default_sparams.penalty_last_n);
  714. slot.sparams.penalty_repeat = json_value(data, "repeat_penalty", default_sparams.penalty_repeat);
  715. slot.sparams.penalty_freq = json_value(data, "frequency_penalty", default_sparams.penalty_freq);
  716. slot.sparams.penalty_present = json_value(data, "presence_penalty", default_sparams.penalty_present);
  717. slot.sparams.mirostat = json_value(data, "mirostat", default_sparams.mirostat);
  718. slot.sparams.mirostat_tau = json_value(data, "mirostat_tau", default_sparams.mirostat_tau);
  719. slot.sparams.mirostat_eta = json_value(data, "mirostat_eta", default_sparams.mirostat_eta);
  720. slot.sparams.penalize_nl = json_value(data, "penalize_nl", default_sparams.penalize_nl);
  721. slot.params.n_keep = json_value(data, "n_keep", slot.params.n_keep);
  722. slot.params.n_discard = json_value(data, "n_discard", default_params.n_discard);
  723. slot.sparams.seed = json_value(data, "seed", default_sparams.seed);
  724. slot.sparams.n_probs = json_value(data, "n_probs", default_sparams.n_probs);
  725. slot.sparams.min_keep = json_value(data, "min_keep", default_sparams.min_keep);
  726. // process "json_schema" and "grammar"
  727. if (data.contains("json_schema") && !data.at("json_schema").is_null() && data.contains("grammar") && !data.at("grammar").is_null()) {
  728. send_error(task, "Either \"json_schema\" or \"grammar\" can be specified, but not both", ERROR_TYPE_INVALID_REQUEST);
  729. return false;
  730. }
  731. if (data.contains("json_schema") && !data.contains("grammar")) {
  732. try {
  733. auto schema = json_value(data, "json_schema", json::object());
  734. slot.sparams.grammar = json_schema_to_grammar(schema);
  735. } catch (const std::exception & e) {
  736. send_error(task, std::string("\"json_schema\": ") + e.what(), ERROR_TYPE_INVALID_REQUEST);
  737. return false;
  738. }
  739. } else {
  740. slot.sparams.grammar = json_value(data, "grammar", default_sparams.grammar);
  741. }
  742. if (slot.params.cache_prompt && slot.ga_n != 1) {
  743. slot.params.cache_prompt = false;
  744. SLT_WRN(slot, "%s", "group-attention is not supported with prompt caching. disabling cache\n");
  745. }
  746. if (slot.n_predict > 0 && slot.params.n_predict > slot.n_predict) {
  747. // Might be better to reject the request with a 400 ?
  748. slot.params.n_predict = slot.n_predict;
  749. SLT_WRN(slot, "n_predict = %d exceeds server configuration, setting to %d", slot.n_predict, slot.n_predict);
  750. }
  751. // infill
  752. slot.params.input_prefix = json_value(data, "input_prefix", default_params.input_prefix);
  753. slot.params.input_suffix = json_value(data, "input_suffix", default_params.input_suffix);
  754. // get prompt
  755. if (task.cmpl_type != SERVER_TASK_CMPL_TYPE_INFILL) {
  756. const auto & prompt = data.find("prompt");
  757. if (prompt == data.end()) {
  758. send_error(task, "\"prompt\" must be provided", ERROR_TYPE_INVALID_REQUEST);
  759. return false;
  760. }
  761. if ((prompt->is_string()) ||
  762. (prompt->is_array() && prompt->size() == 1 && prompt->at(0).is_string()) ||
  763. (prompt->is_array() && !prompt->empty() && prompt->at(0).is_number_integer())) {
  764. slot.prompt = *prompt;
  765. } else if (prompt->is_array() && prompt->size() == 1 && prompt->at(0).is_array()) {
  766. slot.prompt = prompt->at(0);
  767. } else if (prompt->is_array() && prompt->size() > 1) {
  768. // array of strings
  769. for (const auto & el : *prompt) {
  770. if (!el.is_string()) {
  771. send_error(task, "\"prompt\" must be a string, an array of strings or an array of integers", ERROR_TYPE_INVALID_REQUEST);
  772. return false;
  773. }
  774. }
  775. slot.prompt = *prompt;
  776. } else {
  777. send_error(task, "\"prompt\" must be a string, an array of strings or an array of integers", ERROR_TYPE_INVALID_REQUEST);
  778. return false;
  779. }
  780. }
  781. {
  782. slot.sparams.logit_bias.clear();
  783. if (json_value(data, "ignore_eos", false) && has_eos_token) {
  784. slot.sparams.logit_bias.push_back({llama_token_eos(model), -INFINITY});
  785. }
  786. const auto & logit_bias = data.find("logit_bias");
  787. if (logit_bias != data.end() && logit_bias->is_array()) {
  788. const int n_vocab = llama_n_vocab(model);
  789. for (const auto & el : *logit_bias) {
  790. // TODO: we may want to throw errors here, in case "el" is incorrect
  791. if (el.is_array() && el.size() == 2) {
  792. float bias;
  793. if (el[1].is_number()) {
  794. bias = el[1].get<float>();
  795. } else if (el[1].is_boolean() && !el[1].get<bool>()) {
  796. bias = -INFINITY;
  797. } else {
  798. continue;
  799. }
  800. if (el[0].is_number_integer()) {
  801. llama_token tok = el[0].get<llama_token>();
  802. if (tok >= 0 && tok < n_vocab) {
  803. slot.sparams.logit_bias.push_back({tok, bias});
  804. }
  805. } else if (el[0].is_string()) {
  806. auto toks = common_tokenize(model, el[0].get<std::string>(), false);
  807. for (auto tok : toks) {
  808. slot.sparams.logit_bias.push_back({tok, bias});
  809. }
  810. }
  811. }
  812. }
  813. }
  814. }
  815. {
  816. slot.params.antiprompt.clear();
  817. const auto & stop = data.find("stop");
  818. if (stop != data.end() && stop->is_array()) {
  819. for (const auto & word : *stop) {
  820. if (!word.empty()) {
  821. slot.params.antiprompt.push_back(word);
  822. }
  823. }
  824. }
  825. }
  826. {
  827. const auto & samplers = data.find("samplers");
  828. if (samplers != data.end() && samplers->is_array()) {
  829. std::vector<std::string> sampler_names;
  830. for (const auto & name : *samplers) {
  831. if (name.is_string()) {
  832. sampler_names.emplace_back(name);
  833. }
  834. }
  835. slot.sparams.samplers = common_sampler_types_from_names(sampler_names, false);
  836. } else {
  837. slot.sparams.samplers = default_sparams.samplers;
  838. }
  839. }
  840. {
  841. if (slot.smpl != nullptr) {
  842. common_sampler_free(slot.smpl);
  843. }
  844. slot.smpl = common_sampler_init(model, slot.sparams);
  845. if (slot.smpl == nullptr) {
  846. // for now, the only error that may happen here is invalid grammar
  847. send_error(task, "Failed to parse grammar", ERROR_TYPE_INVALID_REQUEST);
  848. return false;
  849. }
  850. }
  851. slot.state = SLOT_STATE_PROCESSING_PROMPT;
  852. slot.prompt_tokens.clear();
  853. SLT_INF(slot, "%s", "processing task\n");
  854. return true;
  855. }
  856. void kv_cache_clear() {
  857. SRV_DBG("%s", "clearing KV cache\n");
  858. // clear the entire KV cache
  859. llama_kv_cache_clear(ctx);
  860. clean_kv_cache = false;
  861. }
  862. void system_prompt_update() {
  863. SRV_DBG("updating system prompt: '%s'\n", system_prompt.c_str());
  864. kv_cache_clear();
  865. system_tokens.clear();
  866. if (!system_prompt.empty()) {
  867. system_tokens = common_tokenize(ctx, system_prompt, true);
  868. const int32_t n_batch = llama_n_batch(ctx);
  869. const int32_t n_tokens_prompt = system_tokens.size();
  870. for (int32_t i = 0; i < n_tokens_prompt; i += n_batch) {
  871. const int32_t n_tokens = std::min(n_batch, n_tokens_prompt - i);
  872. common_batch_clear(batch);
  873. for (int32_t j = 0; j < n_tokens; ++j) {
  874. common_batch_add(batch, system_tokens[i + j], i + j, { 0 }, false);
  875. }
  876. if (llama_decode(ctx, batch) != 0) {
  877. SRV_ERR("%s", "llama_decode() failed\n");
  878. return;
  879. }
  880. }
  881. // assign the system KV cache to all parallel sequences
  882. for (int32_t i = 1; i <= params.n_parallel; ++i) {
  883. llama_kv_cache_seq_cp(ctx, 0, i, -1, -1);
  884. }
  885. }
  886. system_need_update = false;
  887. }
  888. bool system_prompt_set(const std::string & sys_prompt) {
  889. SRV_DBG("system prompt set: '%s'\n", system_prompt.c_str());
  890. system_prompt = sys_prompt;
  891. // update system_tokens and KV cache as soon as all slots are idle
  892. system_need_update = true;
  893. return true;
  894. }
  895. bool process_token(completion_token_output & result, server_slot & slot) {
  896. // remember which tokens were sampled - used for repetition penalties during sampling
  897. const std::string token_str = common_token_to_piece(ctx, result.tok, params.special);
  898. slot.sampled = result.tok;
  899. // search stop word and delete it
  900. slot.generated_text += token_str;
  901. slot.has_next_token = true;
  902. // check if there is incomplete UTF-8 character at the end
  903. bool incomplete = false;
  904. for (unsigned i = 1; i < 5 && i <= slot.generated_text.size(); ++i) {
  905. unsigned char c = slot.generated_text[slot.generated_text.size() - i];
  906. if ((c & 0xC0) == 0x80) {
  907. // continuation byte: 10xxxxxx
  908. continue;
  909. }
  910. if ((c & 0xE0) == 0xC0) {
  911. // 2-byte character: 110xxxxx ...
  912. incomplete = i < 2;
  913. } else if ((c & 0xF0) == 0xE0) {
  914. // 3-byte character: 1110xxxx ...
  915. incomplete = i < 3;
  916. } else if ((c & 0xF8) == 0xF0) {
  917. // 4-byte character: 11110xxx ...
  918. incomplete = i < 4;
  919. }
  920. // else 1-byte character or invalid byte
  921. break;
  922. }
  923. if (!incomplete) {
  924. size_t pos = std::min(slot.n_sent_text, slot.generated_text.size());
  925. const std::string str_test = slot.generated_text.substr(pos);
  926. bool is_stop_full = false;
  927. size_t stop_pos = slot.find_stopping_strings(str_test, token_str.size(), STOP_TYPE_FULL);
  928. if (stop_pos != std::string::npos) {
  929. is_stop_full = true;
  930. slot.generated_text.erase(
  931. slot.generated_text.begin() + pos + stop_pos,
  932. slot.generated_text.end());
  933. pos = std::min(slot.n_sent_text, slot.generated_text.size());
  934. } else {
  935. is_stop_full = false;
  936. stop_pos = slot.find_stopping_strings(str_test, token_str.size(), STOP_TYPE_PARTIAL);
  937. }
  938. // check if there is any token to predict
  939. if (stop_pos == std::string::npos || (!slot.has_next_token && !is_stop_full && stop_pos > 0)) {
  940. // no send the stop word in the response
  941. result.text_to_send = slot.generated_text.substr(pos, std::string::npos);
  942. slot.n_sent_text += result.text_to_send.size();
  943. // add the token to slot queue and cache
  944. }
  945. slot.add_token(result);
  946. if (slot.params.stream) {
  947. send_partial_response(slot, result);
  948. }
  949. }
  950. if (incomplete) {
  951. slot.has_next_token = true;
  952. }
  953. // check the limits
  954. if (slot.n_decoded > 0 && slot.has_next_token && !slot.has_budget(params)) {
  955. slot.stopped_limit = true;
  956. slot.has_next_token = false;
  957. SLT_DBG(slot, "stopped by limit, n_decoded = %d, n_predict = %d\n", slot.n_decoded, slot.params.n_predict);
  958. }
  959. // if context shift is disabled, we stop when it reaches the context limit
  960. if (slot.n_decoded >= slot.n_ctx) {
  961. slot.truncated = true;
  962. slot.stopped_limit = true;
  963. slot.has_next_token = false;
  964. SLT_DBG(slot, "stopped due to running out of context capacity, n_decoded = %d, n_ctx = %d\n", slot.n_decoded, slot.n_ctx);
  965. }
  966. if (llama_token_is_eog(model, result.tok)) {
  967. slot.stopped_eos = true;
  968. slot.has_next_token = false;
  969. SLT_DBG(slot, "%s", "stopped by EOS\n");
  970. }
  971. const auto n_ctx_train = llama_n_ctx_train(model);
  972. if (slot.params.n_predict < 1 && slot.n_predict < 1 && slot.ga_n == 1 && slot.n_prompt_tokens + slot.n_decoded >= n_ctx_train) {
  973. slot.truncated = true;
  974. slot.stopped_limit = true;
  975. slot.has_next_token = false; // stop prediction
  976. SLT_WRN(slot,
  977. "n_predict (%d) is not set and self-context extend is disabled. "
  978. "Limiting generated tokens to n_ctx_train (%d) to avoid EOS-less generation infinite loop\n",
  979. slot.params.n_predict, n_ctx_train);
  980. }
  981. SLT_DBG(slot, "n_decoded = %d, n_remaining = %d, next token: '%s'\n", slot.n_decoded, slot.n_remaining, token_str.c_str());
  982. return slot.has_next_token; // continue
  983. }
  984. json get_formated_generation(const server_slot & slot) const {
  985. std::vector<std::string> samplers;
  986. samplers.reserve(slot.sparams.samplers.size());
  987. for (const auto & sampler : slot.sparams.samplers) {
  988. samplers.emplace_back(common_sampler_type_to_str(sampler));
  989. }
  990. return json {
  991. {"n_ctx", slot.n_ctx},
  992. {"n_predict", slot.n_predict}, // Server configured n_predict
  993. {"model", params.model_alias},
  994. {"seed", slot.sparams.seed},
  995. {"seed_cur", slot.smpl ? common_sampler_get_seed(slot.smpl) : 0},
  996. {"temperature", slot.sparams.temp},
  997. {"dynatemp_range", slot.sparams.dynatemp_range},
  998. {"dynatemp_exponent", slot.sparams.dynatemp_exponent},
  999. {"top_k", slot.sparams.top_k},
  1000. {"top_p", slot.sparams.top_p},
  1001. {"min_p", slot.sparams.min_p},
  1002. {"tfs_z", slot.sparams.tfs_z},
  1003. {"typical_p", slot.sparams.typ_p},
  1004. {"repeat_last_n", slot.sparams.penalty_last_n},
  1005. {"repeat_penalty", slot.sparams.penalty_repeat},
  1006. {"presence_penalty", slot.sparams.penalty_present},
  1007. {"frequency_penalty", slot.sparams.penalty_freq},
  1008. {"mirostat", slot.sparams.mirostat},
  1009. {"mirostat_tau", slot.sparams.mirostat_tau},
  1010. {"mirostat_eta", slot.sparams.mirostat_eta},
  1011. {"penalize_nl", slot.sparams.penalize_nl},
  1012. {"stop", slot.params.antiprompt},
  1013. {"max_tokens", slot.params.n_predict}, // User configured n_predict
  1014. {"n_keep", slot.params.n_keep},
  1015. {"n_discard", slot.params.n_discard},
  1016. {"ignore_eos", slot.sparams.ignore_eos},
  1017. {"stream", slot.params.stream},
  1018. //{"logit_bias", slot.sparams.logit_bias},
  1019. {"n_probs", slot.sparams.n_probs},
  1020. {"min_keep", slot.sparams.min_keep},
  1021. {"grammar", slot.sparams.grammar},
  1022. {"samplers", samplers},
  1023. };
  1024. }
  1025. void send_error(const server_task & task, const std::string & error, const enum error_type type = ERROR_TYPE_SERVER) {
  1026. send_error(task.id, error, type);
  1027. }
  1028. void send_error(const server_slot & slot, const std::string & error, const enum error_type type = ERROR_TYPE_SERVER) {
  1029. send_error(slot.id_task, error, type);
  1030. }
  1031. void send_error(const int id_task, const std::string & error, const enum error_type type = ERROR_TYPE_SERVER) {
  1032. SRV_ERR("task id = %d, error: %s\n", id_task, error.c_str());
  1033. server_task_result res;
  1034. res.id = id_task;
  1035. res.stop = false;
  1036. res.error = true;
  1037. res.data = format_error_response(error, type);
  1038. queue_results.send(res);
  1039. }
  1040. void send_partial_response(server_slot & slot, completion_token_output tkn) {
  1041. server_task_result res;
  1042. res.id = slot.id_task;
  1043. res.error = false;
  1044. res.stop = false;
  1045. res.data = json {
  1046. {"content", tkn.text_to_send},
  1047. {"stop", false},
  1048. {"id_slot", slot.id},
  1049. {"multimodal", false},
  1050. {"index", slot.index},
  1051. };
  1052. if (slot.sparams.n_probs > 0) {
  1053. const std::vector<llama_token> to_send_toks = common_tokenize(ctx, tkn.text_to_send, false);
  1054. const size_t probs_pos = std::min(slot.n_sent_token_probs, slot.generated_token_probs.size());
  1055. const size_t probs_stop_pos = std::min(slot.n_sent_token_probs + to_send_toks.size(), slot.generated_token_probs.size());
  1056. std::vector<completion_token_output> probs_output;
  1057. if (probs_pos < probs_stop_pos) {
  1058. probs_output = std::vector<completion_token_output>(
  1059. slot.generated_token_probs.begin() + probs_pos,
  1060. slot.generated_token_probs.begin() + probs_stop_pos);
  1061. }
  1062. slot.n_sent_token_probs = probs_stop_pos;
  1063. res.data["completion_probabilities"] = probs_vector_to_json(ctx, probs_output);
  1064. }
  1065. if (slot.oaicompat) {
  1066. res.data["oaicompat_token_ctr"] = slot.n_decoded;
  1067. res.data["model"] = slot.oaicompat_model;
  1068. }
  1069. queue_results.send(res);
  1070. }
  1071. void send_final_response(const server_slot & slot) {
  1072. server_task_result res;
  1073. res.id = slot.id_task;
  1074. res.error = false;
  1075. res.stop = true;
  1076. res.data = json {
  1077. {"content", !slot.params.stream ? slot.generated_text : ""},
  1078. {"id_slot", slot.id},
  1079. {"stop", true},
  1080. {"model", params.model_alias},
  1081. {"tokens_predicted", slot.n_decoded},
  1082. {"tokens_evaluated", slot.n_prompt_tokens},
  1083. {"generation_settings", get_formated_generation(slot)},
  1084. {"prompt", slot.prompt},
  1085. {"truncated", slot.truncated},
  1086. {"stopped_eos", slot.stopped_eos},
  1087. {"stopped_word", slot.stopped_word},
  1088. {"stopped_limit", slot.stopped_limit},
  1089. {"stopping_word", slot.stopping_word},
  1090. {"tokens_cached", slot.n_past},
  1091. {"timings", slot.get_formated_timings()},
  1092. {"index", slot.index},
  1093. };
  1094. if (slot.sparams.n_probs > 0) {
  1095. std::vector<completion_token_output> probs;
  1096. if (!slot.params.stream && slot.stopped_word) {
  1097. const std::vector<llama_token> stop_word_toks = common_tokenize(ctx, slot.stopping_word, false);
  1098. size_t safe_offset = std::min(slot.generated_token_probs.size(), stop_word_toks.size());
  1099. probs = std::vector<completion_token_output>(
  1100. slot.generated_token_probs.begin(),
  1101. slot.generated_token_probs.end() - safe_offset);
  1102. } else {
  1103. probs = std::vector<completion_token_output>(
  1104. slot.generated_token_probs.begin(),
  1105. slot.generated_token_probs.end());
  1106. }
  1107. res.data["completion_probabilities"] = probs_vector_to_json(ctx, probs);
  1108. }
  1109. if (slot.oaicompat) {
  1110. res.data["oaicompat_token_ctr"] = slot.n_decoded;
  1111. res.data["model"] = slot.oaicompat_model;
  1112. }
  1113. queue_results.send(res);
  1114. }
  1115. void send_embedding(const server_slot & slot, const llama_batch & batch) {
  1116. server_task_result res;
  1117. res.id = slot.id_task;
  1118. res.error = false;
  1119. res.stop = true;
  1120. const int n_embd = llama_n_embd(model);
  1121. std::vector<float> embd_res(n_embd, 0.0f);
  1122. for (int i = 0; i < batch.n_tokens; ++i) {
  1123. if (!batch.logits[i] || batch.seq_id[i][0] != slot.id + 1) {
  1124. continue;
  1125. }
  1126. const float * embd = llama_get_embeddings_seq(ctx, batch.seq_id[i][0]);
  1127. if (embd == NULL) {
  1128. embd = llama_get_embeddings_ith(ctx, i);
  1129. }
  1130. if (embd == NULL) {
  1131. SLT_ERR(slot, "failed to get embeddings, token = %d, seq_id = %d\n", batch.token[i], batch.seq_id[i][0]);
  1132. res.data = json {
  1133. {"embedding", std::vector<float>(n_embd, 0.0f)},
  1134. {"index", slot.index},
  1135. };
  1136. continue;
  1137. }
  1138. common_embd_normalize(embd, embd_res.data(), n_embd);
  1139. res.data = json {
  1140. {"embedding", embd_res},
  1141. {"index", slot.index},
  1142. };
  1143. }
  1144. SLT_DBG(slot, "%s", "sending embeddings\n");
  1145. queue_results.send(res);
  1146. }
  1147. void send_rerank(const server_slot & slot, const llama_batch & batch) {
  1148. server_task_result res;
  1149. res.id = slot.id_task;
  1150. res.error = false;
  1151. res.stop = true;
  1152. for (int i = 0; i < batch.n_tokens; ++i) {
  1153. if (!batch.logits[i] || batch.seq_id[i][0] != slot.id + 1) {
  1154. continue;
  1155. }
  1156. const float * embd = llama_get_embeddings_seq(ctx, batch.seq_id[i][0]);
  1157. if (embd == NULL) {
  1158. embd = llama_get_embeddings_ith(ctx, i);
  1159. }
  1160. if (embd == NULL) {
  1161. SLT_ERR(slot, "failed to get embeddings, token = %d, seq_id = %d\n", batch.token[i], batch.seq_id[i][0]);
  1162. res.data = json {
  1163. {"index", slot.index},
  1164. {"score", -1e6},
  1165. };
  1166. continue;
  1167. }
  1168. res.data = json {
  1169. {"index", slot.index},
  1170. {"score", embd[0]},
  1171. };
  1172. }
  1173. SLT_DBG(slot, "sending rerank result, res = '%s'\n", res.data.dump().c_str());
  1174. queue_results.send(res);
  1175. }
  1176. //
  1177. // Functions to create new task(s) and receive result(s)
  1178. //
  1179. std::vector<server_task> create_tasks_cmpl(json data, server_task_cmpl_type cmpl_type) {
  1180. std::vector<server_task> tasks;
  1181. auto create_task = [&](json & task_data, bool replace_prompt, json prompt) {
  1182. server_task task;
  1183. task.id = queue_tasks.get_new_id();
  1184. task.cmpl_type = cmpl_type;
  1185. task.type = SERVER_TASK_TYPE_COMPLETION;
  1186. if (replace_prompt) {
  1187. task.data = task_data;
  1188. task.data["prompt"] = std::move(prompt);
  1189. } else {
  1190. task.data = std::move(task_data);
  1191. }
  1192. tasks.push_back(std::move(task));
  1193. };
  1194. static constexpr const char * error_msg = "\"prompt\" must be a string, an array of token ids or an array of prompts";
  1195. if (!data.contains("prompt")) {
  1196. throw std::runtime_error(error_msg);
  1197. }
  1198. json prompt = data.at("prompt");
  1199. // if the prompt is a singleton (i.e. a string or a list of tokens), we only need to create single task
  1200. if (prompt.is_string() || json_is_array_of_numbers(prompt)) {
  1201. data["index"] = 0;
  1202. create_task(data, false, nullptr);
  1203. }
  1204. // otherwise, it's a multiple-prompt task, we break it into smaller tasks
  1205. else if (prompt.is_array()) {
  1206. std::vector<json> prompts = prompt;
  1207. if (cmpl_type == SERVER_TASK_CMPL_TYPE_RERANK) {
  1208. // prompts[0] is the question
  1209. // the rest are the answers/documents
  1210. SRV_DBG("creating rerank tasks, n_prompts = %d\n", (int) prompts.size() - 1);
  1211. for (size_t i = 1; i < prompts.size(); i++) {
  1212. json qd;
  1213. qd.push_back(prompts[0]);
  1214. qd.push_back(prompts[i]);
  1215. data["index"] = i - 1;
  1216. create_task(data, true, qd);
  1217. }
  1218. } else {
  1219. SRV_DBG("creating multi-prompt tasks, n_prompts = %d\n", (int) prompts.size());
  1220. for (size_t i = 0; i < prompts.size(); i++) {
  1221. const auto & e = prompts[i];
  1222. if (e.is_string() || json_is_array_of_numbers(e)) {
  1223. data["index"] = i;
  1224. create_task(data, true, e);
  1225. } else {
  1226. throw std::runtime_error(error_msg);
  1227. }
  1228. }
  1229. }
  1230. }
  1231. // invalid case
  1232. else {
  1233. throw std::runtime_error(error_msg);
  1234. }
  1235. return tasks;
  1236. }
  1237. void cancel_tasks(const std::unordered_set<int> & id_tasks) {
  1238. std::vector<server_task> cancel_tasks;
  1239. cancel_tasks.reserve(id_tasks.size());
  1240. for (const auto & id_task : id_tasks) {
  1241. SRV_WRN("cancel task, id_task = %d\n", id_task);
  1242. server_task task;
  1243. task.type = SERVER_TASK_TYPE_CANCEL;
  1244. task.id_target = id_task;
  1245. cancel_tasks.push_back(task);
  1246. queue_results.remove_waiting_task_id(id_task);
  1247. }
  1248. // push to beginning of the queue, so it has highest priority
  1249. queue_tasks.post(cancel_tasks, true);
  1250. }
  1251. // receive the results from task(s) created by create_tasks_cmpl
  1252. void receive_cmpl_results(
  1253. const std::unordered_set<int> & id_tasks,
  1254. const std::function<void(std::vector<server_task_result>&)> & result_handler,
  1255. const std::function<void(json)> & error_handler) {
  1256. // TODO: currently, there is no way to detect the client has cancelled the request
  1257. std::vector<server_task_result> results(id_tasks.size());
  1258. for (size_t i = 0; i < id_tasks.size(); i++) {
  1259. server_task_result result = queue_results.recv(id_tasks);
  1260. if (result.error) {
  1261. error_handler(result.data);
  1262. cancel_tasks(id_tasks);
  1263. return;
  1264. }
  1265. const size_t idx = result.data["index"];
  1266. GGML_ASSERT(idx < results.size() && "index out of range");
  1267. results[idx] = result;
  1268. }
  1269. result_handler(results);
  1270. }
  1271. // receive the results from task(s) created by create_tasks_cmpl, in stream mode
  1272. void receive_cmpl_results_stream(
  1273. const std::unordered_set<int> & id_tasks, const
  1274. std::function<bool(server_task_result&)> & result_handler, const
  1275. std::function<void(json)> & error_handler) {
  1276. size_t n_finished = 0;
  1277. while (true) {
  1278. server_task_result result = queue_results.recv(id_tasks);
  1279. if (!result_handler(result)) {
  1280. cancel_tasks(id_tasks);
  1281. break;
  1282. }
  1283. if (result.error) {
  1284. error_handler(result.data);
  1285. cancel_tasks(id_tasks);
  1286. break;
  1287. }
  1288. if (result.stop) {
  1289. if (++n_finished == id_tasks.size()) {
  1290. break;
  1291. }
  1292. }
  1293. }
  1294. }
  1295. //
  1296. // Functions to process the task
  1297. //
  1298. void process_single_task(const server_task & task) {
  1299. switch (task.type) {
  1300. case SERVER_TASK_TYPE_COMPLETION:
  1301. {
  1302. const int id_slot = json_value(task.data, "id_slot", -1);
  1303. server_slot * slot;
  1304. if (id_slot != -1) {
  1305. slot = get_slot_by_id(id_slot);
  1306. } else {
  1307. std::string prompt;
  1308. if (task.data.contains("prompt") && task.data.at("prompt").is_string()) {
  1309. prompt = json_value(task.data, "prompt", std::string());
  1310. }
  1311. slot = get_available_slot(prompt);
  1312. }
  1313. if (slot == nullptr) {
  1314. // if no slot is available, we defer this task for processing later
  1315. SRV_DBG("no slot is available, defer task, id_task = %d\n", task.id);
  1316. queue_tasks.defer(task);
  1317. break;
  1318. }
  1319. if (slot->is_processing()) {
  1320. // if requested slot is unavailable, we defer this task for processing later
  1321. SRV_DBG("requested slot is unavailable, defer task, id_task = %d\n", task.id);
  1322. queue_tasks.defer(task);
  1323. break;
  1324. }
  1325. slot->reset();
  1326. slot->id_task = task.id;
  1327. slot->cmpl_type = task.cmpl_type;
  1328. slot->index = json_value(task.data, "index", 0);
  1329. if (!launch_slot_with_task(*slot, task)) {
  1330. SRV_ERR("failed to launch slot with task, id_task = %d\n", task.id);
  1331. break;
  1332. }
  1333. } break;
  1334. case SERVER_TASK_TYPE_CANCEL:
  1335. {
  1336. // release slot linked with the task id
  1337. for (auto & slot : slots) {
  1338. if (slot.id_task == task.id_target) {
  1339. slot.release();
  1340. break;
  1341. }
  1342. }
  1343. } break;
  1344. case SERVER_TASK_TYPE_NEXT_RESPONSE:
  1345. {
  1346. // do nothing
  1347. } break;
  1348. case SERVER_TASK_TYPE_METRICS:
  1349. {
  1350. json slots_data = json::array();
  1351. int n_idle_slots = 0;
  1352. int n_processing_slots = 0;
  1353. for (server_slot & slot : slots) {
  1354. json slot_data = get_formated_generation(slot);
  1355. slot_data["id"] = slot.id;
  1356. slot_data["id_task"] = slot.id_task;
  1357. slot_data["state"] = slot.state;
  1358. slot_data["prompt"] = slot.prompt;
  1359. slot_data["next_token"] = {
  1360. {"has_next_token", slot.has_next_token},
  1361. {"n_remain", slot.n_remaining},
  1362. {"n_decoded", slot.n_decoded},
  1363. {"stopped_eos", slot.stopped_eos},
  1364. {"stopped_word", slot.stopped_word},
  1365. {"stopped_limit", slot.stopped_limit},
  1366. {"stopping_word", slot.stopping_word},
  1367. };
  1368. if (slot_data["state"] == SLOT_STATE_IDLE) {
  1369. n_idle_slots++;
  1370. } else {
  1371. n_processing_slots++;
  1372. }
  1373. slots_data.push_back(slot_data);
  1374. }
  1375. SRV_DBG("n_idle_slots = %d, n_processing_slots = %d\n", n_idle_slots, n_processing_slots);
  1376. server_task_result res;
  1377. res.id = task.id;
  1378. res.stop = true;
  1379. res.error = false;
  1380. res.data = {
  1381. { "idle", n_idle_slots },
  1382. { "processing", n_processing_slots },
  1383. { "deferred", queue_tasks.queue_tasks_deferred.size() },
  1384. { "t_start", metrics.t_start},
  1385. { "n_prompt_tokens_processed_total", metrics.n_prompt_tokens_processed_total},
  1386. { "t_tokens_generation_total", metrics.t_tokens_generation_total},
  1387. { "n_tokens_predicted_total", metrics.n_tokens_predicted_total},
  1388. { "t_prompt_processing_total", metrics.t_prompt_processing_total},
  1389. { "n_prompt_tokens_processed", metrics.n_prompt_tokens_processed},
  1390. { "t_prompt_processing", metrics.t_prompt_processing},
  1391. { "n_tokens_predicted", metrics.n_tokens_predicted},
  1392. { "t_tokens_generation", metrics.t_tokens_generation},
  1393. { "n_decode_total", metrics.n_decode_total},
  1394. { "n_busy_slots_total", metrics.n_busy_slots_total},
  1395. { "kv_cache_tokens_count", llama_get_kv_cache_token_count(ctx)},
  1396. { "kv_cache_used_cells", llama_get_kv_cache_used_cells(ctx)},
  1397. { "slots", slots_data },
  1398. };
  1399. if (json_value(task.data, "reset_bucket", false)) {
  1400. metrics.reset_bucket();
  1401. }
  1402. queue_results.send(res);
  1403. } break;
  1404. case SERVER_TASK_TYPE_SLOT_SAVE:
  1405. {
  1406. int id_slot = task.data.at("id_slot");
  1407. server_slot * slot = get_slot_by_id(id_slot);
  1408. if (slot == nullptr) {
  1409. send_error(task, "Invalid slot ID", ERROR_TYPE_INVALID_REQUEST);
  1410. break;
  1411. }
  1412. if (slot->is_processing()) {
  1413. // if requested slot is unavailable, we defer this task for processing later
  1414. SRV_DBG("requested slot is unavailable, defer task, id_task = %d\n", task.id);
  1415. queue_tasks.defer(task);
  1416. break;
  1417. }
  1418. const size_t token_count = slot->cache_tokens.size();
  1419. const int64_t t_start = ggml_time_us();
  1420. std::string filename = task.data.at("filename");
  1421. std::string filepath = task.data.at("filepath");
  1422. const size_t nwrite = llama_state_seq_save_file(ctx, filepath.c_str(), slot->id + 1, slot->cache_tokens.data(), token_count);
  1423. const int64_t t_end = ggml_time_us();
  1424. const double t_save_ms = (t_end - t_start) / 1000.0;
  1425. server_task_result result;
  1426. result.id = task.id;
  1427. result.stop = true;
  1428. result.error = false;
  1429. result.data = json {
  1430. { "id_slot", id_slot },
  1431. { "filename", filename },
  1432. { "n_saved", token_count }, // tokens saved
  1433. { "n_written", nwrite }, // bytes written
  1434. { "timings", {
  1435. { "save_ms", t_save_ms }
  1436. } }
  1437. };
  1438. queue_results.send(result);
  1439. } break;
  1440. case SERVER_TASK_TYPE_SLOT_RESTORE:
  1441. {
  1442. int id_slot = task.data.at("id_slot");
  1443. server_slot * slot = get_slot_by_id(id_slot);
  1444. if (slot == nullptr) {
  1445. send_error(task, "Invalid slot ID", ERROR_TYPE_INVALID_REQUEST);
  1446. break;
  1447. }
  1448. if (slot->is_processing()) {
  1449. // if requested slot is unavailable, we defer this task for processing later
  1450. SRV_DBG("requested slot is unavailable, defer task, id_task = %d\n", task.id);
  1451. queue_tasks.defer(task);
  1452. break;
  1453. }
  1454. const int64_t t_start = ggml_time_us();
  1455. std::string filename = task.data.at("filename");
  1456. std::string filepath = task.data.at("filepath");
  1457. slot->cache_tokens.resize(slot->n_ctx);
  1458. size_t token_count = 0;
  1459. size_t nread = llama_state_seq_load_file(ctx, filepath.c_str(), slot->id + 1, slot->cache_tokens.data(), slot->cache_tokens.size(), &token_count);
  1460. if (nread == 0) {
  1461. slot->cache_tokens.resize(0);
  1462. send_error(task, "Unable to restore slot, no available space in KV cache or invalid slot save file", ERROR_TYPE_INVALID_REQUEST);
  1463. break;
  1464. }
  1465. slot->cache_tokens.resize(token_count);
  1466. const int64_t t_end = ggml_time_us();
  1467. const double t_restore_ms = (t_end - t_start) / 1000.0;
  1468. server_task_result result;
  1469. result.id = task.id;
  1470. result.stop = true;
  1471. result.error = false;
  1472. result.data = json {
  1473. { "id_slot", id_slot },
  1474. { "filename", filename },
  1475. { "n_restored", token_count }, // tokens restored
  1476. { "n_read", nread }, // bytes read
  1477. { "timings", {
  1478. { "restore_ms", t_restore_ms }
  1479. } }
  1480. };
  1481. queue_results.send(result);
  1482. } break;
  1483. case SERVER_TASK_TYPE_SLOT_ERASE:
  1484. {
  1485. int id_slot = task.data.at("id_slot");
  1486. server_slot * slot = get_slot_by_id(id_slot);
  1487. if (slot == nullptr) {
  1488. send_error(task, "Invalid slot ID", ERROR_TYPE_INVALID_REQUEST);
  1489. break;
  1490. }
  1491. if (slot->is_processing()) {
  1492. // if requested slot is unavailable, we defer this task for processing later
  1493. SRV_DBG("requested slot is unavailable, defer task, id_task = %d\n", task.id);
  1494. queue_tasks.defer(task);
  1495. break;
  1496. }
  1497. // Erase token cache
  1498. const size_t n_erased = slot->cache_tokens.size();
  1499. llama_kv_cache_seq_rm(ctx, slot->id + 1, -1, -1);
  1500. slot->cache_tokens.clear();
  1501. server_task_result result;
  1502. result.id = task.id;
  1503. result.stop = true;
  1504. result.error = false;
  1505. result.data = json {
  1506. { "id_slot", id_slot },
  1507. { "n_erased", n_erased }
  1508. };
  1509. queue_results.send(result);
  1510. } break;
  1511. case SERVER_TASK_TYPE_SET_LORA:
  1512. {
  1513. common_lora_adapters_apply(ctx, loras);
  1514. server_task_result result;
  1515. result.id = task.id;
  1516. result.stop = true;
  1517. result.error = false;
  1518. result.data = json{{ "success", true }};
  1519. queue_results.send(result);
  1520. } break;
  1521. }
  1522. }
  1523. void update_slots() {
  1524. // check if all slots are idle
  1525. {
  1526. bool all_idle = true;
  1527. for (auto & slot : slots) {
  1528. if (slot.is_processing()) {
  1529. all_idle = false;
  1530. break;
  1531. }
  1532. }
  1533. if (all_idle) {
  1534. if (system_need_update) {
  1535. system_prompt_update();
  1536. }
  1537. SRV_INF("%s", "all slots are idle\n");
  1538. if (system_prompt.empty() && clean_kv_cache) {
  1539. kv_cache_clear();
  1540. }
  1541. return;
  1542. }
  1543. }
  1544. {
  1545. SRV_DBG("%s", "posting NEXT_RESPONSE\n");
  1546. server_task task;
  1547. task.type = SERVER_TASK_TYPE_NEXT_RESPONSE;
  1548. task.id_target = -1;
  1549. queue_tasks.post(task);
  1550. }
  1551. // apply context-shift if needed
  1552. // TODO: simplify and improve
  1553. for (server_slot & slot : slots) {
  1554. if (slot.ga_n == 1) {
  1555. if (slot.is_processing() && (int) system_tokens.size() + slot.n_past >= slot.n_ctx - 1) {
  1556. if (!params.ctx_shift) {
  1557. // this check is redundant (for good)
  1558. // we should never get here, because generation should already stopped in process_token()
  1559. slot.release();
  1560. send_error(slot, "context shift is disabled", ERROR_TYPE_SERVER);
  1561. continue;
  1562. }
  1563. // Shift context
  1564. const int n_keep = slot.params.n_keep + add_bos_token;
  1565. const int n_left = (int) system_tokens.size() + slot.n_past - n_keep;
  1566. const int n_discard = slot.params.n_discard ? slot.params.n_discard : (n_left / 2);
  1567. SLT_WRN(slot, "slot context shift, n_keep = %d, n_left = %d, n_discard = %d\n", n_keep, n_left, n_discard);
  1568. llama_kv_cache_seq_rm (ctx, slot.id + 1, n_keep , n_keep + n_discard);
  1569. llama_kv_cache_seq_add(ctx, slot.id + 1, n_keep + n_discard, system_tokens.size() + slot.n_past, -n_discard);
  1570. if (slot.params.cache_prompt) {
  1571. for (size_t i = n_keep + n_discard; i < slot.cache_tokens.size(); i++) {
  1572. slot.cache_tokens[i - n_discard] = slot.cache_tokens[i];
  1573. }
  1574. slot.cache_tokens.resize(slot.cache_tokens.size() - n_discard);
  1575. }
  1576. slot.n_past -= n_discard;
  1577. slot.truncated = true;
  1578. }
  1579. }
  1580. }
  1581. // start populating the batch for this iteration
  1582. common_batch_clear(batch);
  1583. // frist, add sampled tokens from any ongoing sequences
  1584. for (auto & slot : slots) {
  1585. if (slot.state != SLOT_STATE_GENERATING) {
  1586. continue;
  1587. }
  1588. slot.i_batch = batch.n_tokens;
  1589. const int32_t slot_npast = slot.n_past_se > 0 ? slot.n_past_se : slot.n_past;
  1590. // TODO: we always have to take into account the "system_tokens"
  1591. // this is not great and needs to be improved somehow
  1592. common_batch_add(batch, slot.sampled, system_tokens.size() + slot_npast, { slot.id + 1 }, true);
  1593. slot.n_past += 1;
  1594. if (slot.params.cache_prompt) {
  1595. slot.cache_tokens.push_back(slot.sampled);
  1596. }
  1597. SLT_DBG(slot, "slot decode token, n_ctx = %d, n_past = %d, n_system_tokens = %d, n_cache_tokens = %d, truncated = %d\n",
  1598. slot.n_ctx, slot.n_past, (int) system_tokens.size(), (int) slot.cache_tokens.size(), slot.truncated);
  1599. }
  1600. // process in chunks of params.n_batch
  1601. int32_t n_batch = llama_n_batch(ctx);
  1602. int32_t n_ubatch = llama_n_ubatch(ctx);
  1603. // track if this is an embedding or non-embedding batch
  1604. // if we've added sampled tokens above, we are in non-embedding mode
  1605. // -1: none, 0: non-embedding, 1: embedding
  1606. // TODO: make enum
  1607. int32_t batch_type = batch.n_tokens > 0 ? 0 : -1;
  1608. // next, batch any pending prompts without exceeding n_batch
  1609. if (params.cont_batching || batch.n_tokens == 0) {
  1610. for (auto & slot : slots) {
  1611. // this slot still has a prompt to be processed
  1612. if (slot.state == SLOT_STATE_PROCESSING_PROMPT) {
  1613. auto & prompt_tokens = slot.prompt_tokens;
  1614. // we haven't tokenized the prompt yet - do it now:
  1615. if (prompt_tokens.empty()) {
  1616. SLT_INF(slot, "tokenizing prompt, len = %d\n", (int) slot.prompt.size());
  1617. slot.t_start_process_prompt = ggml_time_us();
  1618. slot.t_start_generation = 0;
  1619. if (slot.cmpl_type == SERVER_TASK_CMPL_TYPE_INFILL) {
  1620. const bool add_bos = llama_add_bos_token(model);
  1621. bool suff_rm_leading_spc = true;
  1622. if (params.input_suffix.find_first_of(' ') == 0 && params.input_suffix.size() > 1) {
  1623. params.input_suffix.erase(0, 1);
  1624. suff_rm_leading_spc = false;
  1625. }
  1626. auto prefix_tokens = tokenize(slot.params.input_prefix, false);
  1627. auto suffix_tokens = tokenize(slot.params.input_suffix, false);
  1628. const int space_token = 29871; // TODO: this should not be hardcoded
  1629. if (suff_rm_leading_spc && !suffix_tokens.empty() && suffix_tokens[0] == space_token) {
  1630. suffix_tokens.erase(suffix_tokens.begin());
  1631. }
  1632. prefix_tokens.insert(prefix_tokens.begin(), llama_token_prefix(model));
  1633. suffix_tokens.insert(suffix_tokens.begin(), llama_token_suffix(model));
  1634. auto embd_inp = params.spm_infill ? suffix_tokens : prefix_tokens;
  1635. auto embd_end = params.spm_infill ? prefix_tokens : suffix_tokens;
  1636. if (add_bos) {
  1637. embd_inp.insert(embd_inp.begin(), llama_token_bos(model));
  1638. }
  1639. embd_inp.insert(embd_inp.end(), embd_end.begin(), embd_end.end());
  1640. const llama_token middle_token = llama_token_middle(model);
  1641. if (middle_token >= 0) {
  1642. embd_inp.push_back(middle_token);
  1643. }
  1644. prompt_tokens = embd_inp;
  1645. } else if (slot.cmpl_type == SERVER_TASK_CMPL_TYPE_RERANK) {
  1646. // require slot.prompt to be array of 2 strings
  1647. if (!slot.prompt.is_array() || slot.prompt.size() != 2) {
  1648. SLT_ERR(slot, "%s", "invalid prompt for rerank task\n");
  1649. slot.release();
  1650. send_error(slot, "invalid prompt for rerank task", ERROR_TYPE_INVALID_REQUEST);
  1651. continue;
  1652. }
  1653. // prompt: [BOS]query[EOS][SEP]doc[EOS]
  1654. prompt_tokens.clear();
  1655. prompt_tokens.push_back(llama_token_bos(model));
  1656. {
  1657. const auto part = tokenize(slot.prompt[0], false);
  1658. prompt_tokens.insert(prompt_tokens.end(), part.begin(), part.end());
  1659. }
  1660. prompt_tokens.push_back(llama_token_eos(model));
  1661. prompt_tokens.push_back(llama_token_sep(model));
  1662. {
  1663. const auto part = tokenize(slot.prompt[1], false);
  1664. prompt_tokens.insert(prompt_tokens.end(), part.begin(), part.end());
  1665. }
  1666. prompt_tokens.push_back(llama_token_eos(model));
  1667. } else {
  1668. prompt_tokens = tokenize(slot.prompt, system_prompt.empty()); // add BOS if there isn't system prompt
  1669. }
  1670. slot.n_past = 0;
  1671. slot.n_prompt_tokens = prompt_tokens.size();
  1672. SLT_INF(slot, "prompt tokenized, n_ctx_slot = %d, n_keep = %d, n_prompt_tokens = %d\n", slot.n_ctx, slot.params.n_keep, slot.n_prompt_tokens);
  1673. // empty prompt passed -> release the slot and send empty response
  1674. if (prompt_tokens.empty()) {
  1675. SLT_WRN(slot, "%s", "empty prompt - releasing slot\n");
  1676. slot.release();
  1677. slot.print_timings();
  1678. send_final_response(slot);
  1679. continue;
  1680. }
  1681. if (slot.cmpl_type == SERVER_TASK_CMPL_TYPE_EMBEDDING || slot.cmpl_type == SERVER_TASK_CMPL_TYPE_RERANK) {
  1682. // this prompt is too large to process - discard it
  1683. if (slot.n_prompt_tokens > n_ubatch) {
  1684. slot.release();
  1685. send_error(slot, "input is too large to process. increase the physical batch size", ERROR_TYPE_SERVER);
  1686. continue;
  1687. }
  1688. } else {
  1689. if (!params.ctx_shift) {
  1690. // if context shift is disabled, we make sure prompt size is smaller than KV size
  1691. if ((int) system_tokens.size() + slot.n_prompt_tokens >= slot.n_ctx) {
  1692. slot.release();
  1693. send_error(slot, "the request exceeds the available context size. try increasing the context size or enable context shift", ERROR_TYPE_INVALID_REQUEST);
  1694. continue;
  1695. }
  1696. }
  1697. if (slot.params.n_keep < 0) {
  1698. slot.params.n_keep = slot.n_prompt_tokens;
  1699. }
  1700. slot.params.n_keep = std::min(slot.n_ctx - 4, slot.params.n_keep);
  1701. // if input prompt is too big, truncate it (if group attention self-extend is disabled)
  1702. if (slot.ga_n == 1 && slot.n_prompt_tokens >= slot.n_ctx) {
  1703. const int n_left = slot.n_ctx - slot.params.n_keep;
  1704. const int n_block_size = n_left / 2;
  1705. const int erased_blocks = (slot.n_prompt_tokens - slot.params.n_keep - n_block_size) / n_block_size;
  1706. std::vector<llama_token> new_tokens(
  1707. prompt_tokens.begin(),
  1708. prompt_tokens.begin() + slot.params.n_keep);
  1709. new_tokens.insert(
  1710. new_tokens.end(),
  1711. prompt_tokens.begin() + slot.params.n_keep + erased_blocks * n_block_size,
  1712. prompt_tokens.end());
  1713. prompt_tokens = std::move(new_tokens);
  1714. slot.truncated = true;
  1715. slot.n_prompt_tokens = prompt_tokens.size();
  1716. 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);
  1717. GGML_ASSERT(slot.n_prompt_tokens < slot.n_ctx);
  1718. }
  1719. common_sampler_reset(slot.smpl);
  1720. if (!slot.params.cache_prompt) {
  1721. slot.n_past_se = 0;
  1722. slot.ga_i = 0;
  1723. } else {
  1724. GGML_ASSERT(slot.ga_n == 1);
  1725. // reuse any previously computed tokens that are common with the new prompt
  1726. slot.n_past = common_part(slot.cache_tokens, prompt_tokens);
  1727. // push the prompt into the sampling context (do not apply grammar)
  1728. for (int i = 0; i < slot.n_past; ++i) {
  1729. common_sampler_accept(slot.smpl, slot.cache_tokens[i], false);
  1730. }
  1731. }
  1732. }
  1733. if (slot.n_past == slot.n_prompt_tokens && slot.n_past > 0) {
  1734. // we have to evaluate at least 1 token to generate logits.
  1735. 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);
  1736. slot.n_past--;
  1737. if (slot.ga_i > 0) {
  1738. slot.n_past_se--;
  1739. }
  1740. }
  1741. slot.n_prompt_tokens_processed = 0;
  1742. }
  1743. // non-causal tasks require to fit the entire prompt in the physical batch
  1744. if (slot.cmpl_type == SERVER_TASK_CMPL_TYPE_EMBEDDING || slot.cmpl_type == SERVER_TASK_CMPL_TYPE_RERANK) {
  1745. // cannot fit the prompt in the current batch - will try next iter
  1746. if (batch.n_tokens + slot.n_prompt_tokens > n_batch) {
  1747. continue;
  1748. }
  1749. }
  1750. // check that we are in the right batch_type, if not defer the slot
  1751. const bool slot_type =
  1752. slot.cmpl_type == SERVER_TASK_CMPL_TYPE_EMBEDDING ||
  1753. slot.cmpl_type == SERVER_TASK_CMPL_TYPE_RERANK ? 1 : 0;
  1754. if (batch_type == -1) {
  1755. batch_type = slot_type;
  1756. } else if (batch_type != slot_type) {
  1757. continue;
  1758. }
  1759. // keep only the common part
  1760. int p0 = (int) system_tokens.size() + slot.n_past;
  1761. if (!llama_kv_cache_seq_rm(ctx, slot.id + 1, p0, -1)) {
  1762. // could not partially delete (likely using a non-Transformer model)
  1763. llama_kv_cache_seq_rm(ctx, slot.id + 1, -1, -1);
  1764. p0 = (int) system_tokens.size();
  1765. if (p0 != 0) {
  1766. // copy over the system prompt when there is one
  1767. llama_kv_cache_seq_cp(ctx, 0, slot.id + 1, -1, -1);
  1768. }
  1769. // there is no common part left (except for the system prompt)
  1770. slot.n_past = 0;
  1771. slot.n_past_se = 0;
  1772. slot.ga_i = 0;
  1773. // TODO: is the system prompt ever in the sampling context?
  1774. common_sampler_reset(slot.smpl);
  1775. }
  1776. // remove the non-common part from the cache
  1777. slot.cache_tokens.resize(slot.n_past);
  1778. SLT_INF(slot, "kv cache rm [%d, end)\n", p0);
  1779. int32_t slot_npast = slot.n_past_se > 0 ? slot.n_past_se : slot.n_past;
  1780. int32_t ga_i = slot.ga_i;
  1781. int32_t ga_n = slot.ga_n;
  1782. int32_t ga_w = slot.ga_w;
  1783. // add prompt tokens for processing in the current batch
  1784. // TODO: the self-extend stuff here is a mess - simplify and/or abstract it somehow
  1785. for (; slot.n_past < slot.n_prompt_tokens && batch.n_tokens < n_batch; ++slot.n_past) {
  1786. if (slot.ga_n != 1) {
  1787. while (slot_npast >= ga_i + ga_w) {
  1788. const int bd = (ga_w/ga_n)*(ga_n - 1);
  1789. slot_npast -= bd;
  1790. ga_i += ga_w/ga_n;
  1791. }
  1792. }
  1793. common_batch_add(batch, prompt_tokens[slot.n_past], system_tokens.size() + slot_npast, { slot.id + 1 }, false);
  1794. if (slot.params.cache_prompt) {
  1795. slot.cache_tokens.push_back(prompt_tokens[slot.n_past]);
  1796. }
  1797. slot.n_prompt_tokens_processed++;
  1798. slot_npast++;
  1799. }
  1800. 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);
  1801. // entire prompt has been processed
  1802. if (slot.n_past == slot.n_prompt_tokens) {
  1803. slot.state = SLOT_STATE_DONE_PROMPT;
  1804. GGML_ASSERT(batch.n_tokens > 0);
  1805. // extract the logits only for the last token
  1806. batch.logits[batch.n_tokens - 1] = true;
  1807. slot.n_decoded = 0;
  1808. slot.i_batch = batch.n_tokens - 1;
  1809. SLT_INF(slot, "prompt done, n_past = %d, n_tokens = %d\n", slot.n_past, batch.n_tokens);
  1810. }
  1811. }
  1812. if (batch.n_tokens >= n_batch) {
  1813. break;
  1814. }
  1815. }
  1816. }
  1817. if (batch.n_tokens == 0) {
  1818. SRV_WRN("%s", "no tokens to decode\n");
  1819. return;
  1820. }
  1821. SRV_DBG("decoding batch, n_tokens = %d\n", batch.n_tokens);
  1822. // make sure we're in the right embedding mode
  1823. llama_set_embeddings(ctx, batch_type == 1);
  1824. // process the created batch of tokens
  1825. for (int32_t i = 0; i < batch.n_tokens; i += n_batch) {
  1826. const int32_t n_tokens = std::min(n_batch, batch.n_tokens - i);
  1827. for (auto & slot : slots) {
  1828. if (slot.ga_n != 1) {
  1829. // context extension via Self-Extend
  1830. // TODO: simplify and/or abstract this
  1831. while (slot.n_past_se >= slot.ga_i + slot.ga_w) {
  1832. const int ib = (slot.ga_n * slot.ga_i) / slot.ga_w;
  1833. const int bd = (slot.ga_w / slot.ga_n) * (slot.ga_n - 1);
  1834. const int dd = (slot.ga_w / slot.ga_n) - ib * bd - slot.ga_w;
  1835. SLT_DBG(slot, "shift: [%6d, %6d] + %6d -> [%6d, %6d]\n", slot.ga_i, slot.n_past_se, ib * bd, slot.ga_i + ib * bd, slot.n_past_se + ib * bd);
  1836. SLT_DBG(slot, "div: [%6d, %6d] / %6d -> [%6d, %6d]\n", slot.ga_i + ib * bd, slot.ga_i + ib * bd + slot.ga_w, slot.ga_n, (slot.ga_i + ib * bd) / slot.ga_n, (slot.ga_i + ib * bd + slot.ga_w) / slot.ga_n);
  1837. SLT_DBG(slot, "shift: [%6d, %6d] + %6d -> [%6d, %6d]\n", slot.ga_i + ib * bd + slot.ga_w, slot.n_past_se + ib * bd, dd, slot.ga_i + ib * bd + slot.ga_w + dd, slot.n_past_se + ib * bd + dd);
  1838. llama_kv_cache_seq_add(ctx, slot.id + 1, slot.ga_i, slot.n_past_se, ib * bd);
  1839. llama_kv_cache_seq_div(ctx, slot.id + 1, slot.ga_i + ib * bd, slot.ga_i + ib * bd + slot.ga_w, slot.ga_n);
  1840. llama_kv_cache_seq_add(ctx, slot.id + 1, slot.ga_i + ib * bd + slot.ga_w, slot.n_past_se + ib * bd, dd);
  1841. slot.n_past_se -= bd;
  1842. slot.ga_i += slot.ga_w / slot.ga_n;
  1843. SLT_DBG(slot, "\nn_past_old = %d, n_past = %d, ga_i = %d\n\n", slot.n_past_se + bd, slot.n_past_se, slot.ga_i);
  1844. }
  1845. slot.n_past_se += n_tokens;
  1846. }
  1847. }
  1848. llama_batch batch_view = {
  1849. n_tokens,
  1850. batch.token + i,
  1851. nullptr,
  1852. batch.pos + i,
  1853. batch.n_seq_id + i,
  1854. batch.seq_id + i,
  1855. batch.logits + i,
  1856. 0, 0, 0, // unused
  1857. };
  1858. const int ret = llama_decode(ctx, batch_view);
  1859. metrics.on_decoded(slots);
  1860. if (ret != 0) {
  1861. if (n_batch == 1 || ret < 0) {
  1862. // if you get here, it means the KV cache is full - try increasing it via the context size
  1863. 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);
  1864. for (auto & slot : slots) {
  1865. slot.release();
  1866. send_error(slot, "Input prompt is too big compared to KV size. Please try increasing KV size.");
  1867. }
  1868. break; // break loop of n_batch
  1869. }
  1870. // retry with half the batch size to try to find a free slot in the KV cache
  1871. n_batch /= 2;
  1872. i -= n_batch;
  1873. 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);
  1874. continue; // continue loop of n_batch
  1875. }
  1876. for (auto & slot : slots) {
  1877. if (slot.i_batch < (int) i || slot.i_batch >= (int) (i + n_tokens)) {
  1878. continue; // continue loop of slots
  1879. }
  1880. if (slot.state == SLOT_STATE_DONE_PROMPT) {
  1881. if (slot.cmpl_type == SERVER_TASK_CMPL_TYPE_EMBEDDING) {
  1882. // prompt evaluated for embedding
  1883. send_embedding(slot, batch_view);
  1884. slot.release();
  1885. slot.i_batch = -1;
  1886. continue; // continue loop of slots
  1887. }
  1888. if (slot.cmpl_type == SERVER_TASK_CMPL_TYPE_RERANK) {
  1889. send_rerank(slot, batch_view);
  1890. slot.release();
  1891. slot.i_batch = -1;
  1892. continue; // continue loop of slots
  1893. }
  1894. // prompt evaluated for next-token prediction
  1895. slot.state = SLOT_STATE_GENERATING;
  1896. } else if (slot.state != SLOT_STATE_GENERATING) {
  1897. continue; // continue loop of slots
  1898. }
  1899. completion_token_output result;
  1900. const llama_token id = common_sampler_sample(slot.smpl, ctx, slot.i_batch - i);
  1901. common_sampler_accept(slot.smpl, id, true);
  1902. slot.n_decoded += 1;
  1903. if (slot.n_decoded == 1) {
  1904. slot.t_start_generation = ggml_time_us();
  1905. slot.t_prompt_processing = (slot.t_start_generation - slot.t_start_process_prompt) / 1e3;
  1906. metrics.on_prompt_eval(slot);
  1907. }
  1908. result.tok = id;
  1909. const auto * cur_p = common_sampler_get_candidates(slot.smpl);
  1910. for (size_t i = 0; i < (size_t) slot.sparams.n_probs; ++i) {
  1911. result.probs.push_back({
  1912. cur_p->data[i].id,
  1913. i >= cur_p->size ? 0.0f : cur_p->data[i].p,
  1914. });
  1915. }
  1916. if (!process_token(result, slot)) {
  1917. // release slot because of stop condition
  1918. slot.release();
  1919. slot.print_timings();
  1920. send_final_response(slot);
  1921. metrics.on_prediction(slot);
  1922. }
  1923. slot.i_batch = -1;
  1924. }
  1925. }
  1926. SRV_DBG("%s", "run slots completed\n");
  1927. }
  1928. json model_meta() const {
  1929. return json {
  1930. {"vocab_type", llama_vocab_type (model)},
  1931. {"n_vocab", llama_n_vocab (model)},
  1932. {"n_ctx_train", llama_n_ctx_train (model)},
  1933. {"n_embd", llama_n_embd (model)},
  1934. {"n_params", llama_model_n_params(model)},
  1935. {"size", llama_model_size (model)},
  1936. };
  1937. }
  1938. };
  1939. static void log_server_request(const httplib::Request & req, const httplib::Response & res) {
  1940. // skip GH copilot requests when using default port
  1941. if (req.path == "/v1/health" || req.path == "/v1/completions") {
  1942. return;
  1943. }
  1944. LOG_INF("request: %s %s %s %d\n", req.method.c_str(), req.path.c_str(), req.remote_addr.c_str(), res.status);
  1945. LOG_DBG("request: %s\n", req.body.c_str());
  1946. LOG_DBG("response: %s\n", res.body.c_str());
  1947. }
  1948. std::function<void(int)> shutdown_handler;
  1949. std::atomic_flag is_terminating = ATOMIC_FLAG_INIT;
  1950. inline void signal_handler(int signal) {
  1951. if (is_terminating.test_and_set()) {
  1952. // in case it hangs, we can force terminate the server by hitting Ctrl+C twice
  1953. // this is for better developer experience, we can remove when the server is stable enough
  1954. fprintf(stderr, "Received second interrupt, terminating immediately.\n");
  1955. exit(1);
  1956. }
  1957. shutdown_handler(signal);
  1958. }
  1959. int main(int argc, char ** argv) {
  1960. // own arguments required by this example
  1961. common_params params;
  1962. if (!common_params_parse(argc, argv, params, LLAMA_EXAMPLE_SERVER)) {
  1963. return 1;
  1964. }
  1965. common_init();
  1966. // enabling this will output extra debug information in the HTTP responses from the server
  1967. // see format_final_response_oaicompat()
  1968. const bool verbose = params.verbosity > 9;
  1969. // struct that contains llama context and inference
  1970. server_context ctx_server;
  1971. if (!params.system_prompt.empty()) {
  1972. ctx_server.system_prompt_set(params.system_prompt);
  1973. }
  1974. if (params.model_alias == "unknown") {
  1975. params.model_alias = params.model;
  1976. }
  1977. llama_backend_init();
  1978. llama_numa_init(params.numa);
  1979. 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());
  1980. LOG_INF("\n");
  1981. LOG_INF("%s\n", common_params_get_system_info(params).c_str());
  1982. LOG_INF("\n");
  1983. std::unique_ptr<httplib::Server> svr;
  1984. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  1985. if (params.ssl_file_key != "" && params.ssl_file_cert != "") {
  1986. LOG_INF("Running with SSL: key = %s, cert = %s\n", params.ssl_file_key.c_str(), params.ssl_file_cert.c_str());
  1987. svr.reset(
  1988. new httplib::SSLServer(params.ssl_file_cert.c_str(), params.ssl_file_key.c_str())
  1989. );
  1990. } else {
  1991. LOG_INF("Running without SSL\n");
  1992. svr.reset(new httplib::Server());
  1993. }
  1994. #else
  1995. if (params.ssl_file_key != "" && params.ssl_file_cert != "") {
  1996. LOG_ERR("Server is built without SSL support\n");
  1997. return 1;
  1998. }
  1999. svr.reset(new httplib::Server());
  2000. #endif
  2001. std::atomic<server_state> state{SERVER_STATE_LOADING_MODEL};
  2002. svr->set_default_headers({{"Server", "llama.cpp"}});
  2003. // CORS preflight
  2004. svr->Options(R"(.*)", [](const httplib::Request &, httplib::Response & res) {
  2005. // Access-Control-Allow-Origin is already set by middleware
  2006. res.set_header("Access-Control-Allow-Credentials", "true");
  2007. res.set_header("Access-Control-Allow-Methods", "POST");
  2008. res.set_header("Access-Control-Allow-Headers", "*");
  2009. return res.set_content("", "text/html"); // blank response, no data
  2010. });
  2011. svr->set_logger(log_server_request);
  2012. auto res_error = [](httplib::Response & res, const json & error_data) {
  2013. json final_response {{"error", error_data}};
  2014. res.set_content(final_response.dump(-1, ' ', false, json::error_handler_t::replace), MIMETYPE_JSON);
  2015. res.status = json_value(error_data, "code", 500);
  2016. };
  2017. auto res_ok = [](httplib::Response & res, const json & data) {
  2018. res.set_content(data.dump(-1, ' ', false, json::error_handler_t::replace), MIMETYPE_JSON);
  2019. res.status = 200;
  2020. };
  2021. svr->set_exception_handler([&res_error](const httplib::Request &, httplib::Response & res, std::exception_ptr ep) {
  2022. std::string message;
  2023. try {
  2024. std::rethrow_exception(ep);
  2025. } catch (std::exception & e) {
  2026. message = e.what();
  2027. } catch (...) {
  2028. message = "Unknown Exception";
  2029. }
  2030. json formatted_error = format_error_response(message, ERROR_TYPE_SERVER);
  2031. LOG_WRN("got exception: %s\n", formatted_error.dump().c_str());
  2032. res_error(res, formatted_error);
  2033. });
  2034. svr->set_error_handler([&res_error](const httplib::Request &, httplib::Response & res) {
  2035. if (res.status == 404) {
  2036. res_error(res, format_error_response("File Not Found", ERROR_TYPE_NOT_FOUND));
  2037. }
  2038. // for other error codes, we skip processing here because it's already done by res_error()
  2039. });
  2040. // set timeouts and change hostname and port
  2041. svr->set_read_timeout (params.timeout_read);
  2042. svr->set_write_timeout(params.timeout_write);
  2043. std::unordered_map<std::string, std::string> log_data;
  2044. log_data["hostname"] = params.hostname;
  2045. log_data["port"] = std::to_string(params.port);
  2046. if (params.api_keys.size() == 1) {
  2047. auto key = params.api_keys[0];
  2048. log_data["api_key"] = "api_key: ****" + key.substr(std::max((int)(key.length() - 4), 0));
  2049. } else if (params.api_keys.size() > 1) {
  2050. log_data["api_key"] = "api_key: " + std::to_string(params.api_keys.size()) + " keys loaded";
  2051. }
  2052. // Necessary similarity of prompt for slot selection
  2053. ctx_server.slot_prompt_similarity = params.slot_prompt_similarity;
  2054. //
  2055. // Middlewares
  2056. //
  2057. auto middleware_validate_api_key = [&params, &res_error](const httplib::Request & req, httplib::Response & res) {
  2058. static const std::unordered_set<std::string> public_endpoints = {
  2059. "/health",
  2060. "/models",
  2061. "/v1/models",
  2062. };
  2063. // If API key is not set, skip validation
  2064. if (params.api_keys.empty()) {
  2065. return true;
  2066. }
  2067. // If path is public, skip validation
  2068. if (public_endpoints.find(req.path) != public_endpoints.end()) {
  2069. return true;
  2070. }
  2071. // Check for API key in the header
  2072. auto auth_header = req.get_header_value("Authorization");
  2073. std::string prefix = "Bearer ";
  2074. if (auth_header.substr(0, prefix.size()) == prefix) {
  2075. std::string received_api_key = auth_header.substr(prefix.size());
  2076. if (std::find(params.api_keys.begin(), params.api_keys.end(), received_api_key) != params.api_keys.end()) {
  2077. return true; // API key is valid
  2078. }
  2079. }
  2080. // API key is invalid or not provided
  2081. res_error(res, format_error_response("Invalid API Key", ERROR_TYPE_AUTHENTICATION));
  2082. LOG_WRN("Unauthorized: Invalid API Key\n");
  2083. return false;
  2084. };
  2085. auto middleware_server_state = [&res_error, &state](const httplib::Request & req, httplib::Response & res) {
  2086. server_state current_state = state.load();
  2087. if (current_state == SERVER_STATE_LOADING_MODEL) {
  2088. auto tmp = string_split(req.path, '.');
  2089. if (req.path == "/" || tmp.back() == "html") {
  2090. res.set_content(reinterpret_cast<const char*>(loading_html), loading_html_len, "text/html; charset=utf-8");
  2091. res.status = 503;
  2092. } else {
  2093. res_error(res, format_error_response("Loading model", ERROR_TYPE_UNAVAILABLE));
  2094. }
  2095. return false;
  2096. }
  2097. return true;
  2098. };
  2099. // register server middlewares
  2100. svr->set_pre_routing_handler([&middleware_validate_api_key, &middleware_server_state](const httplib::Request & req, httplib::Response & res) {
  2101. res.set_header("Access-Control-Allow-Origin", req.get_header_value("Origin"));
  2102. if (!middleware_server_state(req, res)) {
  2103. return httplib::Server::HandlerResponse::Handled;
  2104. }
  2105. if (!middleware_validate_api_key(req, res)) {
  2106. return httplib::Server::HandlerResponse::Handled;
  2107. }
  2108. return httplib::Server::HandlerResponse::Unhandled;
  2109. });
  2110. //
  2111. // Route handlers (or controllers)
  2112. //
  2113. const auto handle_health = [&](const httplib::Request &, httplib::Response & res) {
  2114. // error and loading states are handled by middleware
  2115. json health = {{"status", "ok"}};
  2116. res_ok(res, health);
  2117. };
  2118. const auto handle_slots = [&](const httplib::Request & req, httplib::Response & res) {
  2119. if (!params.endpoint_slots) {
  2120. res_error(res, format_error_response("This server does not support slots endpoint. Start it with `--slots`", ERROR_TYPE_NOT_SUPPORTED));
  2121. return;
  2122. }
  2123. // request slots data using task queue
  2124. server_task task;
  2125. task.id = ctx_server.queue_tasks.get_new_id();
  2126. task.type = SERVER_TASK_TYPE_METRICS;
  2127. ctx_server.queue_results.add_waiting_task_id(task.id);
  2128. ctx_server.queue_tasks.post(task, true); // high-priority task
  2129. // get the result
  2130. server_task_result result = ctx_server.queue_results.recv(task.id);
  2131. ctx_server.queue_results.remove_waiting_task_id(task.id);
  2132. // optionally return "fail_on_no_slot" error
  2133. const int n_idle_slots = result.data.at("idle");
  2134. if (req.has_param("fail_on_no_slot")) {
  2135. if (n_idle_slots == 0) {
  2136. res_error(res, format_error_response("no slot available", ERROR_TYPE_UNAVAILABLE));
  2137. return;
  2138. }
  2139. }
  2140. res_ok(res, result.data.at("slots"));
  2141. };
  2142. const auto handle_metrics = [&](const httplib::Request &, httplib::Response & res) {
  2143. if (!params.endpoint_metrics) {
  2144. res_error(res, format_error_response("This server does not support metrics endpoint. Start it with `--metrics`", ERROR_TYPE_NOT_SUPPORTED));
  2145. return;
  2146. }
  2147. // request slots data using task queue
  2148. server_task task;
  2149. task.id = ctx_server.queue_tasks.get_new_id();
  2150. task.id_target = -1;
  2151. task.type = SERVER_TASK_TYPE_METRICS;
  2152. task.data.push_back({{"reset_bucket", true}});
  2153. ctx_server.queue_results.add_waiting_task_id(task.id);
  2154. ctx_server.queue_tasks.post(task, true); // high-priority task
  2155. // get the result
  2156. server_task_result result = ctx_server.queue_results.recv(task.id);
  2157. ctx_server.queue_results.remove_waiting_task_id(task.id);
  2158. json data = result.data;
  2159. const uint64_t n_prompt_tokens_processed = data.at("n_prompt_tokens_processed");
  2160. const uint64_t t_prompt_processing = data.at("t_prompt_processing");
  2161. const uint64_t n_tokens_predicted = data.at("n_tokens_predicted");
  2162. const uint64_t t_tokens_generation = data.at("t_tokens_generation");
  2163. const uint64_t n_decode_total = data.at("n_decode_total");
  2164. const uint64_t n_busy_slots_total = data.at("n_busy_slots_total");
  2165. const int32_t kv_cache_used_cells = data.at("kv_cache_used_cells");
  2166. // metrics definition: https://prometheus.io/docs/practices/naming/#metric-names
  2167. json all_metrics_def = json {
  2168. {"counter", {{
  2169. {"name", "prompt_tokens_total"},
  2170. {"help", "Number of prompt tokens processed."},
  2171. {"value", (uint64_t) data.at("n_prompt_tokens_processed_total")}
  2172. }, {
  2173. {"name", "prompt_seconds_total"},
  2174. {"help", "Prompt process time"},
  2175. {"value", (uint64_t) data.at("t_prompt_processing_total") / 1.e3}
  2176. }, {
  2177. {"name", "tokens_predicted_total"},
  2178. {"help", "Number of generation tokens processed."},
  2179. {"value", (uint64_t) data.at("n_tokens_predicted_total")}
  2180. }, {
  2181. {"name", "tokens_predicted_seconds_total"},
  2182. {"help", "Predict process time"},
  2183. {"value", (uint64_t) data.at("t_tokens_generation_total") / 1.e3}
  2184. }, {
  2185. {"name", "n_decode_total"},
  2186. {"help", "Total number of llama_decode() calls"},
  2187. {"value", n_decode_total}
  2188. }, {
  2189. {"name", "n_busy_slots_per_decode"},
  2190. {"help", "Average number of busy slots per llama_decode() call"},
  2191. {"value", (float) n_busy_slots_total / (float) n_decode_total}
  2192. }}},
  2193. {"gauge", {{
  2194. {"name", "prompt_tokens_seconds"},
  2195. {"help", "Average prompt throughput in tokens/s."},
  2196. {"value", n_prompt_tokens_processed ? 1.e3 / t_prompt_processing * n_prompt_tokens_processed : 0.}
  2197. },{
  2198. {"name", "predicted_tokens_seconds"},
  2199. {"help", "Average generation throughput in tokens/s."},
  2200. {"value", n_tokens_predicted ? 1.e3 / t_tokens_generation * n_tokens_predicted : 0.}
  2201. },{
  2202. {"name", "kv_cache_usage_ratio"},
  2203. {"help", "KV-cache usage. 1 means 100 percent usage."},
  2204. {"value", 1. * kv_cache_used_cells / params.n_ctx}
  2205. },{
  2206. {"name", "kv_cache_tokens"},
  2207. {"help", "KV-cache tokens."},
  2208. {"value", (uint64_t) data.at("kv_cache_tokens_count")}
  2209. },{
  2210. {"name", "requests_processing"},
  2211. {"help", "Number of request processing."},
  2212. {"value", (uint64_t) data.at("processing")}
  2213. },{
  2214. {"name", "requests_deferred"},
  2215. {"help", "Number of request deferred."},
  2216. {"value", (uint64_t) data.at("deferred")}
  2217. }}}
  2218. };
  2219. std::stringstream prometheus;
  2220. for (const auto & el : all_metrics_def.items()) {
  2221. const auto & type = el.key();
  2222. const auto & metrics_def = el.value();
  2223. for (const auto & metric_def : metrics_def) {
  2224. const std::string name = metric_def.at("name");
  2225. const std::string help = metric_def.at("help");
  2226. auto value = json_value(metric_def, "value", 0.);
  2227. prometheus << "# HELP llamacpp:" << name << " " << help << "\n"
  2228. << "# TYPE llamacpp:" << name << " " << type << "\n"
  2229. << "llamacpp:" << name << " " << value << "\n";
  2230. }
  2231. }
  2232. const int64_t t_start = data.at("t_start");
  2233. res.set_header("Process-Start-Time-Unix", std::to_string(t_start));
  2234. res.set_content(prometheus.str(), "text/plain; version=0.0.4");
  2235. res.status = 200; // HTTP OK
  2236. };
  2237. const auto handle_slots_save = [&ctx_server, &res_error, &res_ok, &params](const httplib::Request & req, httplib::Response & res, int id_slot) {
  2238. json request_data = json::parse(req.body);
  2239. std::string filename = request_data.at("filename");
  2240. if (!fs_validate_filename(filename)) {
  2241. res_error(res, format_error_response("Invalid filename", ERROR_TYPE_INVALID_REQUEST));
  2242. return;
  2243. }
  2244. std::string filepath = params.slot_save_path + filename;
  2245. server_task task;
  2246. task.type = SERVER_TASK_TYPE_SLOT_SAVE;
  2247. task.data = {
  2248. { "id_slot", id_slot },
  2249. { "filename", filename },
  2250. { "filepath", filepath },
  2251. };
  2252. const int id_task = ctx_server.queue_tasks.post(task);
  2253. ctx_server.queue_results.add_waiting_task_id(id_task);
  2254. server_task_result result = ctx_server.queue_results.recv(id_task);
  2255. ctx_server.queue_results.remove_waiting_task_id(id_task);
  2256. if (result.error) {
  2257. res_error(res, result.data);
  2258. } else {
  2259. res_ok(res, result.data);
  2260. }
  2261. };
  2262. const auto handle_slots_restore = [&ctx_server, &res_error, &res_ok, &params](const httplib::Request & req, httplib::Response & res, int id_slot) {
  2263. json request_data = json::parse(req.body);
  2264. std::string filename = request_data.at("filename");
  2265. if (!fs_validate_filename(filename)) {
  2266. res_error(res, format_error_response("Invalid filename", ERROR_TYPE_INVALID_REQUEST));
  2267. return;
  2268. }
  2269. std::string filepath = params.slot_save_path + filename;
  2270. server_task task;
  2271. task.type = SERVER_TASK_TYPE_SLOT_RESTORE;
  2272. task.data = {
  2273. { "id_slot", id_slot },
  2274. { "filename", filename },
  2275. { "filepath", filepath },
  2276. };
  2277. const int id_task = ctx_server.queue_tasks.post(task);
  2278. ctx_server.queue_results.add_waiting_task_id(id_task);
  2279. server_task_result result = ctx_server.queue_results.recv(id_task);
  2280. ctx_server.queue_results.remove_waiting_task_id(id_task);
  2281. if (result.error) {
  2282. res_error(res, result.data);
  2283. } else {
  2284. res_ok(res, result.data);
  2285. }
  2286. };
  2287. const auto handle_slots_erase = [&ctx_server, &res_error, &res_ok](const httplib::Request & /* req */, httplib::Response & res, int id_slot) {
  2288. server_task task;
  2289. task.type = SERVER_TASK_TYPE_SLOT_ERASE;
  2290. task.data = {
  2291. { "id_slot", id_slot },
  2292. };
  2293. const int id_task = ctx_server.queue_tasks.post(task);
  2294. ctx_server.queue_results.add_waiting_task_id(id_task);
  2295. server_task_result result = ctx_server.queue_results.recv(id_task);
  2296. ctx_server.queue_results.remove_waiting_task_id(id_task);
  2297. if (result.error) {
  2298. res_error(res, result.data);
  2299. } else {
  2300. res_ok(res, result.data);
  2301. }
  2302. };
  2303. const auto handle_slots_action = [&params, &res_error, &handle_slots_save, &handle_slots_restore, &handle_slots_erase](const httplib::Request & req, httplib::Response & res) {
  2304. if (params.slot_save_path.empty()) {
  2305. res_error(res, format_error_response("This server does not support slots action. Start it with `--slot-save-path`", ERROR_TYPE_NOT_SUPPORTED));
  2306. return;
  2307. }
  2308. std::string id_slot_str = req.path_params.at("id_slot");
  2309. int id_slot;
  2310. try {
  2311. id_slot = std::stoi(id_slot_str);
  2312. } catch (const std::exception &) {
  2313. res_error(res, format_error_response("Invalid slot ID", ERROR_TYPE_INVALID_REQUEST));
  2314. return;
  2315. }
  2316. std::string action = req.get_param_value("action");
  2317. if (action == "save") {
  2318. handle_slots_save(req, res, id_slot);
  2319. } else if (action == "restore") {
  2320. handle_slots_restore(req, res, id_slot);
  2321. } else if (action == "erase") {
  2322. handle_slots_erase(req, res, id_slot);
  2323. } else {
  2324. res_error(res, format_error_response("Invalid action", ERROR_TYPE_INVALID_REQUEST));
  2325. }
  2326. };
  2327. const auto handle_props = [&ctx_server, &res_ok](const httplib::Request &, httplib::Response & res) {
  2328. json data = {
  2329. { "system_prompt", ctx_server.system_prompt },
  2330. { "default_generation_settings", ctx_server.default_generation_settings_for_props },
  2331. { "total_slots", ctx_server.params.n_parallel },
  2332. { "chat_template", llama_get_chat_template(ctx_server.model) },
  2333. };
  2334. res_ok(res, data);
  2335. };
  2336. const auto handle_props_change = [&ctx_server, &res_error, &res_ok](const httplib::Request & req, httplib::Response & res) {
  2337. if (!ctx_server.params.endpoint_props) {
  2338. res_error(res, format_error_response("This server does not support changing global properties. Start it with `--props`", ERROR_TYPE_NOT_SUPPORTED));
  2339. return;
  2340. }
  2341. json data = json::parse(req.body);
  2342. if (data.contains("system_prompt")) {
  2343. std::string system_prompt = data.at("system_prompt");
  2344. ctx_server.system_prompt_set(system_prompt);
  2345. }
  2346. res_ok(res, {{ "success", true }});
  2347. };
  2348. const auto handle_completions_generic = [&ctx_server, &res_error, &res_ok](server_task_cmpl_type cmpl_type, json & data, httplib::Response & res) {
  2349. if (ctx_server.params.embedding || ctx_server.params.reranking) {
  2350. res_error(res, format_error_response("This server does not support completions. Start it without `--embeddings` or `--reranking`", ERROR_TYPE_NOT_SUPPORTED));
  2351. return;
  2352. }
  2353. std::vector<server_task> tasks = ctx_server.create_tasks_cmpl(data, cmpl_type);
  2354. ctx_server.queue_results.add_waiting_tasks(tasks);
  2355. ctx_server.queue_tasks.post(tasks);
  2356. bool stream = json_value(data, "stream", false);
  2357. const auto task_ids = server_task::get_list_id(tasks);
  2358. if (!stream) {
  2359. ctx_server.receive_cmpl_results(task_ids, [&](std::vector<server_task_result> & results) {
  2360. if (results.size() == 1) {
  2361. // single result
  2362. res_ok(res, results[0].data);
  2363. } else {
  2364. // multiple results (multitask)
  2365. json arr = json::array();
  2366. for (const auto & res : results) {
  2367. arr.push_back(res.data);
  2368. }
  2369. res_ok(res, arr);
  2370. }
  2371. }, [&](const json & error_data) {
  2372. res_error(res, error_data);
  2373. });
  2374. ctx_server.queue_results.remove_waiting_task_ids(task_ids);
  2375. } else {
  2376. const auto chunked_content_provider = [task_ids, &ctx_server](size_t, httplib::DataSink & sink) {
  2377. ctx_server.receive_cmpl_results_stream(task_ids, [&](const server_task_result & result) -> bool {
  2378. return server_sent_event(sink, "data", result.data);
  2379. }, [&](const json & error_data) {
  2380. server_sent_event(sink, "error", error_data);
  2381. });
  2382. sink.done();
  2383. return false;
  2384. };
  2385. auto on_complete = [task_ids, &ctx_server] (bool) {
  2386. ctx_server.queue_results.remove_waiting_task_ids(task_ids);
  2387. };
  2388. res.set_chunked_content_provider("text/event-stream", chunked_content_provider, on_complete);
  2389. }
  2390. };
  2391. const auto handle_completions = [&handle_completions_generic](const httplib::Request & req, httplib::Response & res) {
  2392. json data = json::parse(req.body);
  2393. return handle_completions_generic(SERVER_TASK_CMPL_TYPE_NORMAL, data, res);
  2394. };
  2395. const auto handle_infill = [&handle_completions_generic](const httplib::Request & req, httplib::Response & res) {
  2396. json data = json::parse(req.body);
  2397. return handle_completions_generic(SERVER_TASK_CMPL_TYPE_INFILL, data, res);
  2398. };
  2399. // TODO: maybe merge this function with "handle_completions_generic"
  2400. const auto handle_chat_completions = [&ctx_server, &params, &res_error, &res_ok, verbose](const httplib::Request & req, httplib::Response & res) {
  2401. if (ctx_server.params.embedding || ctx_server.params.reranking) {
  2402. res_error(res, format_error_response("This server does not support completions. Start it without `--embeddings` or `--reranking`", ERROR_TYPE_NOT_SUPPORTED));
  2403. return;
  2404. }
  2405. json data = oaicompat_completion_params_parse(ctx_server.model, json::parse(req.body), params.chat_template);
  2406. std::vector<server_task> tasks = ctx_server.create_tasks_cmpl(data, SERVER_TASK_CMPL_TYPE_NORMAL);
  2407. ctx_server.queue_results.add_waiting_tasks(tasks);
  2408. ctx_server.queue_tasks.post(tasks);
  2409. bool stream = json_value(data, "stream", false);
  2410. const auto task_ids = server_task::get_list_id(tasks);
  2411. const auto completion_id = gen_chatcmplid();
  2412. if (!stream) {
  2413. ctx_server.receive_cmpl_results(task_ids, [&](const std::vector<server_task_result> & results) {
  2414. // multitask is never support in chat completion, there is only one result
  2415. json result_oai = format_final_response_oaicompat(data, results[0].data, completion_id, /*.streaming =*/ false, verbose);
  2416. res_ok(res, result_oai);
  2417. }, [&](const json & error_data) {
  2418. res_error(res, error_data);
  2419. });
  2420. ctx_server.queue_results.remove_waiting_task_ids(task_ids);
  2421. } else {
  2422. const auto chunked_content_provider = [task_ids, &ctx_server, completion_id](size_t, httplib::DataSink & sink) {
  2423. ctx_server.receive_cmpl_results_stream(task_ids, [&](const server_task_result & result) -> bool {
  2424. std::vector<json> result_array = format_partial_response_oaicompat(result.data, completion_id);
  2425. for (auto & event_data : result_array) {
  2426. if (event_data.empty()) {
  2427. continue; // skip the stop token
  2428. }
  2429. if (!server_sent_event(sink, "data", event_data)) {
  2430. return false; // connection is closed
  2431. }
  2432. }
  2433. return true; // ok
  2434. }, [&](const json & error_data) {
  2435. server_sent_event(sink, "error", error_data);
  2436. });
  2437. static const std::string ev_done = "data: [DONE]\n\n";
  2438. sink.write(ev_done.data(), ev_done.size());
  2439. sink.done();
  2440. return true;
  2441. };
  2442. auto on_complete = [task_ids, &ctx_server] (bool) {
  2443. ctx_server.queue_results.remove_waiting_task_ids(task_ids);
  2444. };
  2445. res.set_chunked_content_provider("text/event-stream", chunked_content_provider, on_complete);
  2446. }
  2447. };
  2448. const auto handle_models = [&params, &ctx_server](const httplib::Request &, httplib::Response & res) {
  2449. json models = {
  2450. {"object", "list"},
  2451. {"data", {
  2452. {
  2453. {"id", params.model_alias},
  2454. {"object", "model"},
  2455. {"created", std::time(0)},
  2456. {"owned_by", "llamacpp"},
  2457. {"meta", ctx_server.model_meta()}
  2458. },
  2459. }}
  2460. };
  2461. res.set_content(models.dump(), MIMETYPE_JSON);
  2462. };
  2463. const auto handle_tokenize = [&ctx_server, &res_ok](const httplib::Request & req, httplib::Response & res) {
  2464. const json body = json::parse(req.body);
  2465. json tokens_response = json::array();
  2466. if (body.count("content") != 0) {
  2467. const bool add_special = json_value(body, "add_special", false);
  2468. const bool with_pieces = json_value(body, "with_pieces", false);
  2469. std::vector<llama_token> tokens = ctx_server.tokenize(body.at("content"), add_special);
  2470. if (with_pieces) {
  2471. for (const auto& token : tokens) {
  2472. std::string piece = common_token_to_piece(ctx_server.ctx, token);
  2473. json piece_json;
  2474. // Check if the piece is valid UTF-8
  2475. if (is_valid_utf8(piece)) {
  2476. piece_json = piece;
  2477. } else {
  2478. // If not valid UTF-8, store as array of byte values
  2479. piece_json = json::array();
  2480. for (unsigned char c : piece) {
  2481. piece_json.push_back(static_cast<int>(c));
  2482. }
  2483. }
  2484. tokens_response.push_back({
  2485. {"id", token},
  2486. {"piece", piece_json}
  2487. });
  2488. }
  2489. } else {
  2490. tokens_response = tokens;
  2491. }
  2492. }
  2493. const json data = format_tokenizer_response(tokens_response);
  2494. res_ok(res, data);
  2495. };
  2496. const auto handle_detokenize = [&ctx_server, &res_ok](const httplib::Request & req, httplib::Response & res) {
  2497. const json body = json::parse(req.body);
  2498. std::string content;
  2499. if (body.count("tokens") != 0) {
  2500. const std::vector<llama_token> tokens = body.at("tokens");
  2501. content = tokens_to_str(ctx_server.ctx, tokens.cbegin(), tokens.cend());
  2502. }
  2503. const json data = format_detokenized_response(content);
  2504. res_ok(res, data);
  2505. };
  2506. const auto handle_embeddings = [&ctx_server, &res_error, &res_ok](const httplib::Request & req, httplib::Response & res) {
  2507. // TODO: somehow clean up this checks in the future
  2508. if (!ctx_server.params.embedding || ctx_server.params.reranking) {
  2509. res_error(res, format_error_response("This server does not support embeddings. Start it with `--embeddings` and without `--reranking`", ERROR_TYPE_NOT_SUPPORTED));
  2510. return;
  2511. }
  2512. const json body = json::parse(req.body);
  2513. bool is_openai = false;
  2514. // an input prompt can be a string or a list of tokens (integer)
  2515. json prompt;
  2516. if (body.count("input") != 0) {
  2517. is_openai = true;
  2518. prompt = body.at("input");
  2519. } else if (body.count("content") != 0) {
  2520. // with "content", we only support single prompt
  2521. prompt = std::vector<std::string>{body.at("content")};
  2522. } else {
  2523. res_error(res, format_error_response("\"input\" or \"content\" must be provided", ERROR_TYPE_INVALID_REQUEST));
  2524. return;
  2525. }
  2526. // create and queue the task
  2527. json responses = json::array();
  2528. bool error = false;
  2529. {
  2530. std::vector<server_task> tasks = ctx_server.create_tasks_cmpl({{"prompt", prompt}}, SERVER_TASK_CMPL_TYPE_EMBEDDING);
  2531. ctx_server.queue_results.add_waiting_tasks(tasks);
  2532. ctx_server.queue_tasks.post(tasks);
  2533. // get the result
  2534. std::unordered_set<int> task_ids = server_task::get_list_id(tasks);
  2535. ctx_server.receive_cmpl_results(task_ids, [&](std::vector<server_task_result> & results) {
  2536. for (const auto & res : results) {
  2537. responses.push_back(res.data);
  2538. }
  2539. }, [&](const json & error_data) {
  2540. res_error(res, error_data);
  2541. error = true;
  2542. });
  2543. ctx_server.queue_results.remove_waiting_task_ids(task_ids);
  2544. }
  2545. if (error) {
  2546. return;
  2547. }
  2548. // write JSON response
  2549. json root = is_openai
  2550. ? format_embeddings_response_oaicompat(body, responses)
  2551. : responses[0];
  2552. res_ok(res, root);
  2553. };
  2554. const auto handle_rerank = [&ctx_server, &res_error, &res_ok](const httplib::Request & req, httplib::Response & res) {
  2555. if (!ctx_server.params.reranking) {
  2556. res_error(res, format_error_response("This server does not support reranking. Start it with `--reranking`", ERROR_TYPE_NOT_SUPPORTED));
  2557. return;
  2558. }
  2559. const json body = json::parse(req.body);
  2560. // TODO: implement
  2561. //int top_n = 1;
  2562. //if (body.count("top_n") != 1) {
  2563. // top_n = body.at("top_n");
  2564. //} else {
  2565. // res_error(res, format_error_response("\"top_n\" must be provided", ERROR_TYPE_INVALID_REQUEST));
  2566. // return;
  2567. //}
  2568. json query;
  2569. if (body.count("query") == 1) {
  2570. query = body.at("query");
  2571. if (!query.is_string()) {
  2572. res_error(res, format_error_response("\"query\" must be a string", ERROR_TYPE_INVALID_REQUEST));
  2573. return;
  2574. }
  2575. } else {
  2576. res_error(res, format_error_response("\"query\" must be provided", ERROR_TYPE_INVALID_REQUEST));
  2577. return;
  2578. }
  2579. std::vector<std::string> documents = json_value(body, "documents", std::vector<std::string>());
  2580. if (documents.empty()) {
  2581. res_error(res, format_error_response("\"documents\" must be a non-empty string array", ERROR_TYPE_INVALID_REQUEST));
  2582. return;
  2583. }
  2584. // construct prompt object: array of ["query", "doc0", "doc1", ...]
  2585. json prompt;
  2586. prompt.push_back(query);
  2587. for (const auto & doc : documents) {
  2588. prompt.push_back(doc);
  2589. }
  2590. LOG_DBG("rerank prompt: %s\n", prompt.dump().c_str());
  2591. // create and queue the task
  2592. json responses = json::array();
  2593. bool error = false;
  2594. {
  2595. std::vector<server_task> tasks = ctx_server.create_tasks_cmpl({{"prompt", prompt}}, SERVER_TASK_CMPL_TYPE_RERANK);
  2596. ctx_server.queue_results.add_waiting_tasks(tasks);
  2597. ctx_server.queue_tasks.post(tasks);
  2598. // get the result
  2599. std::unordered_set<int> task_ids = server_task::get_list_id(tasks);
  2600. ctx_server.receive_cmpl_results(task_ids, [&](std::vector<server_task_result> & results) {
  2601. for (const auto & res : results) {
  2602. responses.push_back(res.data);
  2603. }
  2604. }, [&](const json & error_data) {
  2605. res_error(res, error_data);
  2606. error = true;
  2607. });
  2608. }
  2609. if (error) {
  2610. return;
  2611. }
  2612. // write JSON response
  2613. json root = format_response_rerank(body, responses);
  2614. res_ok(res, root);
  2615. };
  2616. const auto handle_lora_adapters_list = [&](const httplib::Request &, httplib::Response & res) {
  2617. json result = json::array();
  2618. for (size_t i = 0; i < ctx_server.loras.size(); ++i) {
  2619. auto & lora = ctx_server.loras[i];
  2620. result.push_back({
  2621. {"id", i},
  2622. {"path", lora.path},
  2623. {"scale", lora.scale},
  2624. });
  2625. }
  2626. res_ok(res, result);
  2627. res.status = 200; // HTTP OK
  2628. };
  2629. const auto handle_lora_adapters_apply = [&](const httplib::Request & req, httplib::Response & res) {
  2630. const std::vector<json> body = json::parse(req.body);
  2631. int max_idx = ctx_server.loras.size();
  2632. // clear existing value
  2633. for (auto & lora : ctx_server.loras) {
  2634. lora.scale = 0.0f;
  2635. }
  2636. // set value
  2637. for (auto entry : body) {
  2638. int id = entry.at("id");
  2639. float scale = entry.at("scale");
  2640. if (0 <= id && id < max_idx) {
  2641. ctx_server.loras[id].scale = scale;
  2642. } else {
  2643. throw std::runtime_error("invalid adapter id");
  2644. }
  2645. }
  2646. server_task task;
  2647. task.type = SERVER_TASK_TYPE_SET_LORA;
  2648. const int id_task = ctx_server.queue_tasks.post(task);
  2649. ctx_server.queue_results.add_waiting_task_id(id_task);
  2650. server_task_result result = ctx_server.queue_results.recv(id_task);
  2651. ctx_server.queue_results.remove_waiting_task_id(id_task);
  2652. res_ok(res, result.data);
  2653. res.status = 200; // HTTP OK
  2654. };
  2655. auto handle_static_file = [](unsigned char * content, size_t len, const char * mime_type) {
  2656. return [content, len, mime_type](const httplib::Request &, httplib::Response & res) {
  2657. res.set_content(reinterpret_cast<const char*>(content), len, mime_type);
  2658. return false;
  2659. };
  2660. };
  2661. //
  2662. // Router
  2663. //
  2664. // register static assets routes
  2665. if (!params.public_path.empty()) {
  2666. // Set the base directory for serving static files
  2667. svr->set_base_dir(params.public_path);
  2668. }
  2669. if (!params.api_keys.empty()) {
  2670. // for now, if API key is set, web UI is unusable
  2671. svr->Get("/", [&](const httplib::Request &, httplib::Response & res) {
  2672. return res.set_content("Web UI is disabled because API key is set.", "text/html; charset=utf-8");
  2673. });
  2674. } else {
  2675. // using embedded static files
  2676. svr->Get("/", handle_static_file(index_html, index_html_len, "text/html; charset=utf-8"));
  2677. svr->Get("/index.js", handle_static_file(index_js, index_js_len, "text/javascript; charset=utf-8"));
  2678. svr->Get("/completion.js", handle_static_file(completion_js, completion_js_len, "text/javascript; charset=utf-8"));
  2679. svr->Get("/json-schema-to-grammar.mjs", handle_static_file(json_schema_to_grammar_mjs, json_schema_to_grammar_mjs_len, "text/javascript; charset=utf-8"));
  2680. // add new-ui files
  2681. svr->Get("/colorthemes.css", handle_static_file(colorthemes_css, colorthemes_css_len, "text/css; charset=utf-8"));
  2682. svr->Get("/style.css", handle_static_file(style_css, style_css_len, "text/css; charset=utf-8"));
  2683. svr->Get("/theme-beeninorder.css", handle_static_file(theme_beeninorder_css, theme_beeninorder_css_len, "text/css; charset=utf-8"));
  2684. svr->Get("/theme-ketivah.css", handle_static_file(theme_ketivah_css, theme_ketivah_css_len, "text/css; charset=utf-8"));
  2685. svr->Get("/theme-mangotango.css", handle_static_file(theme_mangotango_css, theme_mangotango_css_len, "text/css; charset=utf-8"));
  2686. svr->Get("/theme-playground.css", handle_static_file(theme_playground_css, theme_playground_css_len, "text/css; charset=utf-8"));
  2687. svr->Get("/theme-polarnight.css", handle_static_file(theme_polarnight_css, theme_polarnight_css_len, "text/css; charset=utf-8"));
  2688. svr->Get("/theme-snowstorm.css", handle_static_file(theme_snowstorm_css, theme_snowstorm_css_len, "text/css; charset=utf-8"));
  2689. svr->Get("/index-new.html", handle_static_file(index_new_html, index_new_html_len, "text/html; charset=utf-8"));
  2690. svr->Get("/system-prompts.js", handle_static_file(system_prompts_js, system_prompts_js_len, "text/javascript; charset=utf-8"));
  2691. svr->Get("/prompt-formats.js", handle_static_file(prompt_formats_js, prompt_formats_js_len, "text/javascript; charset=utf-8"));
  2692. }
  2693. // register API routes
  2694. svr->Get ("/health", handle_health); // public endpoint (no API key check)
  2695. svr->Get ("/metrics", handle_metrics);
  2696. svr->Get ("/props", handle_props);
  2697. svr->Post("/props", handle_props_change);
  2698. svr->Get ("/models", handle_models); // public endpoint (no API key check)
  2699. svr->Get ("/v1/models", handle_models); // public endpoint (no API key check)
  2700. svr->Post("/completion", handle_completions); // legacy
  2701. svr->Post("/completions", handle_completions);
  2702. svr->Post("/v1/completions", handle_completions);
  2703. svr->Post("/chat/completions", handle_chat_completions);
  2704. svr->Post("/v1/chat/completions", handle_chat_completions);
  2705. svr->Post("/infill", handle_infill);
  2706. svr->Post("/embedding", handle_embeddings); // legacy
  2707. svr->Post("/embeddings", handle_embeddings);
  2708. svr->Post("/v1/embeddings", handle_embeddings);
  2709. svr->Post("/rerank", handle_rerank);
  2710. svr->Post("/reranking", handle_rerank);
  2711. svr->Post("/v1/rerank", handle_rerank);
  2712. svr->Post("/v1/reranking", handle_rerank);
  2713. svr->Post("/tokenize", handle_tokenize);
  2714. svr->Post("/detokenize", handle_detokenize);
  2715. // LoRA adapters hotswap
  2716. svr->Get ("/lora-adapters", handle_lora_adapters_list);
  2717. svr->Post("/lora-adapters", handle_lora_adapters_apply);
  2718. // Save & load slots
  2719. svr->Get ("/slots", handle_slots);
  2720. svr->Post("/slots/:id_slot", handle_slots_action);
  2721. //
  2722. // Start the server
  2723. //
  2724. if (params.n_threads_http < 1) {
  2725. // +2 threads for monitoring endpoints
  2726. params.n_threads_http = std::max(params.n_parallel + 2, (int32_t) std::thread::hardware_concurrency() - 1);
  2727. }
  2728. log_data["n_threads_http"] = std::to_string(params.n_threads_http);
  2729. svr->new_task_queue = [&params] { return new httplib::ThreadPool(params.n_threads_http); };
  2730. // clean up function, to be called before exit
  2731. auto clean_up = [&svr]() {
  2732. svr->stop();
  2733. llama_backend_free();
  2734. };
  2735. // bind HTTP listen port, run the HTTP server in a thread
  2736. if (!svr->bind_to_port(params.hostname, params.port)) {
  2737. //LOG_ERROR("couldn't bind HTTP server socket", {
  2738. // {"hostname", params.hostname},
  2739. // {"port", params.port},
  2740. //});
  2741. LOG_ERR("%s: couldn't bind HTTP server socket, hostname: %s, port: %d\n", __func__, params.hostname.c_str(), params.port);
  2742. clean_up();
  2743. return 1;
  2744. }
  2745. std::thread t([&]() { svr->listen_after_bind(); });
  2746. svr->wait_until_ready();
  2747. 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);
  2748. // load the model
  2749. LOG_INF("%s: loading model\n", __func__);
  2750. if (!ctx_server.load_model(params)) {
  2751. clean_up();
  2752. t.join();
  2753. LOG_ERR("%s: exiting due to model loading error\n", __func__);
  2754. return 1;
  2755. }
  2756. ctx_server.init();
  2757. state.store(SERVER_STATE_READY);
  2758. LOG_INF("%s: model loaded\n", __func__);
  2759. // if a custom chat template is not supplied, we will use the one that comes with the model (if any)
  2760. if (params.chat_template.empty()) {
  2761. if (!ctx_server.validate_model_chat_template()) {
  2762. 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__);
  2763. params.chat_template = "chatml";
  2764. }
  2765. }
  2766. // print sample chat example to make it clear which template is used
  2767. 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());
  2768. ctx_server.queue_tasks.on_new_task(std::bind(
  2769. &server_context::process_single_task, &ctx_server, std::placeholders::_1));
  2770. ctx_server.queue_tasks.on_update_slots(std::bind(
  2771. &server_context::update_slots, &ctx_server));
  2772. shutdown_handler = [&](int) {
  2773. ctx_server.queue_tasks.terminate();
  2774. };
  2775. LOG_INF("%s: server is listening on %s:%d - starting the main loop\n", __func__, params.hostname.c_str(), params.port);
  2776. ctx_server.queue_tasks.start_loop();
  2777. #if defined (__unix__) || (defined (__APPLE__) && defined (__MACH__))
  2778. struct sigaction sigint_action;
  2779. sigint_action.sa_handler = signal_handler;
  2780. sigemptyset (&sigint_action.sa_mask);
  2781. sigint_action.sa_flags = 0;
  2782. sigaction(SIGINT, &sigint_action, NULL);
  2783. sigaction(SIGTERM, &sigint_action, NULL);
  2784. #elif defined (_WIN32)
  2785. auto console_ctrl_handler = +[](DWORD ctrl_type) -> BOOL {
  2786. return (ctrl_type == CTRL_C_EVENT) ? (signal_handler(SIGINT), true) : false;
  2787. };
  2788. SetConsoleCtrlHandler(reinterpret_cast<PHANDLER_ROUTINE>(console_ctrl_handler), true);
  2789. #endif
  2790. clean_up();
  2791. t.join();
  2792. return 0;
  2793. }