server.cpp 130 KB

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