server.cpp 132 KB

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