server.cpp 123 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267
  1. // MIT License
  2. // Copyright (c) 2023 Georgi Gerganov
  3. // Permission is hereby granted, free of charge, to any person obtaining a copy
  4. // of this software and associated documentation files (the "Software"), to deal
  5. // in the Software without restriction, including without limitation the rights
  6. // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  7. // copies of the Software, and to permit persons to whom the Software is
  8. // furnished to do so, subject to the following conditions:
  9. // The above copyright notice and this permission notice shall be included in all
  10. // copies or substantial portions of the Software.
  11. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  12. // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  13. // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  14. // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  15. // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  16. // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  17. // SOFTWARE.
  18. #include "common.h"
  19. #include "llama.h"
  20. #include "grammar-parser.h"
  21. #include "utils.hpp"
  22. #include "../llava/clip.h"
  23. #include "../llava/llava.h"
  24. #include "stb_image.h"
  25. #ifndef NDEBUG
  26. // crash the server in debug mode, otherwise send an http 500 error
  27. #define CPPHTTPLIB_NO_EXCEPTIONS 1
  28. #endif
  29. // increase max payload length to allow use of larger context size
  30. #define CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH 1048576
  31. #include "httplib.h"
  32. #include "json.hpp"
  33. #if defined(_WIN32)
  34. #include <windows.h>
  35. #include <errhandlingapi.h>
  36. #endif
  37. #include <algorithm>
  38. #include <cstddef>
  39. #include <thread>
  40. #include <chrono>
  41. #include <condition_variable>
  42. #include <atomic>
  43. #include <signal.h>
  44. using json = nlohmann::json;
  45. struct server_params {
  46. std::string hostname = "127.0.0.1";
  47. std::vector<std::string> api_keys;
  48. std::string public_path = "examples/server/public";
  49. int32_t port = 8080;
  50. int32_t read_timeout = 600;
  51. int32_t write_timeout = 600;
  52. bool slots_endpoint = true;
  53. bool metrics_endpoint = false;
  54. int n_threads_http = -1;
  55. };
  56. bool server_verbose = false;
  57. bool server_log_json = false;
  58. enum stop_type {
  59. STOP_FULL,
  60. STOP_PARTIAL,
  61. };
  62. // TODO: can become bool if we can't find use of more states
  63. enum slot_state {
  64. IDLE,
  65. PROCESSING,
  66. };
  67. enum slot_command {
  68. NONE,
  69. LOAD_PROMPT,
  70. RELEASE,
  71. };
  72. struct slot_params {
  73. bool stream = true;
  74. bool cache_prompt = false; // remember the prompt to avoid reprocessing all prompt
  75. uint32_t seed = -1; // RNG seed
  76. int32_t n_keep = 0; // number of tokens to keep from initial prompt
  77. int32_t n_predict = -1; // new tokens to predict
  78. std::vector<std::string> antiprompt;
  79. json input_prefix;
  80. json input_suffix;
  81. };
  82. struct slot_image {
  83. int32_t id;
  84. bool request_encode_image = false;
  85. float * image_embedding = nullptr;
  86. int32_t image_tokens = 0;
  87. clip_image_u8 * img_data;
  88. std::string prefix_prompt; // before of this image
  89. };
  90. struct server_slot {
  91. int id;
  92. int task_id = -1;
  93. struct slot_params params;
  94. slot_state state = IDLE;
  95. slot_command command = NONE;
  96. // used to determine the slot that has been used the longest
  97. int64_t t_last_used = -1;
  98. // generation props
  99. int32_t n_ctx = 0; // context size per slot
  100. int32_t n_past = 0;
  101. int32_t n_decoded = 0;
  102. int32_t n_remaining = -1;
  103. int32_t i_batch = -1;
  104. int32_t n_predict = -1;
  105. int32_t n_prompt_tokens = 0;
  106. int32_t n_prompt_tokens_processed = 0;
  107. json prompt;
  108. std::string generated_text;
  109. llama_token sampled;
  110. std::vector<llama_token> cache_tokens;
  111. std::vector<completion_token_output> generated_token_probs;
  112. bool embedding = false;
  113. bool has_next_token = true;
  114. bool truncated = false;
  115. bool stopped_eos = false;
  116. bool stopped_word = false;
  117. bool stopped_limit = false;
  118. std::string stopping_word;
  119. // sampling
  120. struct llama_sampling_params sparams;
  121. llama_sampling_context *ctx_sampling = nullptr;
  122. int32_t ga_i = 0; // group-attention state
  123. int32_t ga_n = 1; // group-attention factor
  124. int32_t ga_w = 512; // group-attention width
  125. int32_t n_past_se = 0; // self-extend
  126. // multimodal
  127. std::vector<slot_image> images;
  128. // stats
  129. size_t n_sent_text = 0; // number of sent text character
  130. size_t n_sent_token_probs = 0;
  131. int64_t t_start_process_prompt;
  132. int64_t t_start_genereration;
  133. double t_prompt_processing; // ms
  134. double t_token_generation; // ms
  135. // multitasks
  136. int multitask_id = -1;
  137. void reset() {
  138. n_prompt_tokens = 0;
  139. generated_text = "";
  140. truncated = false;
  141. stopped_eos = false;
  142. stopped_word = false;
  143. stopped_limit = false;
  144. stopping_word = "";
  145. n_past = 0;
  146. n_sent_text = 0;
  147. n_sent_token_probs = 0;
  148. ga_i = 0;
  149. n_past_se = 0;
  150. generated_token_probs.clear();
  151. for (slot_image & img : images) {
  152. free(img.image_embedding);
  153. if (img.img_data) {
  154. clip_image_u8_free(img.img_data);
  155. }
  156. img.prefix_prompt = "";
  157. }
  158. images.clear();
  159. }
  160. bool has_budget(gpt_params &global_params) {
  161. if (params.n_predict == -1 && global_params.n_predict == -1) {
  162. return true; // limitless
  163. }
  164. n_remaining = -1;
  165. if (params.n_predict != -1) {
  166. n_remaining = params.n_predict - n_decoded;
  167. } else if (global_params.n_predict != -1) {
  168. n_remaining = global_params.n_predict - n_decoded;
  169. }
  170. return n_remaining > 0; // no budget
  171. }
  172. bool available() const {
  173. return state == IDLE && command == NONE;
  174. }
  175. bool is_processing() const {
  176. return (state == IDLE && command == LOAD_PROMPT) || state == PROCESSING;
  177. }
  178. void add_token_string(const completion_token_output &token) {
  179. if (command == RELEASE) {
  180. return;
  181. }
  182. cache_tokens.push_back(token.tok);
  183. generated_token_probs.push_back(token);
  184. }
  185. void release() {
  186. if (state == PROCESSING)
  187. {
  188. t_token_generation = (ggml_time_us() - t_start_genereration) / 1e3;
  189. command = RELEASE;
  190. }
  191. }
  192. json get_formated_timings() {
  193. return json
  194. {
  195. {"prompt_n", n_prompt_tokens_processed},
  196. {"prompt_ms", t_prompt_processing},
  197. {"prompt_per_token_ms", t_prompt_processing / n_prompt_tokens_processed},
  198. {"prompt_per_second", 1e3 / t_prompt_processing * n_prompt_tokens_processed},
  199. {"predicted_n", n_decoded},
  200. {"predicted_ms", t_token_generation},
  201. {"predicted_per_token_ms", t_token_generation / n_decoded},
  202. {"predicted_per_second", 1e3 / t_token_generation * n_decoded},
  203. };
  204. }
  205. void print_timings() const {
  206. char buffer[512];
  207. double t_token = t_prompt_processing / n_prompt_tokens_processed;
  208. double n_tokens_second = 1e3 / t_prompt_processing * n_prompt_tokens_processed;
  209. sprintf(buffer, "prompt eval time = %10.2f ms / %5d tokens (%8.2f ms per token, %8.2f tokens per second)",
  210. t_prompt_processing, n_prompt_tokens_processed,
  211. t_token, n_tokens_second);
  212. LOG_DEBUG(buffer, {
  213. {"slot_id", id},
  214. {"task_id", task_id},
  215. {"t_prompt_processing", t_prompt_processing},
  216. {"n_prompt_tokens_processed", n_prompt_tokens_processed},
  217. {"t_token", t_token},
  218. {"n_tokens_second", n_tokens_second},
  219. });
  220. t_token = t_token_generation / n_decoded;
  221. n_tokens_second = 1e3 / t_token_generation * n_decoded;
  222. sprintf(buffer, "generation eval time = %10.2f ms / %5d runs (%8.2f ms per token, %8.2f tokens per second)",
  223. t_token_generation, n_decoded,
  224. t_token, n_tokens_second);
  225. LOG_DEBUG(buffer, {
  226. {"slot_id", id},
  227. {"task_id", task_id},
  228. {"t_token_generation", t_token_generation},
  229. {"n_decoded", n_decoded},
  230. {"t_token", t_token},
  231. {"n_tokens_second", n_tokens_second},
  232. });
  233. sprintf(buffer, " total time = %10.2f ms", t_prompt_processing + t_token_generation);
  234. LOG_DEBUG(buffer, {
  235. {"slot_id", id},
  236. {"task_id", task_id},
  237. {"t_prompt_processing", t_prompt_processing},
  238. {"t_token_generation", t_token_generation},
  239. {"t_total", t_prompt_processing + t_token_generation},
  240. });
  241. }
  242. };
  243. struct server_metrics {
  244. uint64_t n_prompt_tokens_processed_total = 0;
  245. uint64_t n_tokens_predicted_total = 0;
  246. uint64_t n_prompt_tokens_processed = 0;
  247. uint64_t t_prompt_processing = 0;
  248. uint64_t n_tokens_predicted = 0;
  249. uint64_t t_tokens_generation = 0;
  250. void on_prompt_eval(const server_slot &slot) {
  251. n_prompt_tokens_processed_total += slot.n_prompt_tokens_processed;
  252. n_prompt_tokens_processed += slot.n_prompt_tokens_processed;
  253. t_prompt_processing += slot.t_prompt_processing;
  254. }
  255. void on_prediction(const server_slot &slot) {
  256. n_tokens_predicted_total += slot.n_decoded;
  257. n_tokens_predicted += slot.n_decoded;
  258. t_tokens_generation += slot.t_token_generation;
  259. }
  260. void reset_bucket() {
  261. n_prompt_tokens_processed = 0;
  262. t_prompt_processing = 0;
  263. n_tokens_predicted = 0;
  264. t_tokens_generation = 0;
  265. }
  266. };
  267. struct llama_server_context
  268. {
  269. llama_model *model = nullptr;
  270. float modelProgress = 0.0;
  271. llama_context *ctx = nullptr;
  272. clip_ctx *clp_ctx = nullptr;
  273. gpt_params params;
  274. llama_batch batch;
  275. bool multimodal = false;
  276. bool clean_kv_cache = true;
  277. bool all_slots_are_idle = false;
  278. bool add_bos_token = true;
  279. int32_t n_ctx; // total context for all clients / slots
  280. // system prompt
  281. bool system_need_update = false;
  282. std::string system_prompt;
  283. std::vector<llama_token> system_tokens;
  284. std::string name_user; // this should be the antiprompt
  285. std::string name_assistant;
  286. // slots / clients
  287. std::vector<server_slot> slots;
  288. llama_server_queue queue_tasks;
  289. llama_server_response queue_results;
  290. server_metrics metrics;
  291. ~llama_server_context()
  292. {
  293. if (clp_ctx)
  294. {
  295. LOG_DEBUG("freeing clip model", {});
  296. clip_free(clp_ctx);
  297. clp_ctx = nullptr;
  298. }
  299. if (ctx)
  300. {
  301. llama_free(ctx);
  302. ctx = nullptr;
  303. }
  304. if (model)
  305. {
  306. llama_free_model(model);
  307. model = nullptr;
  308. }
  309. }
  310. bool load_model(const gpt_params &params_)
  311. {
  312. params = params_;
  313. if (!params.mmproj.empty()) {
  314. multimodal = true;
  315. LOG_DEBUG("Multi Modal Mode Enabled", {});
  316. clp_ctx = clip_model_load(params.mmproj.c_str(), /*verbosity=*/ 1);
  317. if(clp_ctx == nullptr) {
  318. LOG_ERROR("unable to load clip model", {{"model", params.mmproj}});
  319. return false;
  320. }
  321. if (params.n_ctx < 2048) { // request larger context for the image embedding
  322. params.n_ctx = 2048;
  323. }
  324. }
  325. auto init_result = llama_init_from_gpt_params(params);
  326. model = init_result.model;
  327. ctx = init_result.context;
  328. if (model == nullptr)
  329. {
  330. LOG_ERROR("unable to load model", {{"model", params.model}});
  331. return false;
  332. }
  333. if (multimodal) {
  334. const int n_embd_clip = clip_n_mmproj_embd(clp_ctx);
  335. const int n_embd_llm = llama_n_embd(model);
  336. if (n_embd_clip != n_embd_llm) {
  337. LOG_TEE("%s: embedding dim of the multimodal projector (%d) is not equal to that of LLaMA (%d). Make sure that you use the correct mmproj file.\n", __func__, n_embd_clip, n_embd_llm);
  338. llama_free(ctx);
  339. llama_free_model(model);
  340. return false;
  341. }
  342. }
  343. n_ctx = llama_n_ctx(ctx);
  344. add_bos_token = llama_should_add_bos_token(model);
  345. return true;
  346. }
  347. void initialize() {
  348. // create slots
  349. all_slots_are_idle = true;
  350. const int32_t n_ctx_slot = n_ctx / params.n_parallel;
  351. LOG_DEBUG("initializing slots", {{"n_slots", params.n_parallel}});
  352. for (int i = 0; i < params.n_parallel; i++)
  353. {
  354. server_slot slot;
  355. slot.id = i;
  356. slot.n_ctx = n_ctx_slot;
  357. slot.n_predict = params.n_predict;
  358. LOG_DEBUG("new slot", {
  359. {"slot_id", slot.id},
  360. {"n_ctx_slot", slot.n_ctx}
  361. });
  362. const int ga_n = params.grp_attn_n;
  363. const int ga_w = params.grp_attn_w;
  364. if (ga_n != 1) {
  365. GGML_ASSERT(ga_n > 0 && "ga_n must be positive"); // NOLINT
  366. GGML_ASSERT(ga_w % ga_n == 0 && "ga_w must be a multiple of ga_n"); // NOLINT
  367. //GGML_ASSERT(n_ctx_train % ga_w == 0 && "n_ctx_train must be a multiple of ga_w"); // NOLINT
  368. //GGML_ASSERT(n_ctx >= n_ctx_train * ga_n && "n_ctx must be at least n_ctx_train * ga_n"); // NOLINT
  369. LOG_DEBUG("slot self-extend", {
  370. {"slot_id", slot.id},
  371. {"ga_n", ga_n},
  372. {"ga_w", ga_w}
  373. });
  374. }
  375. slot.ga_i = 0;
  376. slot.ga_n = ga_n;
  377. slot.ga_w = ga_w;
  378. slot.reset();
  379. slots.push_back(slot);
  380. }
  381. batch = llama_batch_init(n_ctx, 0, params.n_parallel);
  382. }
  383. std::vector<llama_token> tokenize(const json & json_prompt, bool add_bos) const
  384. {
  385. // TODO: currently, we tokenize using special tokens by default
  386. // this is not always correct (see https://github.com/ggerganov/llama.cpp/pull/4160#issuecomment-1824826216)
  387. // but it's better compared to completely ignoring ChatML and other chat templates
  388. const bool TMP_FORCE_SPECIAL = true;
  389. // If `add_bos` is true, we only add BOS, when json_prompt is a string,
  390. // or the first element of the json_prompt array is a string.
  391. std::vector<llama_token> prompt_tokens;
  392. if (json_prompt.is_array())
  393. {
  394. bool first = true;
  395. for (const auto& p : json_prompt)
  396. {
  397. if (p.is_string())
  398. {
  399. auto s = p.template get<std::string>();
  400. std::vector<llama_token> p;
  401. if (first)
  402. {
  403. p = ::llama_tokenize(ctx, s, add_bos, TMP_FORCE_SPECIAL);
  404. first = false;
  405. }
  406. else
  407. {
  408. p = ::llama_tokenize(ctx, s, false, TMP_FORCE_SPECIAL);
  409. }
  410. prompt_tokens.insert(prompt_tokens.end(), p.begin(), p.end());
  411. }
  412. else
  413. {
  414. if (first)
  415. {
  416. first = false;
  417. }
  418. prompt_tokens.push_back(p.template get<llama_token>());
  419. }
  420. }
  421. }
  422. else
  423. {
  424. auto s = json_prompt.template get<std::string>();
  425. prompt_tokens = ::llama_tokenize(ctx, s, add_bos, TMP_FORCE_SPECIAL);
  426. }
  427. return prompt_tokens;
  428. }
  429. server_slot* get_slot(int id) {
  430. int64_t t_last = ggml_time_us();
  431. server_slot *last_used = nullptr;
  432. for (server_slot & slot : slots)
  433. {
  434. if (slot.id == id && slot.available())
  435. {
  436. return &slot;
  437. }
  438. if (slot.available() && slot.t_last_used < t_last)
  439. {
  440. last_used = &slot;
  441. t_last = slot.t_last_used;
  442. }
  443. }
  444. return last_used;
  445. }
  446. bool launch_slot_with_data(server_slot* &slot, json data) {
  447. slot_params default_params;
  448. llama_sampling_params default_sparams;
  449. slot->params.stream = json_value(data, "stream", false);
  450. slot->params.cache_prompt = json_value(data, "cache_prompt", false);
  451. slot->params.n_predict = json_value(data, "n_predict", default_params.n_predict);
  452. slot->sparams.top_k = json_value(data, "top_k", default_sparams.top_k);
  453. slot->sparams.top_p = json_value(data, "top_p", default_sparams.top_p);
  454. slot->sparams.min_p = json_value(data, "min_p", default_sparams.min_p);
  455. slot->sparams.tfs_z = json_value(data, "tfs_z", default_sparams.tfs_z);
  456. slot->sparams.typical_p = json_value(data, "typical_p", default_sparams.typical_p);
  457. slot->sparams.temp = json_value(data, "temperature", default_sparams.temp);
  458. slot->sparams.dynatemp_range = json_value(data, "dynatemp_range", default_sparams.dynatemp_range);
  459. slot->sparams.dynatemp_exponent = json_value(data, "dynatemp_exponent", default_sparams.dynatemp_exponent);
  460. slot->sparams.penalty_last_n = json_value(data, "repeat_last_n", default_sparams.penalty_last_n);
  461. slot->sparams.penalty_repeat = json_value(data, "repeat_penalty", default_sparams.penalty_repeat);
  462. slot->sparams.penalty_freq = json_value(data, "frequency_penalty", default_sparams.penalty_freq);
  463. slot->sparams.penalty_present = json_value(data, "presence_penalty", default_sparams.penalty_present);
  464. slot->sparams.mirostat = json_value(data, "mirostat", default_sparams.mirostat);
  465. slot->sparams.mirostat_tau = json_value(data, "mirostat_tau", default_sparams.mirostat_tau);
  466. slot->sparams.mirostat_eta = json_value(data, "mirostat_eta", default_sparams.mirostat_eta);
  467. slot->sparams.penalize_nl = json_value(data, "penalize_nl", default_sparams.penalize_nl);
  468. slot->params.n_keep = json_value(data, "n_keep", slot->params.n_keep);
  469. slot->sparams.seed = json_value(data, "seed", default_params.seed);
  470. slot->sparams.grammar = json_value(data, "grammar", default_sparams.grammar);
  471. slot->sparams.n_probs = json_value(data, "n_probs", default_sparams.n_probs);
  472. slot->sparams.min_keep = json_value(data, "min_keep", default_sparams.min_keep);
  473. if (slot->n_predict > 0 && slot->params.n_predict > slot->n_predict) {
  474. // Might be better to reject the request with a 400 ?
  475. LOG_WARNING("Max tokens to predict exceeds server configuration", {
  476. {"params.n_predict", slot->params.n_predict},
  477. {"slot.n_predict", slot->n_predict},
  478. });
  479. slot->params.n_predict = slot->n_predict;
  480. }
  481. if (data.count("input_suffix") != 0)
  482. {
  483. slot->params.input_suffix = data["input_suffix"];
  484. }
  485. else
  486. {
  487. slot->params.input_suffix = "";
  488. }
  489. if (data.count("prompt") != 0)
  490. {
  491. slot->prompt = data["prompt"];
  492. }
  493. else
  494. {
  495. slot->prompt = "";
  496. }
  497. slot->sparams.penalty_prompt_tokens.clear();
  498. slot->sparams.use_penalty_prompt_tokens = false;
  499. const auto &penalty_prompt = data.find("penalty_prompt");
  500. if (penalty_prompt != data.end())
  501. {
  502. if (penalty_prompt->is_string())
  503. {
  504. const auto penalty_prompt_string = penalty_prompt->get<std::string>();
  505. auto penalty_tokens = llama_tokenize(model, penalty_prompt_string, false);
  506. slot->sparams.penalty_prompt_tokens.swap(penalty_tokens);
  507. if (slot->params.n_predict > 0)
  508. {
  509. slot->sparams.penalty_prompt_tokens.reserve(slot->sparams.penalty_prompt_tokens.size() + slot->params.n_predict);
  510. }
  511. slot->sparams.use_penalty_prompt_tokens = true;
  512. }
  513. else if (penalty_prompt->is_array())
  514. {
  515. const auto n_tokens = penalty_prompt->size();
  516. slot->sparams.penalty_prompt_tokens.reserve(n_tokens + std::max(0, slot->params.n_predict));
  517. const int n_vocab = llama_n_vocab(model);
  518. for (const auto &penalty_token : *penalty_prompt)
  519. {
  520. if (penalty_token.is_number_integer())
  521. {
  522. const auto tok = penalty_token.get<llama_token>();
  523. if (tok >= 0 && tok < n_vocab)
  524. {
  525. slot->sparams.penalty_prompt_tokens.push_back(tok);
  526. }
  527. }
  528. }
  529. slot->sparams.use_penalty_prompt_tokens = true;
  530. }
  531. }
  532. slot->sparams.logit_bias.clear();
  533. if (json_value(data, "ignore_eos", false))
  534. {
  535. slot->sparams.logit_bias[llama_token_eos(model)] = -INFINITY;
  536. }
  537. const auto &logit_bias = data.find("logit_bias");
  538. if (logit_bias != data.end() && logit_bias->is_array())
  539. {
  540. const int n_vocab = llama_n_vocab(model);
  541. for (const auto &el : *logit_bias)
  542. {
  543. if (el.is_array() && el.size() == 2)
  544. {
  545. float bias;
  546. if (el[1].is_number())
  547. {
  548. bias = el[1].get<float>();
  549. }
  550. else if (el[1].is_boolean() && !el[1].get<bool>())
  551. {
  552. bias = -INFINITY;
  553. }
  554. else
  555. {
  556. continue;
  557. }
  558. if (el[0].is_number_integer())
  559. {
  560. llama_token tok = el[0].get<llama_token>();
  561. if (tok >= 0 && tok < n_vocab)
  562. {
  563. slot->sparams.logit_bias[tok] = bias;
  564. }
  565. }
  566. else if (el[0].is_string())
  567. {
  568. auto toks = llama_tokenize(model, el[0].get<std::string>(), false);
  569. for (auto tok : toks)
  570. {
  571. slot->sparams.logit_bias[tok] = bias;
  572. }
  573. }
  574. }
  575. }
  576. }
  577. slot->params.antiprompt.clear();
  578. const auto &stop = data.find("stop");
  579. if (stop != data.end() && stop->is_array())
  580. {
  581. for (const auto &word : *stop)
  582. {
  583. if (!word.empty())
  584. {
  585. slot->params.antiprompt.push_back(word);
  586. }
  587. }
  588. }
  589. const auto &samplers_sequence = data.find("samplers");
  590. if (samplers_sequence != data.end() && samplers_sequence->is_array())
  591. {
  592. std::vector<std::string> sampler_names;
  593. for (const auto &sampler_name : *samplers_sequence)
  594. {
  595. if (sampler_name.is_string())
  596. {
  597. sampler_names.emplace_back(sampler_name);
  598. }
  599. }
  600. slot->sparams.samplers_sequence = llama_sampling_types_from_names(sampler_names, false);
  601. }
  602. else
  603. {
  604. slot->sparams.samplers_sequence = default_sparams.samplers_sequence;
  605. }
  606. if (multimodal)
  607. {
  608. const auto &images_data = data.find("image_data");
  609. if (images_data != data.end() && images_data->is_array())
  610. {
  611. for (const auto &img : *images_data)
  612. {
  613. const std::vector<uint8_t> image_buffer = base64_decode(img["data"].get<std::string>());
  614. slot_image img_sl;
  615. img_sl.id = img.count("id") != 0 ? img["id"].get<int>() : slot->images.size();
  616. img_sl.img_data = clip_image_u8_init();
  617. if (!clip_image_load_from_bytes(image_buffer.data(), image_buffer.size(), img_sl.img_data))
  618. {
  619. LOG_ERROR("failed to load image", {
  620. {"slot_id", slot->id},
  621. {"img_sl_id", img_sl.id}
  622. });
  623. return false;
  624. }
  625. LOG_VERBOSE("image loaded", {
  626. {"slot_id", slot->id},
  627. {"img_sl_id", img_sl.id}
  628. });
  629. img_sl.request_encode_image = true;
  630. slot->images.push_back(img_sl);
  631. }
  632. // process prompt
  633. // example: system prompt [img-102] user [img-103] describe [img-134] -> [{id: 102, prefix: 'system prompt '}, {id: 103, prefix: ' user '}, {id: 134, prefix: ' describe '}]}
  634. if (slot->images.size() > 0 && !slot->prompt.is_array())
  635. {
  636. std::string prompt = slot->prompt.get<std::string>();
  637. size_t pos = 0, begin_prefix = 0;
  638. std::string pattern = "[img-";
  639. while ((pos = prompt.find(pattern, pos)) != std::string::npos) {
  640. size_t end_prefix = pos;
  641. pos += pattern.length();
  642. size_t end_pos = prompt.find(']', pos);
  643. if (end_pos != std::string::npos)
  644. {
  645. std::string image_id = prompt.substr(pos, end_pos - pos);
  646. try
  647. {
  648. int img_id = std::stoi(image_id);
  649. bool found = false;
  650. for (slot_image &img : slot->images)
  651. {
  652. if (img.id == img_id) {
  653. found = true;
  654. img.prefix_prompt = prompt.substr(begin_prefix, end_prefix - begin_prefix);
  655. begin_prefix = end_pos + 1;
  656. break;
  657. }
  658. }
  659. if (!found) {
  660. LOG_TEE("ERROR: Image with id: %i, not found.\n", img_id);
  661. slot->images.clear();
  662. return false;
  663. }
  664. } catch (const std::invalid_argument& e) {
  665. LOG_TEE("Invalid image number id in prompt\n");
  666. slot->images.clear();
  667. return false;
  668. }
  669. }
  670. }
  671. slot->prompt = "";
  672. slot->params.input_suffix = prompt.substr(begin_prefix);
  673. slot->params.cache_prompt = false; // multimodal doesn't support cache prompt
  674. }
  675. }
  676. }
  677. if (slot->ctx_sampling != nullptr)
  678. {
  679. llama_sampling_free(slot->ctx_sampling);
  680. }
  681. slot->ctx_sampling = llama_sampling_init(slot->sparams);
  682. slot->command = LOAD_PROMPT;
  683. all_slots_are_idle = false;
  684. LOG_DEBUG("slot is processing task", {
  685. {"slot_id", slot->id},
  686. {"task_id", slot->task_id},
  687. });
  688. return true;
  689. }
  690. void kv_cache_clear() {
  691. // clear the entire KV cache
  692. llama_kv_cache_clear(ctx);
  693. clean_kv_cache = false;
  694. }
  695. void system_prompt_update() {
  696. kv_cache_clear();
  697. system_tokens.clear();
  698. if (!system_prompt.empty()) {
  699. system_tokens = ::llama_tokenize(ctx, system_prompt, true);
  700. llama_batch_clear(batch);
  701. for (int i = 0; i < (int)system_tokens.size(); ++i)
  702. {
  703. llama_batch_add(batch, system_tokens[i], i, { 0 }, false);
  704. }
  705. for (int32_t i = 0; i < (int32_t) batch.n_tokens; i += params.n_batch)
  706. {
  707. const int32_t n_tokens = std::min(params.n_batch, (int32_t) (batch.n_tokens - i));
  708. llama_batch batch_view = {
  709. n_tokens,
  710. batch.token + i,
  711. nullptr,
  712. batch.pos + i,
  713. batch.n_seq_id + i,
  714. batch.seq_id + i,
  715. batch.logits + i,
  716. 0, 0, 0, // unused
  717. };
  718. if (llama_decode(ctx, batch_view) != 0)
  719. {
  720. LOG_TEE("%s: llama_decode() failed\n", __func__);
  721. return;
  722. }
  723. }
  724. // assign the system KV cache to all parallel sequences
  725. for (int32_t i = 1; i < params.n_parallel; ++i)
  726. {
  727. llama_kv_cache_seq_cp(ctx, 0, i, 0, system_tokens.size());
  728. }
  729. }
  730. LOG_TEE("system prompt updated\n");
  731. system_need_update = false;
  732. }
  733. void system_prompt_notify() {
  734. // release all slots
  735. for (server_slot &slot : slots)
  736. {
  737. slot.release();
  738. }
  739. system_need_update = true;
  740. }
  741. static size_t find_stopping_strings(const std::string &text, const size_t last_token_size,
  742. const stop_type type, server_slot &slot)
  743. {
  744. size_t stop_pos = std::string::npos;
  745. for (const std::string &word : slot.params.antiprompt)
  746. {
  747. size_t pos;
  748. if (type == STOP_FULL)
  749. {
  750. const size_t tmp = word.size() + last_token_size;
  751. const size_t from_pos = text.size() > tmp ? text.size() - tmp : 0;
  752. pos = text.find(word, from_pos);
  753. }
  754. else
  755. {
  756. pos = find_partial_stop_string(word, text);
  757. }
  758. if (pos != std::string::npos &&
  759. (stop_pos == std::string::npos || pos < stop_pos))
  760. {
  761. if (type == STOP_FULL)
  762. {
  763. slot.stopped_word = true;
  764. slot.stopping_word = word;
  765. slot.has_next_token = false;
  766. }
  767. stop_pos = pos;
  768. }
  769. }
  770. return stop_pos;
  771. }
  772. bool process_token(completion_token_output &result, server_slot &slot) {
  773. // remember which tokens were sampled - used for repetition penalties during sampling
  774. const std::string token_str = llama_token_to_piece(ctx, result.tok);
  775. slot.sampled = result.tok;
  776. // search stop word and delete it
  777. slot.generated_text += token_str;
  778. slot.has_next_token = true;
  779. if (slot.ctx_sampling->params.use_penalty_prompt_tokens && result.tok != -1)
  780. {
  781. // we can change penalty_prompt_tokens because it is always created from scratch each request
  782. slot.ctx_sampling->params.penalty_prompt_tokens.push_back(result.tok);
  783. }
  784. // check if there is incomplete UTF-8 character at the end
  785. bool incomplete = false;
  786. for (unsigned i = 1; i < 5 && i <= slot.generated_text.size(); ++i)
  787. {
  788. unsigned char c = slot.generated_text[slot.generated_text.size() - i];
  789. if ((c & 0xC0) == 0x80)
  790. {
  791. // continuation byte: 10xxxxxx
  792. continue;
  793. }
  794. if ((c & 0xE0) == 0xC0)
  795. {
  796. // 2-byte character: 110xxxxx ...
  797. incomplete = i < 2;
  798. }
  799. else if ((c & 0xF0) == 0xE0)
  800. {
  801. // 3-byte character: 1110xxxx ...
  802. incomplete = i < 3;
  803. }
  804. else if ((c & 0xF8) == 0xF0)
  805. {
  806. // 4-byte character: 11110xxx ...
  807. incomplete = i < 4;
  808. }
  809. // else 1-byte character or invalid byte
  810. break;
  811. }
  812. if (!incomplete)
  813. {
  814. size_t pos = std::min(slot.n_sent_text, slot.generated_text.size());
  815. const std::string str_test = slot.generated_text.substr(pos);
  816. bool is_stop_full = false;
  817. size_t stop_pos = find_stopping_strings(str_test, token_str.size(), STOP_FULL, slot);
  818. if (stop_pos != std::string::npos)
  819. {
  820. is_stop_full = true;
  821. slot.generated_text.erase(
  822. slot.generated_text.begin() + pos + stop_pos,
  823. slot.generated_text.end());
  824. pos = std::min(slot.n_sent_text, slot.generated_text.size());
  825. }
  826. else
  827. {
  828. is_stop_full = false;
  829. stop_pos = find_stopping_strings(str_test, token_str.size(), STOP_PARTIAL, slot);
  830. }
  831. // check if there is any token to predict
  832. if (stop_pos == std::string::npos || (!slot.has_next_token && !is_stop_full && stop_pos > 0))
  833. {
  834. // no send the stop word in the response
  835. result.text_to_send = slot.generated_text.substr(pos, std::string::npos);
  836. slot.n_sent_text += result.text_to_send.size();
  837. // add the token to slot queue and cache
  838. }
  839. if (slot.params.stream)
  840. {
  841. send_partial_response(slot, result);
  842. }
  843. }
  844. slot.add_token_string(result);
  845. if (incomplete)
  846. {
  847. slot.has_next_token = true;
  848. }
  849. // check the limits
  850. if (slot.n_decoded > 0 && slot.has_next_token && !slot.has_budget(params))
  851. {
  852. slot.stopped_limit = true;
  853. slot.has_next_token = false;
  854. }
  855. if (!slot.cache_tokens.empty() && llama_token_is_eog(model, result.tok))
  856. {
  857. slot.stopped_eos = true;
  858. slot.has_next_token = false;
  859. LOG_VERBOSE("eos token found", {});
  860. }
  861. LOG_VERBOSE("next token", {
  862. {"token", result.tok},
  863. {"token_text", tokens_to_output_formatted_string(ctx, result.tok)},
  864. {"has_next_token", slot.has_next_token},
  865. {"n_remain", slot.n_remaining},
  866. {"num_tokens_predicted", slot.n_decoded},
  867. {"stopped_eos", slot.stopped_eos},
  868. {"stopped_word", slot.stopped_word},
  869. {"stopped_limit", slot.stopped_limit},
  870. {"stopping_word", slot.stopping_word},
  871. });
  872. return slot.has_next_token; // continue
  873. }
  874. bool process_images(server_slot &slot) const
  875. {
  876. for (slot_image &img : slot.images)
  877. {
  878. if (!img.request_encode_image)
  879. {
  880. continue;
  881. }
  882. if (!llava_image_embed_make_with_clip_img(clp_ctx, params.n_threads, img.img_data, &img.image_embedding, &img.image_tokens)) {
  883. LOG_TEE("Error processing the given image");
  884. return false;
  885. }
  886. img.request_encode_image = false;
  887. }
  888. return slot.images.size() > 0;
  889. }
  890. void send_error(task_server& task, const std::string &error)
  891. {
  892. LOG_TEE("task %i - error: %s\n", task.id, error.c_str());
  893. task_result res;
  894. res.id = task.id;
  895. res.multitask_id = task.multitask_id;
  896. res.stop = false;
  897. res.error = true;
  898. res.result_json = { { "content", error } };
  899. queue_results.send(res);
  900. }
  901. json get_formated_generation(server_slot &slot)
  902. {
  903. const auto eos_bias = slot.sparams.logit_bias.find(llama_token_eos(model));
  904. const bool ignore_eos = eos_bias != slot.sparams.logit_bias.end() &&
  905. eos_bias->second < 0.0f && std::isinf(eos_bias->second);
  906. std::vector<std::string> samplers_sequence;
  907. for (const auto &sampler_type : slot.sparams.samplers_sequence)
  908. {
  909. samplers_sequence.emplace_back(llama_sampling_type_to_str(sampler_type));
  910. }
  911. return json {
  912. {"n_ctx", slot.n_ctx},
  913. {"n_predict", slot.n_predict},
  914. {"model", params.model_alias},
  915. {"seed", slot.params.seed},
  916. {"temperature", slot.sparams.temp},
  917. {"dynatemp_range", slot.sparams.dynatemp_range},
  918. {"dynatemp_exponent", slot.sparams.dynatemp_exponent},
  919. {"top_k", slot.sparams.top_k},
  920. {"top_p", slot.sparams.top_p},
  921. {"min_p", slot.sparams.min_p},
  922. {"tfs_z", slot.sparams.tfs_z},
  923. {"typical_p", slot.sparams.typical_p},
  924. {"repeat_last_n", slot.sparams.penalty_last_n},
  925. {"repeat_penalty", slot.sparams.penalty_repeat},
  926. {"presence_penalty", slot.sparams.penalty_present},
  927. {"frequency_penalty", slot.sparams.penalty_freq},
  928. {"penalty_prompt_tokens", slot.sparams.penalty_prompt_tokens},
  929. {"use_penalty_prompt_tokens", slot.sparams.use_penalty_prompt_tokens},
  930. {"mirostat", slot.sparams.mirostat},
  931. {"mirostat_tau", slot.sparams.mirostat_tau},
  932. {"mirostat_eta", slot.sparams.mirostat_eta},
  933. {"penalize_nl", slot.sparams.penalize_nl},
  934. {"stop", slot.params.antiprompt},
  935. {"n_predict", slot.params.n_predict},
  936. {"n_keep", params.n_keep},
  937. {"ignore_eos", ignore_eos},
  938. {"stream", slot.params.stream},
  939. {"logit_bias", slot.sparams.logit_bias},
  940. {"n_probs", slot.sparams.n_probs},
  941. {"min_keep", slot.sparams.min_keep},
  942. {"grammar", slot.sparams.grammar},
  943. {"samplers", samplers_sequence}
  944. };
  945. }
  946. void send_partial_response(server_slot &slot, completion_token_output tkn)
  947. {
  948. task_result res;
  949. res.id = slot.task_id;
  950. res.multitask_id = slot.multitask_id;
  951. res.error = false;
  952. res.stop = false;
  953. res.result_json = json
  954. {
  955. {"stop", false},
  956. {"slot_id", slot.id},
  957. {"multimodal", multimodal}
  958. };
  959. if (!llama_token_is_eog(model, tkn.tok)) {
  960. res.result_json["content"] = tkn.text_to_send;
  961. }
  962. if (slot.sparams.n_probs > 0)
  963. {
  964. std::vector<completion_token_output> probs_output = {};
  965. const std::vector<llama_token> to_send_toks = llama_tokenize(ctx, tkn.text_to_send, false);
  966. size_t probs_pos = std::min(slot.n_sent_token_probs, slot.generated_token_probs.size());
  967. size_t probs_stop_pos = std::min(slot.n_sent_token_probs + to_send_toks.size(), slot.generated_token_probs.size());
  968. if (probs_pos < probs_stop_pos)
  969. {
  970. probs_output = std::vector<completion_token_output>(slot.generated_token_probs.begin() + probs_pos, slot.generated_token_probs.begin() + probs_stop_pos);
  971. }
  972. slot.n_sent_token_probs = probs_stop_pos;
  973. res.result_json["completion_probabilities"] = probs_vector_to_json(ctx, probs_output);
  974. }
  975. queue_results.send(res);
  976. }
  977. void send_final_response(server_slot &slot)
  978. {
  979. task_result res;
  980. res.id = slot.task_id;
  981. res.multitask_id = slot.multitask_id;
  982. res.error = false;
  983. res.stop = true;
  984. res.result_json = json
  985. {
  986. {"content", !slot.params.stream ? slot.generated_text : ""},
  987. {"slot_id", slot.id},
  988. {"stop", true},
  989. {"model", params.model_alias},
  990. {"tokens_predicted", slot.n_decoded},
  991. {"tokens_evaluated", slot.n_prompt_tokens},
  992. {"truncated", slot.truncated},
  993. {"stopped_eos", slot.stopped_eos},
  994. {"stopped_word", slot.stopped_word},
  995. {"stopped_limit", slot.stopped_limit},
  996. {"stopping_word", slot.stopping_word},
  997. {"tokens_cached", slot.n_past},
  998. {"timings", slot.get_formated_timings()}
  999. };
  1000. if (slot.sparams.n_probs > 0)
  1001. {
  1002. std::vector<completion_token_output> probs = {};
  1003. if (!slot.params.stream && slot.stopped_word)
  1004. {
  1005. const std::vector<llama_token> stop_word_toks = llama_tokenize(ctx, slot.stopping_word, false);
  1006. probs = std::vector<completion_token_output>(slot.generated_token_probs.begin(), slot.generated_token_probs.end() - stop_word_toks.size());
  1007. }
  1008. else
  1009. {
  1010. probs = std::vector<completion_token_output>(
  1011. slot.generated_token_probs.begin(),
  1012. slot.generated_token_probs.end());
  1013. }
  1014. res.result_json["completion_probabilities"] = probs_vector_to_json(ctx, probs);
  1015. }
  1016. queue_results.send(res);
  1017. }
  1018. void send_embedding(server_slot & slot, const llama_batch & batch)
  1019. {
  1020. task_result res;
  1021. res.id = slot.task_id;
  1022. res.multitask_id = slot.multitask_id;
  1023. res.error = false;
  1024. res.stop = true;
  1025. const int n_embd = llama_n_embd(model);
  1026. if (!params.embedding)
  1027. {
  1028. LOG_WARNING("embedding disabled", {{"params.embedding", params.embedding}});
  1029. res.result_json = json
  1030. {
  1031. {"embedding", std::vector<float>(n_embd, 0.0f)},
  1032. };
  1033. }
  1034. else
  1035. {
  1036. for (int i = 0; i < batch.n_tokens; ++i) {
  1037. if (!batch.logits[i] || batch.seq_id[i][0] != slot.id) {
  1038. continue;
  1039. }
  1040. const float * embd = llama_get_embeddings_seq(ctx, batch.seq_id[i][0]);
  1041. if (embd == NULL) {
  1042. embd = llama_get_embeddings_ith(ctx, i);
  1043. if (embd == NULL) {
  1044. LOG_ERROR("failed to get embeddings for token", {{"token", batch.token[i]}, {"seq_id", batch.seq_id[i][0]}});
  1045. res.result_json = json
  1046. {
  1047. {"embedding", std::vector<float>(n_embd, 0.0f)},
  1048. };
  1049. continue;
  1050. }
  1051. }
  1052. res.result_json = json
  1053. {
  1054. {"embedding", std::vector<float>(embd, embd + n_embd)},
  1055. };
  1056. }
  1057. }
  1058. queue_results.send(res);
  1059. }
  1060. void request_completion(int task_id, json data, bool embedding, int multitask_id)
  1061. {
  1062. task_server task;
  1063. task.id = task_id;
  1064. task.target_id = 0;
  1065. task.data = std::move(data);
  1066. task.embedding_mode = embedding;
  1067. task.type = TASK_TYPE_COMPLETION;
  1068. task.multitask_id = multitask_id;
  1069. // when a completion task's prompt array is not a singleton, we split it into multiple requests
  1070. // otherwise, it's a single-prompt task, we actually queue it
  1071. // if there's numbers in the prompt array it will be treated as an array of tokens
  1072. if (task.data.count("prompt") != 0 && task.data.at("prompt").size() > 1) {
  1073. bool numbers = false;
  1074. for (const auto& e : task.data.at("prompt")) {
  1075. if (e.is_number()) {
  1076. numbers = true;
  1077. break;
  1078. }
  1079. }
  1080. // NOTE: split_multiprompt_task() does not handle a mix of strings and numbers,
  1081. // it will completely stall the server. I don't know where the bug for this is.
  1082. //
  1083. // if there are numbers, it needs to be treated like a single prompt,
  1084. // queue_tasks handles a mix of strings and numbers just fine.
  1085. if (numbers) {
  1086. queue_tasks.post(task);
  1087. } else {
  1088. split_multiprompt_task(task_id, task);
  1089. }
  1090. } else {
  1091. // an empty prompt can make slot become buggy
  1092. if (task.data.contains("prompt") && task.data["prompt"].is_string() && task.data["prompt"].get<std::string>().empty()) {
  1093. task.data["prompt"] = " "; // add a space so that we have one token
  1094. }
  1095. queue_tasks.post(task);
  1096. }
  1097. }
  1098. // for multiple images processing
  1099. bool ingest_images(server_slot &slot, int n_batch)
  1100. {
  1101. int image_idx = 0;
  1102. while (image_idx < (int) slot.images.size())
  1103. {
  1104. slot_image &img = slot.images[image_idx];
  1105. // process prefix prompt
  1106. for (int32_t i = 0; i < (int32_t) batch.n_tokens; i += n_batch)
  1107. {
  1108. const int32_t n_tokens = std::min(n_batch, (int32_t) (batch.n_tokens - i));
  1109. llama_batch batch_view = {
  1110. n_tokens,
  1111. batch.token + i,
  1112. nullptr,
  1113. batch.pos + i,
  1114. batch.n_seq_id + i,
  1115. batch.seq_id + i,
  1116. batch.logits + i,
  1117. 0, 0, 0, // unused
  1118. };
  1119. if (llama_decode(ctx, batch_view))
  1120. {
  1121. LOG_TEE("%s : failed to eval\n", __func__);
  1122. return false;
  1123. }
  1124. }
  1125. // process image with llm
  1126. for (int i = 0; i < img.image_tokens; i += n_batch)
  1127. {
  1128. int n_eval = img.image_tokens - i;
  1129. if (n_eval > n_batch)
  1130. {
  1131. n_eval = n_batch;
  1132. }
  1133. const int n_embd = llama_n_embd(model);
  1134. llama_batch batch_img = {
  1135. n_eval,
  1136. nullptr,
  1137. (img.image_embedding + i * n_embd),
  1138. nullptr,
  1139. nullptr,
  1140. nullptr,
  1141. nullptr,
  1142. slot.n_past,
  1143. 1, 0
  1144. };
  1145. if (llama_decode(ctx, batch_img))
  1146. {
  1147. LOG_TEE("%s : failed to eval image\n", __func__);
  1148. return false;
  1149. }
  1150. slot.n_past += n_eval;
  1151. }
  1152. image_idx++;
  1153. llama_batch_clear(batch);
  1154. // append prefix of next image
  1155. const auto json_prompt = (image_idx >= (int) slot.images.size()) ?
  1156. slot.params.input_suffix : // no more images, then process suffix prompt
  1157. (json)(slot.images[image_idx].prefix_prompt);
  1158. std::vector<llama_token> append_tokens = tokenize(json_prompt, false); // has next image
  1159. for (int i = 0; i < (int) append_tokens.size(); ++i)
  1160. {
  1161. llama_batch_add(batch, append_tokens[i], system_tokens.size() + slot.n_past, { slot.id }, true);
  1162. slot.n_past += 1;
  1163. }
  1164. }
  1165. return true;
  1166. }
  1167. void request_cancel(int task_id)
  1168. {
  1169. task_server task;
  1170. task.type = TASK_TYPE_CANCEL;
  1171. task.target_id = task_id;
  1172. queue_tasks.post(task);
  1173. }
  1174. void split_multiprompt_task(int multitask_id, task_server& multiprompt_task)
  1175. {
  1176. int prompt_count = multiprompt_task.data.at("prompt").size();
  1177. if (prompt_count <= 1) {
  1178. send_error(multiprompt_task, "error while handling multiple prompts");
  1179. return;
  1180. }
  1181. // generate all the ID for subtask
  1182. std::vector<int> subtask_ids(prompt_count);
  1183. for (int i = 0; i < prompt_count; i++)
  1184. {
  1185. subtask_ids[i] = queue_tasks.get_new_id();
  1186. }
  1187. // queue up the multitask so we can track its subtask progression
  1188. queue_tasks.add_multitask(multitask_id, subtask_ids);
  1189. // add subtasks
  1190. for (int i = 0; i < prompt_count; i++)
  1191. {
  1192. json subtask_data = multiprompt_task.data;
  1193. subtask_data["prompt"] = subtask_data["prompt"][i];
  1194. // subtasks inherit everything else (embedding mode, etc.)
  1195. request_completion(subtask_ids[i], subtask_data, multiprompt_task.embedding_mode, multitask_id);
  1196. }
  1197. }
  1198. std::string common_prefix(const std::string& str1, const std::string& str2) {
  1199. auto mismatch_pair = std::mismatch(str1.begin(), str1.end(), str2.begin());
  1200. return std::string(str1.begin(), mismatch_pair.first);
  1201. }
  1202. // Find the slot that has the greatest common prefix
  1203. server_slot *prefix_slot(const json &prompt) {
  1204. if (!prompt.is_string()) {
  1205. return nullptr;
  1206. }
  1207. std::string prompt_str = prompt.get<std::string>();
  1208. server_slot *slot = nullptr;
  1209. size_t longest = 0;
  1210. for (server_slot &s : slots) {
  1211. if (s.available() && s.prompt.is_string()) {
  1212. std::string s_prompt = s.prompt.get<std::string>();
  1213. std::string prefix = common_prefix(s_prompt, prompt_str);
  1214. if (prefix.size() > longest) {
  1215. slot = &s;
  1216. longest = prefix.size();
  1217. }
  1218. }
  1219. }
  1220. if (!slot) {
  1221. return get_slot(-1);
  1222. }
  1223. LOG_DEBUG("slot with common prefix found", {{
  1224. "slot_id", slot->id,
  1225. "characters", longest
  1226. }});
  1227. return slot;
  1228. }
  1229. void process_single_task(task_server& task)
  1230. {
  1231. switch (task.type)
  1232. {
  1233. case TASK_TYPE_COMPLETION: {
  1234. server_slot *slot = nullptr;
  1235. if (task.embedding_mode) {
  1236. // Embedding seq_id (aka slot id) must always be <= token length, so always use slot 0
  1237. slot = slots[0].available() ? &slots[0] : nullptr;
  1238. } else {
  1239. slot = prefix_slot(task.data["prompt"]);
  1240. }
  1241. if (slot == nullptr)
  1242. {
  1243. // if no slot is available, we defer this task for processing later
  1244. LOG_VERBOSE("no slot is available", {{"task_id", task.id}});
  1245. queue_tasks.defer(task);
  1246. break;
  1247. }
  1248. slot->reset();
  1249. slot->embedding = task.embedding_mode;
  1250. slot->task_id = task.id;
  1251. slot->multitask_id = task.multitask_id;
  1252. if (!launch_slot_with_data(slot, task.data))
  1253. {
  1254. // send error result
  1255. send_error(task, "internal_error");
  1256. break;
  1257. }
  1258. } break;
  1259. case TASK_TYPE_CANCEL: { // release slot linked with the task id
  1260. for (auto & slot : slots)
  1261. {
  1262. if (slot.task_id == task.target_id)
  1263. {
  1264. slot.release();
  1265. break;
  1266. }
  1267. }
  1268. } break;
  1269. case TASK_TYPE_NEXT_RESPONSE: {
  1270. // do nothing
  1271. } break;
  1272. case TASK_TYPE_METRICS: {
  1273. json slots_data = json::array();
  1274. int n_idle_slots = 0;
  1275. int n_processing_slots = 0;
  1276. for (server_slot &slot: slots) {
  1277. json slot_data = get_formated_generation(slot);
  1278. slot_data["id"] = slot.id;
  1279. slot_data["task_id"] = slot.task_id;
  1280. slot_data["state"] = slot.state;
  1281. slot_data["prompt"] = slot.prompt;
  1282. slot_data["next_token"] = {
  1283. {"has_next_token", slot.has_next_token},
  1284. {"n_remain", slot.n_remaining},
  1285. {"num_tokens_predicted", slot.n_decoded},
  1286. {"stopped_eos", slot.stopped_eos},
  1287. {"stopped_word", slot.stopped_word},
  1288. {"stopped_limit", slot.stopped_limit},
  1289. {"stopping_word", slot.stopping_word},
  1290. };
  1291. if (slot_data["state"] == IDLE) {
  1292. n_idle_slots++;
  1293. } else {
  1294. n_processing_slots++;
  1295. }
  1296. slots_data.push_back(slot_data);
  1297. }
  1298. LOG_DEBUG("slot data", {
  1299. {"task_id", task.id},
  1300. {"n_idle_slots", n_idle_slots},
  1301. {"n_processing_slots", n_processing_slots}
  1302. });
  1303. LOG_VERBOSE("slot data", {
  1304. {"task_id", task.id},
  1305. {"n_idle_slots", n_idle_slots},
  1306. {"n_processing_slots", n_processing_slots},
  1307. {"slots", slots_data}
  1308. });
  1309. task_result res;
  1310. res.id = task.id;
  1311. res.multitask_id = task.multitask_id;
  1312. res.stop = true;
  1313. res.error = false;
  1314. res.result_json = {
  1315. { "idle", n_idle_slots },
  1316. { "processing", n_processing_slots },
  1317. { "deferred", queue_tasks.queue_tasks_deferred.size() },
  1318. { "n_prompt_tokens_processed_total", metrics.n_prompt_tokens_processed_total},
  1319. { "n_tokens_predicted_total", metrics.n_tokens_predicted_total},
  1320. { "n_prompt_tokens_processed", metrics.n_prompt_tokens_processed},
  1321. { "t_prompt_processing", metrics.t_prompt_processing},
  1322. { "n_tokens_predicted", metrics.n_tokens_predicted},
  1323. { "t_tokens_generation", metrics.t_tokens_generation},
  1324. { "kv_cache_tokens_count", llama_get_kv_cache_token_count(ctx)},
  1325. { "kv_cache_used_cells", llama_get_kv_cache_used_cells(ctx)},
  1326. { "slots", slots_data },
  1327. };
  1328. metrics.reset_bucket();
  1329. queue_results.send(res);
  1330. } break;
  1331. }
  1332. }
  1333. void on_finish_multitask(task_multi& multitask)
  1334. {
  1335. // all subtasks done == multitask is done
  1336. task_result result;
  1337. result.id = multitask.id;
  1338. result.stop = true;
  1339. result.error = false;
  1340. // collect json results into one json result
  1341. std::vector<json> result_jsons;
  1342. for (auto& subres : multitask.results)
  1343. {
  1344. result_jsons.push_back(subres.result_json);
  1345. result.error = result.error && subres.error;
  1346. }
  1347. result.result_json = json{ { "results", result_jsons } };
  1348. queue_results.send(result);
  1349. }
  1350. bool update_slots() {
  1351. if (system_need_update)
  1352. {
  1353. LOG_DEBUG("updating system prompt", {});
  1354. system_prompt_update();
  1355. }
  1356. llama_batch_clear(batch);
  1357. if (all_slots_are_idle)
  1358. {
  1359. if (system_prompt.empty() && clean_kv_cache)
  1360. {
  1361. LOG_DEBUG("all slots are idle and system prompt is empty, clear the KV cache", {});
  1362. kv_cache_clear();
  1363. }
  1364. return true;
  1365. }
  1366. LOG_VERBOSE("posting NEXT_RESPONSE", {});
  1367. task_server task;
  1368. task.type = TASK_TYPE_NEXT_RESPONSE;
  1369. task.target_id = -1;
  1370. queue_tasks.post(task);
  1371. for (server_slot &slot : slots)
  1372. {
  1373. if (slot.ga_n == 1)
  1374. {
  1375. if (slot.is_processing() && system_tokens.size() + slot.cache_tokens.size() >= (size_t) slot.n_ctx)
  1376. {
  1377. // Shift context
  1378. const int n_keep = slot.params.n_keep + add_bos_token;
  1379. const int n_left = (int) system_tokens.size() + slot.n_past - n_keep;
  1380. const int n_discard = n_left / 2;
  1381. LOG_DEBUG("slot context shift", {
  1382. {"slot_id", slot.id},
  1383. {"task_id", slot.task_id},
  1384. {"n_keep", n_keep},
  1385. {"n_left", n_left},
  1386. {"n_discard", n_discard},
  1387. {"n_ctx", n_ctx},
  1388. {"n_past", slot.n_past},
  1389. {"n_system_tokens", system_tokens.size()},
  1390. {"n_cache_tokens", slot.cache_tokens.size()}
  1391. });
  1392. llama_kv_cache_seq_rm (ctx, slot.id, n_keep , n_keep + n_discard);
  1393. llama_kv_cache_seq_add(ctx, slot.id, n_keep + n_discard, system_tokens.size() + slot.n_past, -n_discard);
  1394. for (size_t i = n_keep + n_discard; i < slot.cache_tokens.size(); i++)
  1395. {
  1396. slot.cache_tokens[i - n_discard] = slot.cache_tokens[i];
  1397. }
  1398. slot.cache_tokens.resize(slot.cache_tokens.size() - n_discard);
  1399. slot.n_past -= n_discard;
  1400. slot.truncated = true;
  1401. }
  1402. }
  1403. }
  1404. // decode any currently ongoing sequences
  1405. LOG_VERBOSE("decoding ongoing sequences", {});
  1406. for (auto & slot : slots)
  1407. {
  1408. // release the slot
  1409. if (slot.command == RELEASE)
  1410. {
  1411. slot.state = IDLE;
  1412. slot.command = NONE;
  1413. slot.t_last_used = ggml_time_us();
  1414. LOG_DEBUG("slot released", {
  1415. {"slot_id", slot.id},
  1416. {"task_id", slot.task_id},
  1417. {"n_ctx", n_ctx},
  1418. {"n_past", slot.n_past},
  1419. {"n_system_tokens", system_tokens.size()},
  1420. {"n_cache_tokens", slot.cache_tokens.size()},
  1421. {"truncated", slot.truncated}
  1422. });
  1423. queue_tasks.notify_slot_changed();
  1424. continue;
  1425. }
  1426. if (slot.state == IDLE)
  1427. {
  1428. continue;
  1429. }
  1430. slot.i_batch = batch.n_tokens;
  1431. const int32_t slot_npast = slot.n_past_se > 0 ? slot.n_past_se : slot.n_past;
  1432. // TODO: we always have to take into account the "system_tokens"
  1433. // this is not great and needs to be improved somehow
  1434. llama_batch_add(batch, slot.sampled, system_tokens.size() + slot_npast, { slot.id }, true);
  1435. slot.n_past += 1;
  1436. }
  1437. // process in chunks of params.n_batch
  1438. int32_t n_batch = params.n_batch;
  1439. // assign workload to the slots
  1440. if (params.cont_batching || batch.n_tokens == 0)
  1441. {
  1442. for (auto & slot : slots)
  1443. {
  1444. const bool has_prompt = slot.prompt.is_array() || (slot.prompt.is_string() && !slot.prompt.get<std::string>().empty()) || !slot.images.empty();
  1445. // empty prompt passed -> release the slot and send empty response
  1446. if (slot.state == IDLE && slot.command == LOAD_PROMPT && !has_prompt)
  1447. {
  1448. slot.release();
  1449. slot.print_timings();
  1450. send_final_response(slot);
  1451. continue;
  1452. }
  1453. // need process the prompt
  1454. if (slot.state == IDLE && slot.command == LOAD_PROMPT)
  1455. {
  1456. slot.state = PROCESSING;
  1457. slot.command = NONE;
  1458. std::vector<llama_token> prompt_tokens;
  1459. slot.t_start_process_prompt = ggml_time_us();
  1460. slot.t_start_genereration = 0;
  1461. prompt_tokens = tokenize(slot.prompt, system_prompt.empty()); // add BOS if there isn't system prompt
  1462. slot.n_prompt_tokens = prompt_tokens.size();
  1463. if (slot.params.n_keep < 0)
  1464. {
  1465. slot.params.n_keep = slot.n_prompt_tokens;
  1466. }
  1467. slot.params.n_keep = std::min(slot.n_ctx - 4, slot.params.n_keep);
  1468. // if input prompt is too big, truncate it, if group attention self-extend is disabled
  1469. if (slot.ga_n == 1 && slot.n_prompt_tokens >= slot.n_ctx)
  1470. {
  1471. const int n_left = slot.n_ctx - slot.params.n_keep;
  1472. const int n_shift = n_left / 2;
  1473. const int n_erase = slot.n_prompt_tokens - slot.params.n_keep - n_shift;
  1474. std::vector<llama_token> new_tokens(
  1475. prompt_tokens.begin(),
  1476. prompt_tokens.begin() + slot.params.n_keep);
  1477. new_tokens.insert(
  1478. new_tokens.end(),
  1479. prompt_tokens.begin() + slot.params.n_keep + n_erase,
  1480. prompt_tokens.end());
  1481. LOG_INFO("input truncated", {
  1482. {"n_ctx", slot.n_ctx},
  1483. {"n_keep", slot.params.n_keep},
  1484. {"n_left", n_left},
  1485. {"n_shift", n_shift},
  1486. {"n_erase", n_erase},
  1487. });
  1488. slot.truncated = true;
  1489. prompt_tokens = new_tokens;
  1490. slot.n_prompt_tokens = prompt_tokens.size();
  1491. GGML_ASSERT(slot.n_prompt_tokens < slot.n_ctx);
  1492. }
  1493. if (!slot.params.cache_prompt)
  1494. {
  1495. llama_sampling_reset(slot.ctx_sampling);
  1496. slot.n_past = 0;
  1497. slot.n_past_se = 0;
  1498. slot.ga_i = 0;
  1499. slot.n_prompt_tokens_processed = slot.n_prompt_tokens;
  1500. }
  1501. else
  1502. {
  1503. // push the prompt into the sampling context (do not apply grammar)
  1504. for (auto &token : prompt_tokens)
  1505. {
  1506. llama_sampling_accept(slot.ctx_sampling, ctx, token, false);
  1507. }
  1508. slot.n_past = common_part(slot.cache_tokens, prompt_tokens);
  1509. // the last token of the cache is not in the KV cache until the next call to llama_decode
  1510. // (it was sampled, pushed into the "cache_tokens", but not yet put in the context)
  1511. if (slot.n_past > 0 && slot.n_past == (int32_t) slot.cache_tokens.size())
  1512. {
  1513. slot.n_past -= 1;
  1514. }
  1515. slot.n_prompt_tokens_processed = slot.n_prompt_tokens;
  1516. if (slot.ga_n != 1)
  1517. {
  1518. int ga_i = 0;
  1519. int32_t ga_n = slot.ga_n;
  1520. int32_t ga_w = slot.ga_w;
  1521. int32_t slot_npast = 0;
  1522. for (int k = 0; k < slot.n_past; ++k)
  1523. {
  1524. while (slot_npast >= ga_i + ga_w) {
  1525. const int bd = (ga_w/ga_n)*(ga_n - 1);
  1526. slot_npast -= bd;
  1527. ga_i += ga_w/ga_n;
  1528. }
  1529. slot_npast++;
  1530. }
  1531. slot.n_past_se = slot_npast;
  1532. slot.ga_i = ga_i;
  1533. }
  1534. LOG_DEBUG("slot progression", {
  1535. { "slot_id", slot.id },
  1536. { "task_id", slot.task_id },
  1537. { "n_past", slot.n_past },
  1538. { "n_past_se", slot.n_past_se },
  1539. { "ga_i", slot.ga_i },
  1540. { "n_prompt_tokens_processed", slot.n_prompt_tokens_processed }
  1541. });
  1542. }
  1543. slot.cache_tokens = prompt_tokens;
  1544. if (slot.n_past == slot.n_prompt_tokens && slot.n_past > 0)
  1545. {
  1546. // we have to evaluate at least 1 token to generate logits.
  1547. LOG_DEBUG("we have to evaluate at least 1 token to generate logits", {
  1548. { "slot_id", slot.id },
  1549. { "task_id", slot.task_id }
  1550. });
  1551. slot.n_past--;
  1552. if (slot.ga_i > 0)
  1553. {
  1554. slot.n_past_se--;
  1555. }
  1556. }
  1557. int p0 = (int) system_tokens.size() + slot.n_past;
  1558. LOG_DEBUG("kv cache rm [p0, end)", {
  1559. { "slot_id", slot.id },
  1560. { "task_id", slot.task_id },
  1561. { "p0", p0 }
  1562. });
  1563. llama_kv_cache_seq_rm(ctx, slot.id, p0, -1);
  1564. LOG_VERBOSE("prompt ingested", {
  1565. {"n_past", slot.n_past},
  1566. {"cached", tokens_to_str(ctx, slot.cache_tokens.cbegin(), slot.cache_tokens.cbegin() + slot.n_past)},
  1567. {"to_eval", tokens_to_str(ctx, slot.cache_tokens.cbegin() + slot.n_past, slot.cache_tokens.cend())},
  1568. });
  1569. const bool has_images = process_images(slot);
  1570. // process the prefix of first image
  1571. std::vector<llama_token> prefix_tokens = has_images ? tokenize(slot.images[0].prefix_prompt, add_bos_token) : prompt_tokens;
  1572. int32_t slot_npast = slot.n_past_se > 0 ? slot.n_past_se : slot.n_past;
  1573. int32_t ga_i = slot.ga_i;
  1574. int32_t ga_n = slot.ga_n;
  1575. int32_t ga_w = slot.ga_w;
  1576. for (; slot.n_past < (int) prefix_tokens.size(); ++slot.n_past)
  1577. {
  1578. if (slot.ga_n != 1)
  1579. {
  1580. while (slot_npast >= ga_i + ga_w) {
  1581. const int bd = (ga_w/ga_n)*(ga_n - 1);
  1582. slot_npast -= bd;
  1583. ga_i += ga_w/ga_n;
  1584. }
  1585. }
  1586. llama_batch_add(batch, prefix_tokens[slot.n_past], system_tokens.size() + slot_npast, { slot.id }, false);
  1587. slot_npast++;
  1588. }
  1589. if (has_images && !ingest_images(slot, n_batch))
  1590. {
  1591. LOG_ERROR("failed processing images", {
  1592. {"slot_id", slot.id},
  1593. {"task_id", slot.task_id},
  1594. });
  1595. // FIXME @phymbert: to be properly tested
  1596. // early returning without changing the slot state will block the slot for ever
  1597. // no one at the moment is checking the return value
  1598. return false;
  1599. }
  1600. // extract the logits only for the last token
  1601. if (batch.n_tokens > 0)
  1602. {
  1603. batch.logits[batch.n_tokens - 1] = true;
  1604. }
  1605. slot.n_decoded = 0;
  1606. slot.i_batch = batch.n_tokens - 1;
  1607. }
  1608. }
  1609. }
  1610. if (batch.n_tokens == 0)
  1611. {
  1612. all_slots_are_idle = true;
  1613. return true;
  1614. }
  1615. for (int32_t i = 0; i < (int32_t) batch.n_tokens; i += n_batch)
  1616. {
  1617. const int32_t n_tokens = std::min(n_batch, batch.n_tokens - i);
  1618. for (auto & slot : slots)
  1619. {
  1620. if (slot.ga_n != 1)
  1621. {
  1622. // context extension via Self-Extend
  1623. while (slot.n_past_se >= slot.ga_i + slot.ga_w)
  1624. {
  1625. const int ib = (slot.ga_n * slot.ga_i) / slot.ga_w;
  1626. const int bd = (slot.ga_w / slot.ga_n) * (slot.ga_n - 1);
  1627. const int dd = (slot.ga_w / slot.ga_n) - ib * bd - slot.ga_w;
  1628. LOG_TEE("\n");
  1629. LOG_TEE("shift: [%6d, %6d] + %6d -> [%6d, %6d]\n", slot.ga_i, slot.n_past_se, ib * bd, slot.ga_i + ib * bd, slot.n_past_se + ib * bd);
  1630. LOG_TEE("div: [%6d, %6d] / %6d -> [%6d, %6d]\n", slot.ga_i + ib * bd, slot.ga_i + ib * bd + slot.ga_w, slot.ga_n, (slot.ga_i + ib * bd) / slot.ga_n, (slot.ga_i + ib * bd + slot.ga_w) / slot.ga_n);
  1631. LOG_TEE("shift: [%6d, %6d] + %6d -> [%6d, %6d]\n", slot.ga_i + ib * bd + slot.ga_w, slot.n_past_se + ib * bd, dd, slot.ga_i + ib * bd + slot.ga_w + dd, slot.n_past_se + ib * bd + dd);
  1632. llama_kv_cache_seq_add(ctx, slot.id, slot.ga_i, slot.n_past_se, ib * bd);
  1633. llama_kv_cache_seq_div(ctx, slot.id, slot.ga_i + ib * bd, slot.ga_i + ib * bd + slot.ga_w,slot.ga_n);
  1634. llama_kv_cache_seq_add(ctx, slot.id, slot.ga_i + ib * bd + slot.ga_w,slot.n_past_se + ib * bd, dd);
  1635. slot.n_past_se -= bd;
  1636. slot.ga_i += slot.ga_w / slot.ga_n;
  1637. LOG_TEE("\nn_past_old = %d, n_past = %d, ga_i = %d\n\n", slot.n_past_se + bd, slot.n_past_se, slot.ga_i);
  1638. }
  1639. slot.n_past_se += n_tokens;
  1640. }
  1641. }
  1642. llama_batch batch_view =
  1643. {
  1644. n_tokens,
  1645. batch.token + i,
  1646. nullptr,
  1647. batch.pos + i,
  1648. batch.n_seq_id + i,
  1649. batch.seq_id + i,
  1650. batch.logits + i,
  1651. 0, 0, 0, // unused
  1652. };
  1653. const int ret = llama_decode(ctx, batch_view);
  1654. if (ret != 0)
  1655. {
  1656. if (n_batch == 1 || ret < 0)
  1657. {
  1658. // if you get here, it means the KV cache is full - try increasing it via the context size
  1659. LOG_TEE("%s : failed to decode the batch, n_batch = %d, ret = %d\n", __func__, n_batch, ret);
  1660. return false;
  1661. }
  1662. LOG_TEE("%s : failed to find free space in the KV cache, retrying with smaller n_batch = %d\n", __func__, n_batch / 2);
  1663. // retry with half the batch size to try to find a free slot in the KV cache
  1664. n_batch /= 2;
  1665. i -= n_batch;
  1666. continue;
  1667. }
  1668. for (auto & slot : slots)
  1669. {
  1670. if (slot.i_batch < (int) i || slot.i_batch >= (int) (i + n_tokens))
  1671. {
  1672. continue;
  1673. }
  1674. // prompt evaluated for embedding
  1675. if (slot.embedding)
  1676. {
  1677. send_embedding(slot, batch_view);
  1678. slot.release();
  1679. slot.i_batch = -1;
  1680. continue;
  1681. }
  1682. completion_token_output result;
  1683. const llama_token id = llama_sampling_sample(slot.ctx_sampling, ctx, NULL, slot.i_batch - i);
  1684. llama_sampling_accept(slot.ctx_sampling, ctx, id, true);
  1685. slot.n_decoded += 1;
  1686. if (slot.n_decoded == 1)
  1687. {
  1688. slot.t_start_genereration = ggml_time_us();
  1689. slot.t_prompt_processing = (slot.t_start_genereration - slot.t_start_process_prompt) / 1e3;
  1690. metrics.on_prompt_eval(slot);
  1691. }
  1692. llama_token_data_array cur_p = { slot.ctx_sampling->cur.data(), slot.ctx_sampling->cur.size(), false };
  1693. result.tok = id;
  1694. const int32_t n_probs = slot.sparams.n_probs;
  1695. if (slot.sparams.temp <= 0 && n_probs > 0)
  1696. {
  1697. // for llama_sample_token_greedy we need to sort candidates
  1698. llama_sample_softmax(ctx, &cur_p);
  1699. }
  1700. for (size_t i = 0; i < std::min(cur_p.size, (size_t)n_probs); ++i)
  1701. {
  1702. result.probs.push_back({cur_p.data[i].id, cur_p.data[i].p});
  1703. }
  1704. if (!process_token(result, slot))
  1705. {
  1706. slot.release();
  1707. slot.print_timings();
  1708. send_final_response(slot);
  1709. metrics.on_prediction(slot);
  1710. }
  1711. slot.i_batch = -1;
  1712. }
  1713. }
  1714. LOG_VERBOSE("slots updated", {});
  1715. return true;
  1716. }
  1717. json model_meta() {
  1718. return json{
  1719. {"vocab_type", llama_vocab_type(model)},
  1720. {"n_vocab", llama_n_vocab(model)},
  1721. {"n_ctx_train", llama_n_ctx_train(model)},
  1722. {"n_embd", llama_n_embd(model)},
  1723. {"n_params", llama_model_n_params(model)},
  1724. {"size", llama_model_size(model)},
  1725. };
  1726. }
  1727. };
  1728. static void server_print_usage(const char *argv0, const gpt_params &params,
  1729. const server_params &sparams)
  1730. {
  1731. printf("usage: %s [options]\n", argv0);
  1732. printf("\n");
  1733. printf("options:\n");
  1734. printf(" -h, --help show this help message and exit\n");
  1735. printf(" -v, --verbose verbose output (default: %s)\n", server_verbose ? "enabled" : "disabled");
  1736. printf(" -t N, --threads N number of threads to use during computation (default: %d)\n", params.n_threads);
  1737. printf(" -tb N, --threads-batch N number of threads to use during batch and prompt processing (default: same as --threads)\n");
  1738. printf(" --threads-http N number of threads in the http server pool to process requests (default: max(hardware concurrency - 1, --parallel N + 2))\n");
  1739. printf(" -c N, --ctx-size N size of the prompt context (default: %d)\n", params.n_ctx);
  1740. printf(" --rope-scaling {none,linear,yarn}\n");
  1741. printf(" RoPE frequency scaling method, defaults to linear unless specified by the model\n");
  1742. printf(" --rope-freq-base N RoPE base frequency (default: loaded from model)\n");
  1743. printf(" --rope-freq-scale N RoPE frequency scaling factor, expands context by a factor of 1/N\n");
  1744. printf(" --yarn-ext-factor N YaRN: extrapolation mix factor (default: 1.0, 0.0 = full interpolation)\n");
  1745. printf(" --yarn-attn-factor N YaRN: scale sqrt(t) or attention magnitude (default: 1.0)\n");
  1746. printf(" --yarn-beta-slow N YaRN: high correction dim or alpha (default: %.1f)\n", params.yarn_beta_slow);
  1747. printf(" --yarn-beta-fast N YaRN: low correction dim or beta (default: %.1f)\n", params.yarn_beta_fast);
  1748. printf(" --pooling {none,mean,cls}\n");
  1749. printf(" pooling type for embeddings, use model default if unspecified\n");
  1750. printf(" -b N, --batch-size N batch size for prompt processing (default: %d)\n", params.n_batch);
  1751. printf(" --memory-f32 use f32 instead of f16 for memory key+value (default: disabled)\n");
  1752. printf(" not recommended: doubles context memory required and no measurable increase in quality\n");
  1753. if (llama_supports_mlock())
  1754. {
  1755. printf(" --mlock force system to keep model in RAM rather than swapping or compressing\n");
  1756. }
  1757. if (llama_supports_mmap())
  1758. {
  1759. printf(" --no-mmap do not memory-map model (slower load but may reduce pageouts if not using mlock)\n");
  1760. }
  1761. printf(" --numa TYPE attempt optimizations that help on some NUMA systems\n");
  1762. printf(" - distribute: spread execution evenly over all nodes\n");
  1763. printf(" - isolate: only spawn threads on CPUs on the node that execution started on\n");
  1764. printf(" - numactl: use the CPU map provided my numactl\n");
  1765. if (llama_supports_gpu_offload()) {
  1766. printf(" -ngl N, --n-gpu-layers N\n");
  1767. printf(" number of layers to store in VRAM\n");
  1768. printf(" -sm SPLIT_MODE, --split-mode SPLIT_MODE\n");
  1769. printf(" how to split the model across multiple GPUs, one of:\n");
  1770. printf(" - none: use one GPU only\n");
  1771. printf(" - layer (default): split layers and KV across GPUs\n");
  1772. printf(" - row: split rows across GPUs\n");
  1773. printf(" -ts SPLIT --tensor-split SPLIT\n");
  1774. printf(" fraction of the model to offload to each GPU, comma-separated list of proportions, e.g. 3,1\n");
  1775. printf(" -mg i, --main-gpu i the GPU to use for the model (with split-mode = none),\n");
  1776. printf(" or for intermediate results and KV (with split-mode = row)\n");
  1777. }
  1778. printf(" -m FNAME, --model FNAME\n");
  1779. printf(" model path (default: %s)\n", params.model.c_str());
  1780. printf(" -a ALIAS, --alias ALIAS\n");
  1781. printf(" set an alias for the model, will be added as `model` field in completion response\n");
  1782. printf(" --lora FNAME apply LoRA adapter (implies --no-mmap)\n");
  1783. printf(" --lora-base FNAME optional model to use as a base for the layers modified by the LoRA adapter\n");
  1784. printf(" --host ip address to listen (default (default: %s)\n", sparams.hostname.c_str());
  1785. printf(" --port PORT port to listen (default (default: %d)\n", sparams.port);
  1786. printf(" --path PUBLIC_PATH path from which to serve static files (default %s)\n", sparams.public_path.c_str());
  1787. printf(" --api-key API_KEY optional api key to enhance server security. If set, requests must include this key for access.\n");
  1788. printf(" --api-key-file FNAME path to file containing api keys delimited by new lines. If set, requests must include one of the keys for access.\n");
  1789. printf(" -to N, --timeout N server read/write timeout in seconds (default: %d)\n", sparams.read_timeout);
  1790. printf(" --embedding enable embedding vector output (default: %s)\n", params.embedding ? "enabled" : "disabled");
  1791. printf(" -np N, --parallel N number of slots for process requests (default: %d)\n", params.n_parallel);
  1792. printf(" -cb, --cont-batching enable continuous batching (a.k.a dynamic batching) (default: disabled)\n");
  1793. printf(" -fa, --flash-attn enable Flash Attention (default: %s)\n", params.flash_attn ? "enabled" : "disabled");
  1794. printf(" -spf FNAME, --system-prompt-file FNAME\n");
  1795. printf(" set a file to load a system prompt (initial prompt of all slots), this is useful for chat applications.\n");
  1796. printf(" -ctk TYPE, --cache-type-k TYPE\n");
  1797. printf(" KV cache data type for K (default: f16)\n");
  1798. printf(" -ctv TYPE, --cache-type-v TYPE\n");
  1799. printf(" KV cache data type for V (default: f16)\n");
  1800. printf(" --mmproj MMPROJ_FILE path to a multimodal projector file for LLaVA.\n");
  1801. printf(" --log-format log output format: json or text (default: json)\n");
  1802. printf(" --log-disable disables logging to a file.\n");
  1803. printf(" --slots-endpoint-disable disables slots monitoring endpoint.\n");
  1804. printf(" --metrics enable prometheus compatible metrics endpoint (default: %s).\n", sparams.metrics_endpoint ? "enabled" : "disabled");
  1805. printf("\n");
  1806. printf(" -n, --n-predict maximum tokens to predict (default: %d)\n", params.n_predict);
  1807. printf(" --override-kv KEY=TYPE:VALUE\n");
  1808. printf(" advanced option to override model metadata by key. may be specified multiple times.\n");
  1809. printf(" types: int, float, bool. example: --override-kv tokenizer.ggml.add_bos_token=bool:false\n");
  1810. printf(" -gan N, --grp-attn-n N set the group attention factor to extend context size through self-extend(default: 1=disabled), used together with group attention width `--grp-attn-w`\n");
  1811. printf(" -gaw N, --grp-attn-w N set the group attention width to extend context size through self-extend(default: 512), used together with group attention factor `--grp-attn-n`\n");
  1812. printf(" --chat-template JINJA_TEMPLATE\n");
  1813. printf(" set custom jinja chat template (default: template taken from model's metadata)\n");
  1814. printf(" Note: only commonly used templates are accepted, since we don't have jinja parser\n");
  1815. printf("\n");
  1816. }
  1817. static void server_params_parse(int argc, char **argv, server_params &sparams, gpt_params &params)
  1818. {
  1819. gpt_params default_params;
  1820. server_params default_sparams;
  1821. std::string arg;
  1822. bool invalid_param = false;
  1823. for (int i = 1; i < argc; i++)
  1824. {
  1825. arg = argv[i];
  1826. if (arg == "--port")
  1827. {
  1828. if (++i >= argc)
  1829. {
  1830. invalid_param = true;
  1831. break;
  1832. }
  1833. sparams.port = std::stoi(argv[i]);
  1834. }
  1835. else if (arg == "--host")
  1836. {
  1837. if (++i >= argc)
  1838. {
  1839. invalid_param = true;
  1840. break;
  1841. }
  1842. sparams.hostname = argv[i];
  1843. }
  1844. else if (arg == "--path")
  1845. {
  1846. if (++i >= argc)
  1847. {
  1848. invalid_param = true;
  1849. break;
  1850. }
  1851. sparams.public_path = argv[i];
  1852. }
  1853. else if (arg == "--api-key")
  1854. {
  1855. if (++i >= argc)
  1856. {
  1857. invalid_param = true;
  1858. break;
  1859. }
  1860. sparams.api_keys.emplace_back(argv[i]);
  1861. }
  1862. else if (arg == "--api-key-file")
  1863. {
  1864. if (++i >= argc)
  1865. {
  1866. invalid_param = true;
  1867. break;
  1868. }
  1869. std::ifstream key_file(argv[i]);
  1870. if (!key_file) {
  1871. fprintf(stderr, "error: failed to open file '%s'\n", argv[i]);
  1872. invalid_param = true;
  1873. break;
  1874. }
  1875. std::string key;
  1876. while (std::getline(key_file, key)) {
  1877. if (key.size() > 0) {
  1878. sparams.api_keys.push_back(key);
  1879. }
  1880. }
  1881. key_file.close();
  1882. }
  1883. else if (arg == "--timeout" || arg == "-to")
  1884. {
  1885. if (++i >= argc)
  1886. {
  1887. invalid_param = true;
  1888. break;
  1889. }
  1890. sparams.read_timeout = std::stoi(argv[i]);
  1891. sparams.write_timeout = std::stoi(argv[i]);
  1892. }
  1893. else if (arg == "-m" || arg == "--model")
  1894. {
  1895. if (++i >= argc)
  1896. {
  1897. invalid_param = true;
  1898. break;
  1899. }
  1900. params.model = argv[i];
  1901. }
  1902. else if (arg == "-a" || arg == "--alias")
  1903. {
  1904. if (++i >= argc)
  1905. {
  1906. invalid_param = true;
  1907. break;
  1908. }
  1909. params.model_alias = argv[i];
  1910. }
  1911. else if (arg == "-h" || arg == "--help")
  1912. {
  1913. server_print_usage(argv[0], default_params, default_sparams);
  1914. exit(0);
  1915. }
  1916. else if (arg == "-c" || arg == "--ctx-size" || arg == "--ctx_size")
  1917. {
  1918. if (++i >= argc)
  1919. {
  1920. invalid_param = true;
  1921. break;
  1922. }
  1923. params.n_ctx = std::stoi(argv[i]);
  1924. }
  1925. else if (arg == "--rope-scaling")
  1926. {
  1927. if (++i >= argc)
  1928. {
  1929. invalid_param = true;
  1930. break;
  1931. }
  1932. std::string value(argv[i]);
  1933. /**/ if (value == "none") { params.rope_scaling_type = LLAMA_ROPE_SCALING_TYPE_NONE; }
  1934. else if (value == "linear") { params.rope_scaling_type = LLAMA_ROPE_SCALING_TYPE_LINEAR; }
  1935. else if (value == "yarn") { params.rope_scaling_type = LLAMA_ROPE_SCALING_TYPE_YARN; }
  1936. else { invalid_param = true; break; }
  1937. }
  1938. else if (arg == "--rope-freq-base")
  1939. {
  1940. if (++i >= argc)
  1941. {
  1942. invalid_param = true;
  1943. break;
  1944. }
  1945. params.rope_freq_base = std::stof(argv[i]);
  1946. }
  1947. else if (arg == "--rope-freq-scale")
  1948. {
  1949. if (++i >= argc)
  1950. {
  1951. invalid_param = true;
  1952. break;
  1953. }
  1954. params.rope_freq_scale = std::stof(argv[i]);
  1955. }
  1956. else if (arg == "--yarn-ext-factor")
  1957. {
  1958. if (++i >= argc) {
  1959. invalid_param = true;
  1960. break;
  1961. }
  1962. params.yarn_ext_factor = std::stof(argv[i]);
  1963. }
  1964. else if (arg == "--yarn-attn-factor")
  1965. {
  1966. if (++i >= argc) {
  1967. invalid_param = true;
  1968. break;
  1969. }
  1970. params.yarn_attn_factor = std::stof(argv[i]);
  1971. }
  1972. else if (arg == "--yarn-beta-fast")
  1973. {
  1974. if (++i >= argc) {
  1975. invalid_param = true;
  1976. break;
  1977. }
  1978. params.yarn_beta_fast = std::stof(argv[i]);
  1979. }
  1980. else if (arg == "--yarn-beta-slow")
  1981. {
  1982. if (++i >= argc) {
  1983. invalid_param = true;
  1984. break;
  1985. }
  1986. params.yarn_beta_slow = std::stof(argv[i]);
  1987. }
  1988. else if (arg == "--pooling")
  1989. {
  1990. if (++i >= argc) {
  1991. invalid_param = true;
  1992. break;
  1993. }
  1994. std::string value(argv[i]);
  1995. /**/ if (value == "none") { params.pooling_type = LLAMA_POOLING_TYPE_NONE; }
  1996. else if (value == "mean") { params.pooling_type = LLAMA_POOLING_TYPE_MEAN; }
  1997. else if (value == "cls") { params.pooling_type = LLAMA_POOLING_TYPE_CLS; }
  1998. else { invalid_param = true; break; }
  1999. }
  2000. else if (arg == "--threads" || arg == "-t")
  2001. {
  2002. if (++i >= argc)
  2003. {
  2004. invalid_param = true;
  2005. break;
  2006. }
  2007. params.n_threads = std::stoi(argv[i]);
  2008. }
  2009. else if (arg == "--grp-attn-n" || arg == "-gan")
  2010. {
  2011. if (++i >= argc) {
  2012. invalid_param = true;
  2013. break;
  2014. }
  2015. params.grp_attn_n = std::stoi(argv[i]);
  2016. }
  2017. else if (arg == "--grp-attn-w" || arg == "-gaw")
  2018. {
  2019. if (++i >= argc)
  2020. {
  2021. invalid_param = true;
  2022. break;
  2023. }
  2024. params.grp_attn_w = std::stoi(argv[i]);
  2025. }
  2026. else if (arg == "--threads-batch" || arg == "-tb")
  2027. {
  2028. if (++i >= argc)
  2029. {
  2030. invalid_param = true;
  2031. break;
  2032. }
  2033. params.n_threads_batch = std::stoi(argv[i]);
  2034. }
  2035. else if (arg == "--threads-http")
  2036. {
  2037. if (++i >= argc)
  2038. {
  2039. invalid_param = true;
  2040. break;
  2041. }
  2042. sparams.n_threads_http = std::stoi(argv[i]);
  2043. }
  2044. else if (arg == "-b" || arg == "--batch-size")
  2045. {
  2046. if (++i >= argc)
  2047. {
  2048. invalid_param = true;
  2049. break;
  2050. }
  2051. params.n_batch = std::stoi(argv[i]);
  2052. }
  2053. else if (arg == "--gpu-layers" || arg == "-ngl" || arg == "--n-gpu-layers")
  2054. {
  2055. if (++i >= argc)
  2056. {
  2057. invalid_param = true;
  2058. break;
  2059. }
  2060. if (llama_supports_gpu_offload()) {
  2061. params.n_gpu_layers = std::stoi(argv[i]);
  2062. } else {
  2063. LOG_WARNING("Not compiled with GPU offload support, --n-gpu-layers option will be ignored. "
  2064. "See main README.md for information on enabling GPU BLAS support",
  2065. {{"n_gpu_layers", params.n_gpu_layers}});
  2066. }
  2067. }
  2068. else if (arg == "--split-mode" || arg == "-sm")
  2069. {
  2070. if (++i >= argc) {
  2071. invalid_param = true;
  2072. break;
  2073. }
  2074. std::string arg_next = argv[i];
  2075. if (arg_next == "none")
  2076. {
  2077. params.split_mode = LLAMA_SPLIT_MODE_NONE;
  2078. }
  2079. else if (arg_next == "layer")
  2080. {
  2081. params.split_mode = LLAMA_SPLIT_MODE_LAYER;
  2082. }
  2083. else if (arg_next == "row")
  2084. {
  2085. params.split_mode = LLAMA_SPLIT_MODE_ROW;
  2086. }
  2087. else {
  2088. invalid_param = true;
  2089. break;
  2090. }
  2091. #ifndef GGML_USE_CUDA
  2092. fprintf(stderr, "warning: llama.cpp was compiled without CUDA. Setting the split mode has no effect.\n");
  2093. #endif // GGML_USE_CUDA
  2094. }
  2095. else if (arg == "--tensor-split" || arg == "-ts")
  2096. {
  2097. if (++i >= argc)
  2098. {
  2099. invalid_param = true;
  2100. break;
  2101. }
  2102. #if defined(GGML_USE_CUDA) || defined(GGML_USE_SYCL)
  2103. std::string arg_next = argv[i];
  2104. // split string by , and /
  2105. const std::regex regex{R"([,/]+)"};
  2106. std::sregex_token_iterator it{arg_next.begin(), arg_next.end(), regex, -1};
  2107. std::vector<std::string> split_arg{it, {}};
  2108. GGML_ASSERT(split_arg.size() <= llama_max_devices());
  2109. for (size_t i_device = 0; i_device < llama_max_devices(); ++i_device)
  2110. {
  2111. if (i_device < split_arg.size())
  2112. {
  2113. params.tensor_split[i_device] = std::stof(split_arg[i_device]);
  2114. }
  2115. else
  2116. {
  2117. params.tensor_split[i_device] = 0.0f;
  2118. }
  2119. }
  2120. #else
  2121. LOG_WARNING("llama.cpp was compiled without CUDA. It is not possible to set a tensor split.\n", {});
  2122. #endif // GGML_USE_CUDA
  2123. }
  2124. else if (arg == "--main-gpu" || arg == "-mg")
  2125. {
  2126. if (++i >= argc)
  2127. {
  2128. invalid_param = true;
  2129. break;
  2130. }
  2131. #if defined(GGML_USE_CUDA) || defined(GGML_USE_SYCL)
  2132. params.main_gpu = std::stoi(argv[i]);
  2133. #else
  2134. LOG_WARNING("llama.cpp was compiled without cuBLAS. It is not possible to set a main GPU.", {});
  2135. #endif
  2136. }
  2137. else if (arg == "--lora")
  2138. {
  2139. if (++i >= argc)
  2140. {
  2141. invalid_param = true;
  2142. break;
  2143. }
  2144. params.lora_adapters.push_back({
  2145. std::string(argv[i]),
  2146. 1.0,
  2147. });
  2148. params.use_mmap = false;
  2149. }
  2150. else if (arg == "--lora-scaled")
  2151. {
  2152. if (++i >= argc)
  2153. {
  2154. invalid_param = true;
  2155. break;
  2156. }
  2157. const char * lora_adapter = argv[i];
  2158. if (++i >= argc)
  2159. {
  2160. invalid_param = true;
  2161. break;
  2162. }
  2163. params.lora_adapters.push_back({
  2164. lora_adapter,
  2165. std::stof(argv[i])
  2166. });
  2167. params.use_mmap = false;
  2168. }
  2169. else if (arg == "-v" || arg == "--verbose")
  2170. {
  2171. server_verbose = true;
  2172. }
  2173. else if (arg == "--mlock")
  2174. {
  2175. params.use_mlock = true;
  2176. }
  2177. else if (arg == "--no-mmap")
  2178. {
  2179. params.use_mmap = false;
  2180. }
  2181. else if (arg == "--numa")
  2182. {
  2183. if (++i >= argc) {
  2184. invalid_param = true;
  2185. break;
  2186. } else {
  2187. std::string value(argv[i]);
  2188. /**/ if (value == "distribute" || value == "" ) { params.numa = GGML_NUMA_STRATEGY_DISTRIBUTE; }
  2189. else if (value == "isolate") { params.numa = GGML_NUMA_STRATEGY_ISOLATE; }
  2190. else if (value == "numactl") { params.numa = GGML_NUMA_STRATEGY_NUMACTL; }
  2191. else { invalid_param = true; break; }
  2192. }
  2193. }
  2194. else if (arg == "--embedding")
  2195. {
  2196. params.embedding = true;
  2197. }
  2198. else if (arg == "-cb" || arg == "--cont-batching")
  2199. {
  2200. params.cont_batching = true;
  2201. }
  2202. else if (arg == "-fa" || arg == "--flash-attn")
  2203. {
  2204. params.flash_attn = true;
  2205. }
  2206. else if (arg == "-np" || arg == "--parallel")
  2207. {
  2208. if (++i >= argc)
  2209. {
  2210. invalid_param = true;
  2211. break;
  2212. }
  2213. params.n_parallel = std::stoi(argv[i]);
  2214. }
  2215. else if (arg == "-n" || arg == "--n-predict")
  2216. {
  2217. if (++i >= argc)
  2218. {
  2219. invalid_param = true;
  2220. break;
  2221. }
  2222. params.n_predict = std::stoi(argv[i]);
  2223. }
  2224. else if (arg == "-ctk" || arg == "--cache-type-k") {
  2225. params.cache_type_k = argv[++i];
  2226. }
  2227. else if (arg == "-ctv" || arg == "--cache-type-v") {
  2228. params.cache_type_v = argv[++i];
  2229. }
  2230. else if(arg == "--mmproj")
  2231. {
  2232. if (++i >= argc)
  2233. {
  2234. invalid_param = true;
  2235. break;
  2236. }
  2237. params.mmproj = argv[i];
  2238. }
  2239. else if (arg == "--log-format")
  2240. {
  2241. if (++i >= argc)
  2242. {
  2243. invalid_param = true;
  2244. break;
  2245. }
  2246. if (std::strcmp(argv[i], "json") == 0)
  2247. {
  2248. server_log_json = true;
  2249. }
  2250. else if (std::strcmp(argv[i], "text") == 0)
  2251. {
  2252. server_log_json = false;
  2253. }
  2254. else
  2255. {
  2256. invalid_param = true;
  2257. break;
  2258. }
  2259. }
  2260. else if (arg == "--log-disable")
  2261. {
  2262. log_set_target(stdout);
  2263. LOG_DEBUG("logging to file is disabled.", {});
  2264. }
  2265. else if (arg == "--slots-endpoint-disable")
  2266. {
  2267. sparams.slots_endpoint = false;
  2268. }
  2269. else if (arg == "--metrics")
  2270. {
  2271. sparams.metrics_endpoint = true;
  2272. }
  2273. else if (arg == "--chat-template")
  2274. {
  2275. if (++i >= argc)
  2276. {
  2277. invalid_param = true;
  2278. break;
  2279. }
  2280. if (!verify_custom_template(argv[i])) {
  2281. fprintf(stderr, "error: the supplied chat template is not supported: %s\n", argv[i]);
  2282. fprintf(stderr, "note: llama.cpp does not use jinja parser, we only support commonly used templates\n");
  2283. invalid_param = true;
  2284. break;
  2285. }
  2286. }
  2287. else if (arg == "--override-kv")
  2288. {
  2289. if (++i >= argc) {
  2290. invalid_param = true;
  2291. break;
  2292. }
  2293. char * sep = strchr(argv[i], '=');
  2294. if (sep == nullptr || sep - argv[i] >= 128) {
  2295. fprintf(stderr, "error: Malformed KV override: %s\n", argv[i]);
  2296. invalid_param = true;
  2297. break;
  2298. }
  2299. struct llama_model_kv_override kvo;
  2300. std::strncpy(kvo.key, argv[i], sep - argv[i]);
  2301. kvo.key[sep - argv[i]] = 0;
  2302. sep++;
  2303. if (strncmp(sep, "int:", 4) == 0) {
  2304. sep += 4;
  2305. kvo.tag = LLAMA_KV_OVERRIDE_TYPE_INT;
  2306. kvo.val_i64 = std::atol(sep);
  2307. } else if (strncmp(sep, "float:", 6) == 0) {
  2308. sep += 6;
  2309. kvo.tag = LLAMA_KV_OVERRIDE_TYPE_FLOAT;
  2310. kvo.val_f64 = std::atof(sep);
  2311. } else if (strncmp(sep, "bool:", 5) == 0) {
  2312. sep += 5;
  2313. kvo.tag = LLAMA_KV_OVERRIDE_TYPE_BOOL;
  2314. if (std::strcmp(sep, "true") == 0) {
  2315. kvo.val_bool = true;
  2316. } else if (std::strcmp(sep, "false") == 0) {
  2317. kvo.val_bool = false;
  2318. } else {
  2319. fprintf(stderr, "error: Invalid boolean value for KV override: %s\n", argv[i]);
  2320. invalid_param = true;
  2321. break;
  2322. }
  2323. } else {
  2324. fprintf(stderr, "error: Invalid type for KV override: %s\n", argv[i]);
  2325. invalid_param = true;
  2326. break;
  2327. }
  2328. params.kv_overrides.push_back(kvo);
  2329. }
  2330. else
  2331. {
  2332. fprintf(stderr, "error: unknown argument: %s\n", arg.c_str());
  2333. server_print_usage(argv[0], default_params, default_sparams);
  2334. exit(1);
  2335. }
  2336. }
  2337. if (!params.kv_overrides.empty()) {
  2338. params.kv_overrides.emplace_back();
  2339. params.kv_overrides.back().key[0] = 0;
  2340. }
  2341. if (invalid_param)
  2342. {
  2343. fprintf(stderr, "error: invalid parameter for argument: %s\n", arg.c_str());
  2344. server_print_usage(argv[0], default_params, default_sparams);
  2345. exit(1);
  2346. }
  2347. }
  2348. /* llama.cpp completion api semantics */
  2349. static json format_partial_response(
  2350. llama_server_context &llama, server_slot *slot, const std::string &content, const std::vector<completion_token_output> &probs
  2351. ) {
  2352. json res = json
  2353. {
  2354. {"content", content },
  2355. {"stop", false},
  2356. {"slot_id", slot->id },
  2357. {"multimodal", llama.multimodal }
  2358. };
  2359. if (slot->sparams.n_probs > 0)
  2360. {
  2361. res["completion_probabilities"] = probs_vector_to_json(llama.ctx, probs);
  2362. }
  2363. return res;
  2364. }
  2365. static json format_tokenizer_response(const std::vector<llama_token> &tokens)
  2366. {
  2367. return json {
  2368. {"tokens", tokens}
  2369. };
  2370. }
  2371. static json format_detokenized_response(std::string content)
  2372. {
  2373. return json {
  2374. {"content", content}
  2375. };
  2376. }
  2377. static void log_server_request(const httplib::Request &req, const httplib::Response &res)
  2378. {
  2379. // skip GH copilot requests when using default port
  2380. if (req.path == "/health" || req.path == "/v1/health" || req.path == "/v1/completions")
  2381. {
  2382. return;
  2383. }
  2384. LOG_DEBUG("request", {
  2385. {"remote_addr", req.remote_addr},
  2386. {"remote_port", req.remote_port},
  2387. {"status", res.status},
  2388. {"method", req.method},
  2389. {"path", req.path},
  2390. {"params", req.params},
  2391. });
  2392. LOG_VERBOSE("request", {
  2393. {"request", req.body},
  2394. {"response", res.body},
  2395. });
  2396. }
  2397. static void append_to_generated_text_from_generated_token_probs(llama_server_context &llama, server_slot *slot)
  2398. {
  2399. auto & gtps = slot->generated_token_probs;
  2400. auto translator = token_translator{llama.ctx};
  2401. auto add_strlen = [=](size_t sum, const completion_token_output & cto) { return sum + translator(cto).size(); };
  2402. const size_t len = std::accumulate(gtps.begin(), gtps.end(), size_t(0), add_strlen);
  2403. if (slot->generated_text.capacity() < slot->generated_text.size() + len)
  2404. {
  2405. slot->generated_text.reserve(slot->generated_text.size() + len);
  2406. }
  2407. for (const completion_token_output & cto : gtps)
  2408. {
  2409. slot->generated_text += translator(cto);
  2410. }
  2411. }
  2412. std::function<void(int)> shutdown_handler;
  2413. std::atomic_flag is_terminating = ATOMIC_FLAG_INIT;
  2414. inline void signal_handler(int signal) {
  2415. if (is_terminating.test_and_set()) {
  2416. // in case it hangs, we can force terminate the server by hitting Ctrl+C twice
  2417. // this is for better developer experience, we can remove when the server is stable enough
  2418. fprintf(stderr, "Received second interrupt, terminating immediately.\n");
  2419. exit(1);
  2420. }
  2421. shutdown_handler(signal);
  2422. }
  2423. static bool update_load_progress(float progress, void *data)
  2424. {
  2425. ((llama_server_context*)data)->modelProgress = progress;
  2426. return true;
  2427. }
  2428. #if defined(_WIN32)
  2429. char* wchar_to_char(const wchar_t* wstr) {
  2430. if (wstr == nullptr) return nullptr;
  2431. // Determine the number of bytes needed for the UTF-8 string
  2432. int bytes = WideCharToMultiByte(CP_UTF8, 0, wstr, -1, nullptr, 0, nullptr, nullptr);
  2433. char* str = new char[bytes];
  2434. // Convert the wide-character string to a UTF-8 string
  2435. WideCharToMultiByte(CP_UTF8, 0, wstr, -1, str, bytes, nullptr, nullptr);
  2436. return str;
  2437. }
  2438. int wmain(int argc, wchar_t **wargv) {
  2439. char** argv = new char*[argc];
  2440. for (int i = 0; i < argc; ++i) {
  2441. argv[i] = wchar_to_char(wargv[i]);
  2442. }
  2443. // Adjust error mode to avoid error dialog after we start.
  2444. SetErrorMode(SEM_FAILCRITICALERRORS);
  2445. #else
  2446. int main(int argc, char **argv) {
  2447. #endif
  2448. #if SERVER_VERBOSE != 1
  2449. log_disable();
  2450. #endif
  2451. // own arguments required by this example
  2452. gpt_params params;
  2453. server_params sparams;
  2454. // struct that contains llama context and inference
  2455. llama_server_context llama;
  2456. server_params_parse(argc, argv, sparams, params);
  2457. if (params.model_alias == "unknown")
  2458. {
  2459. params.model_alias = params.model;
  2460. }
  2461. llama_backend_init();
  2462. llama_numa_init(params.numa);
  2463. LOG_INFO("build info", {{"build", LLAMA_BUILD_NUMBER},
  2464. {"commit", LLAMA_COMMIT}});
  2465. LOG_INFO("system info", {
  2466. {"n_threads", params.n_threads},
  2467. {"n_threads_batch", params.n_threads_batch},
  2468. {"total_threads", std::thread::hardware_concurrency()},
  2469. {"system_info", llama_print_system_info()},
  2470. });
  2471. httplib::Server svr;
  2472. std::atomic<server_state> state{SERVER_STATE_LOADING_MODEL};
  2473. svr.set_default_headers({{"Server", "llama.cpp"}});
  2474. // CORS preflight
  2475. svr.Options(R"(.*)", [](const httplib::Request &req, httplib::Response &res) {
  2476. res.set_header("Access-Control-Allow-Origin", req.get_header_value("Origin"));
  2477. res.set_header("Access-Control-Allow-Credentials", "true");
  2478. res.set_header("Access-Control-Allow-Methods", "POST");
  2479. res.set_header("Access-Control-Allow-Headers", "*");
  2480. });
  2481. svr.Get("/health", [&](const httplib::Request& req, httplib::Response& res) {
  2482. server_state current_state = state.load();
  2483. switch(current_state) {
  2484. case SERVER_STATE_READY: {
  2485. // request slots data using task queue
  2486. task_server task;
  2487. task.id = llama.queue_tasks.get_new_id();
  2488. task.type = TASK_TYPE_METRICS;
  2489. task.target_id = -1;
  2490. llama.queue_results.add_waiting_task_id(task.id);
  2491. llama.queue_tasks.post(task);
  2492. // get the result
  2493. task_result result = llama.queue_results.recv(task.id);
  2494. llama.queue_results.remove_waiting_task_id(task.id);
  2495. int n_idle_slots = result.result_json["idle"];
  2496. int n_processing_slots = result.result_json["processing"];
  2497. json health = {
  2498. {"status", "ok"},
  2499. {"slots_idle", n_idle_slots},
  2500. {"slots_processing", n_processing_slots}};
  2501. res.status = 200; // HTTP OK
  2502. if (sparams.slots_endpoint && req.has_param("include_slots")) {
  2503. health["slots"] = result.result_json["slots"];
  2504. }
  2505. if (n_idle_slots == 0) {
  2506. health["status"] = "no slot available";
  2507. if (req.has_param("fail_on_no_slot")) {
  2508. res.status = 503; // HTTP Service Unavailable
  2509. }
  2510. }
  2511. res.set_content(health.dump(), "application/json");
  2512. break;
  2513. }
  2514. case SERVER_STATE_LOADING_MODEL:
  2515. char buf[128];
  2516. snprintf(&buf[0], 128, R"({"status": "loading model", "progress": %0.2f})", llama.modelProgress);
  2517. res.set_content(buf, "application/json");
  2518. res.status = 503; // HTTP Service Unavailable
  2519. break;
  2520. case SERVER_STATE_ERROR:
  2521. res.set_content(R"({"status": "error", "error": "Model failed to load"})", "application/json");
  2522. res.status = 500; // HTTP Internal Server Error
  2523. break;
  2524. }
  2525. });
  2526. if (sparams.slots_endpoint) {
  2527. svr.Get("/slots", [&](const httplib::Request&, httplib::Response& res) {
  2528. // request slots data using task queue
  2529. task_server task;
  2530. task.id = llama.queue_tasks.get_new_id();
  2531. task.type = TASK_TYPE_METRICS;
  2532. task.target_id = -1;
  2533. llama.queue_results.add_waiting_task_id(task.id);
  2534. llama.queue_tasks.post(task);
  2535. // get the result
  2536. task_result result = llama.queue_results.recv(task.id);
  2537. llama.queue_results.remove_waiting_task_id(task.id);
  2538. res.set_content(result.result_json["slots"].dump(), "application/json");
  2539. res.status = 200; // HTTP OK
  2540. });
  2541. }
  2542. if (sparams.metrics_endpoint) {
  2543. svr.Get("/metrics", [&](const httplib::Request&, httplib::Response& res) {
  2544. // request slots data using task queue
  2545. task_server task;
  2546. task.id = llama.queue_tasks.get_new_id();
  2547. task.type = TASK_TYPE_METRICS;
  2548. task.target_id = -1;
  2549. llama.queue_results.add_waiting_task_id(task.id);
  2550. llama.queue_tasks.post(task);
  2551. // get the result
  2552. task_result result = llama.queue_results.recv(task.id);
  2553. llama.queue_results.remove_waiting_task_id(task.id);
  2554. json data = result.result_json;
  2555. uint64_t n_prompt_tokens_processed = data["n_prompt_tokens_processed"];
  2556. uint64_t t_prompt_processing = data["t_prompt_processing"];
  2557. uint64_t n_tokens_predicted = data["n_tokens_predicted"];
  2558. uint64_t t_tokens_generation = data["t_tokens_generation"];
  2559. int32_t kv_cache_used_cells = data["kv_cache_used_cells"];
  2560. // metrics definition: https://prometheus.io/docs/practices/naming/#metric-names
  2561. json all_metrics_def = json {
  2562. {"counter", {{
  2563. {"name", "prompt_tokens_total"},
  2564. {"help", "Number of prompt tokens processed."},
  2565. {"value", data["n_prompt_tokens_processed_total"]}
  2566. }, {
  2567. {"name", "tokens_predicted_total"},
  2568. {"help", "Number of generation tokens processed."},
  2569. {"value", data["n_tokens_predicted_total"]}
  2570. }}},
  2571. {"gauge", {{
  2572. {"name", "prompt_tokens_seconds"},
  2573. {"help", "Average prompt throughput in tokens/s."},
  2574. {"value", n_prompt_tokens_processed ? 1e3 / t_prompt_processing * n_prompt_tokens_processed : 0}
  2575. },{
  2576. {"name", "predicted_tokens_seconds"},
  2577. {"help", "Average generation throughput in tokens/s."},
  2578. {"value", n_tokens_predicted ? 1e3 / t_tokens_generation * n_tokens_predicted : 0}
  2579. },{
  2580. {"name", "kv_cache_usage_ratio"},
  2581. {"help", "KV-cache usage. 1 means 100 percent usage."},
  2582. {"value", 1. * kv_cache_used_cells / params.n_ctx}
  2583. },{
  2584. {"name", "kv_cache_tokens"},
  2585. {"help", "KV-cache tokens."},
  2586. {"value", data["kv_cache_tokens_count"]}
  2587. },{
  2588. {"name", "requests_processing"},
  2589. {"help", "Number of request processing."},
  2590. {"value", data["processing"]}
  2591. },{
  2592. {"name", "requests_deferred"},
  2593. {"help", "Number of request deferred."},
  2594. {"value", data["deferred"]}
  2595. }}}
  2596. };
  2597. std::stringstream prometheus;
  2598. for (const auto& el : all_metrics_def.items()) {
  2599. const auto& type = el.key();
  2600. const auto& metrics_def = el.value();
  2601. for (const auto& metric_def : metrics_def) {
  2602. std::string name = metric_def["name"];
  2603. std::string help = metric_def["help"];
  2604. auto value = json_value(metric_def, "value", 0);
  2605. prometheus << "# HELP llamacpp:" << name << " " << help << "\n"
  2606. << "# TYPE llamacpp:" << name << " " << type << "\n"
  2607. << "llamacpp:" << name << " " << value << "\n";
  2608. }
  2609. }
  2610. res.set_content(prometheus.str(), "text/plain; version=0.0.4");
  2611. res.status = 200; // HTTP OK
  2612. });
  2613. }
  2614. svr.set_logger(log_server_request);
  2615. svr.set_exception_handler([](const httplib::Request &, httplib::Response &res, std::exception_ptr ep)
  2616. {
  2617. const char fmt[] = "500 Internal Server Error\n%s";
  2618. char buf[BUFSIZ];
  2619. try
  2620. {
  2621. std::rethrow_exception(std::move(ep));
  2622. }
  2623. catch (std::exception &e)
  2624. {
  2625. snprintf(buf, sizeof(buf), fmt, e.what());
  2626. }
  2627. catch (...)
  2628. {
  2629. snprintf(buf, sizeof(buf), fmt, "Unknown Exception");
  2630. }
  2631. res.set_content(buf, "text/plain; charset=utf-8");
  2632. res.status = 500;
  2633. });
  2634. svr.set_error_handler([](const httplib::Request &, httplib::Response &res)
  2635. {
  2636. if (res.status == 401)
  2637. {
  2638. res.set_content("Unauthorized", "text/plain; charset=utf-8");
  2639. }
  2640. if (res.status == 400)
  2641. {
  2642. res.set_content("Invalid request", "text/plain; charset=utf-8");
  2643. }
  2644. else if (res.status == 404)
  2645. {
  2646. res.set_content("File Not Found", "text/plain; charset=utf-8");
  2647. res.status = 404;
  2648. }
  2649. });
  2650. // set timeouts and change hostname and port
  2651. svr.set_read_timeout (sparams.read_timeout);
  2652. svr.set_write_timeout(sparams.write_timeout);
  2653. if (!svr.bind_to_port(sparams.hostname, sparams.port))
  2654. {
  2655. fprintf(stderr, "\ncouldn't bind to server socket: hostname=%s port=%d\n\n", sparams.hostname.c_str(), sparams.port);
  2656. return 1;
  2657. }
  2658. // Set the base directory for serving static files
  2659. svr.set_base_dir(sparams.public_path);
  2660. std::unordered_map<std::string, std::string> log_data;
  2661. log_data["hostname"] = sparams.hostname;
  2662. log_data["port"] = std::to_string(sparams.port);
  2663. if (sparams.api_keys.size() == 1) {
  2664. log_data["api_key"] = "api_key: ****" + sparams.api_keys[0].substr(sparams.api_keys[0].length() - 4);
  2665. } else if (sparams.api_keys.size() > 1) {
  2666. log_data["api_key"] = "api_key: " + std::to_string(sparams.api_keys.size()) + " keys loaded";
  2667. }
  2668. if (sparams.n_threads_http < 1) {
  2669. // +2 threads for monitoring endpoints
  2670. sparams.n_threads_http = std::max(params.n_parallel + 2, (int32_t) std::thread::hardware_concurrency() - 1);
  2671. }
  2672. log_data["n_threads_http"] = std::to_string(sparams.n_threads_http);
  2673. svr.new_task_queue = [&sparams] { return new httplib::ThreadPool(sparams.n_threads_http); };
  2674. LOG_INFO("HTTP server listening", log_data);
  2675. // run the HTTP server in a thread - see comment below
  2676. std::thread t([&]()
  2677. {
  2678. if (!svr.listen_after_bind())
  2679. {
  2680. state.store(SERVER_STATE_ERROR);
  2681. return 1;
  2682. }
  2683. return 0;
  2684. });
  2685. // load the model
  2686. params.progress_callback = update_load_progress;
  2687. params.progress_callback_user_data = (void*)&llama;
  2688. if (!llama.load_model(params))
  2689. {
  2690. state.store(SERVER_STATE_ERROR);
  2691. return 1;
  2692. } else {
  2693. llama.initialize();
  2694. state.store(SERVER_STATE_READY);
  2695. LOG_INFO("model loaded", {});
  2696. }
  2697. const auto model_meta = llama.model_meta();
  2698. // Middleware for API key validation
  2699. auto validate_api_key = [&sparams](const httplib::Request &req, httplib::Response &res) -> bool {
  2700. // If API key is not set, skip validation
  2701. if (sparams.api_keys.empty()) {
  2702. return true;
  2703. }
  2704. // Check for API key in the header
  2705. auto auth_header = req.get_header_value("Authorization");
  2706. std::string prefix = "Bearer ";
  2707. if (auth_header.substr(0, prefix.size()) == prefix) {
  2708. std::string received_api_key = auth_header.substr(prefix.size());
  2709. if (std::find(sparams.api_keys.begin(), sparams.api_keys.end(), received_api_key) != sparams.api_keys.end()) {
  2710. return true; // API key is valid
  2711. }
  2712. }
  2713. // API key is invalid or not provided
  2714. res.set_content("Unauthorized: Invalid API Key", "text/plain; charset=utf-8");
  2715. res.status = 401; // Unauthorized
  2716. LOG_WARNING("Unauthorized: Invalid API Key", {});
  2717. return false;
  2718. };
  2719. // this is only called if no index.html is found in the public --path
  2720. svr.Get("/", [](const httplib::Request &, httplib::Response &res)
  2721. {
  2722. res.set_content("server running", "text/plain; charset=utf-8");
  2723. res.status = 200; // Unauthorized
  2724. return true;
  2725. });
  2726. svr.Post("/completion", [&llama, &validate_api_key](const httplib::Request &req, httplib::Response &res)
  2727. {
  2728. res.set_header("Access-Control-Allow-Origin", req.get_header_value("Origin"));
  2729. if (!validate_api_key(req, res)) {
  2730. return;
  2731. }
  2732. json data = json::parse(req.body);
  2733. const int task_id = llama.queue_tasks.get_new_id();
  2734. llama.queue_results.add_waiting_task_id(task_id);
  2735. llama.request_completion(task_id, data, false, -1);
  2736. if (!json_value(data, "stream", false)) {
  2737. std::string completion_text;
  2738. task_result result = llama.queue_results.recv(task_id);
  2739. if (!result.error && result.stop) {
  2740. res.set_content(result.result_json.dump(-1, ' ', false, json::error_handler_t::replace), "application/json; charset=utf-8");
  2741. }
  2742. else
  2743. {
  2744. res.status = 404;
  2745. res.set_content(result.result_json["content"], "text/plain; charset=utf-8");
  2746. }
  2747. llama.queue_results.remove_waiting_task_id(task_id);
  2748. } else {
  2749. const auto chunked_content_provider = [task_id, &llama](size_t, httplib::DataSink & sink)
  2750. {
  2751. while (true)
  2752. {
  2753. task_result result = llama.queue_results.recv(task_id);
  2754. if (!result.error) {
  2755. const std::string str =
  2756. "data: " +
  2757. result.result_json.dump(-1, ' ', false, json::error_handler_t::replace) +
  2758. "\n\n";
  2759. LOG_VERBOSE("data stream", {
  2760. { "to_send", str }
  2761. });
  2762. if (!sink.write(str.c_str(), str.size()))
  2763. {
  2764. llama.queue_results.remove_waiting_task_id(task_id);
  2765. return false;
  2766. }
  2767. if (result.stop) {
  2768. break;
  2769. }
  2770. } else {
  2771. const std::string str =
  2772. "error: " +
  2773. result.result_json.dump(-1, ' ', false, json::error_handler_t::replace) +
  2774. "\n\n";
  2775. LOG_VERBOSE("data stream", {
  2776. { "to_send", str }
  2777. });
  2778. if (!sink.write(str.c_str(), str.size()))
  2779. {
  2780. llama.queue_results.remove_waiting_task_id(task_id);
  2781. return false;
  2782. }
  2783. break;
  2784. }
  2785. }
  2786. llama.queue_results.remove_waiting_task_id(task_id);
  2787. sink.done();
  2788. return true;
  2789. };
  2790. auto on_complete = [task_id, &llama] (bool)
  2791. {
  2792. // cancel
  2793. llama.request_cancel(task_id);
  2794. llama.queue_results.remove_waiting_task_id(task_id);
  2795. };
  2796. res.set_chunked_content_provider("text/event-stream", chunked_content_provider, on_complete);
  2797. }
  2798. });
  2799. svr.Post("/tokenize", [&llama](const httplib::Request &req, httplib::Response &res)
  2800. {
  2801. res.set_header("Access-Control-Allow-Origin", req.get_header_value("Origin"));
  2802. const json body = json::parse(req.body);
  2803. std::vector<llama_token> tokens;
  2804. if (body.count("content") != 0)
  2805. {
  2806. tokens = llama.tokenize(body["content"], false);
  2807. }
  2808. const json data = format_tokenizer_response(tokens);
  2809. return res.set_content(data.dump(), "application/json; charset=utf-8");
  2810. });
  2811. svr.Post("/detokenize", [&llama](const httplib::Request &req, httplib::Response &res)
  2812. {
  2813. res.set_header("Access-Control-Allow-Origin", req.get_header_value("Origin"));
  2814. const json body = json::parse(req.body);
  2815. std::string content;
  2816. if (body.count("tokens") != 0)
  2817. {
  2818. const std::vector<llama_token> tokens = body["tokens"];
  2819. content = tokens_to_str(llama.ctx, tokens.cbegin(), tokens.cend());
  2820. }
  2821. const json data = format_detokenized_response(content);
  2822. return res.set_content(data.dump(), "application/json; charset=utf-8");
  2823. });
  2824. svr.Post("/embedding", [&llama](const httplib::Request &req, httplib::Response &res)
  2825. {
  2826. res.set_header("Access-Control-Allow-Origin", req.get_header_value("Origin"));
  2827. const json body = json::parse(req.body);
  2828. json prompt;
  2829. if (body.count("content") != 0)
  2830. {
  2831. prompt = body["content"];
  2832. }
  2833. else
  2834. {
  2835. prompt = "";
  2836. }
  2837. // create and queue the task
  2838. const int task_id = llama.queue_tasks.get_new_id();
  2839. llama.queue_results.add_waiting_task_id(task_id);
  2840. llama.request_completion(task_id, {{"prompt", prompt}}, true, -1);
  2841. // get the result
  2842. task_result result = llama.queue_results.recv(task_id);
  2843. llama.queue_results.remove_waiting_task_id(task_id);
  2844. // send the result
  2845. return res.set_content(result.result_json.dump(), "application/json; charset=utf-8");
  2846. });
  2847. // GG: if I put the main loop inside a thread, it crashes on the first request when build in Debug!?
  2848. // "Bus error: 10" - this is on macOS, it does not crash on Linux
  2849. //std::thread t2([&]()
  2850. /*{
  2851. bool running = true;
  2852. while (running)
  2853. {
  2854. running = llama.update_slots();
  2855. }
  2856. }*/
  2857. //);
  2858. llama.queue_tasks.on_new_task(std::bind(
  2859. &llama_server_context::process_single_task, &llama, std::placeholders::_1));
  2860. llama.queue_tasks.on_finish_multitask(std::bind(
  2861. &llama_server_context::on_finish_multitask, &llama, std::placeholders::_1));
  2862. llama.queue_tasks.on_run_slots(std::bind(
  2863. &llama_server_context::update_slots, &llama));
  2864. llama.queue_results.on_multitask_update(std::bind(
  2865. &llama_server_queue::update_multitask,
  2866. &llama.queue_tasks,
  2867. std::placeholders::_1,
  2868. std::placeholders::_2,
  2869. std::placeholders::_3
  2870. ));
  2871. shutdown_handler = [&](int) {
  2872. llama.queue_tasks.terminate();
  2873. };
  2874. #if defined (__unix__) || (defined (__APPLE__) && defined (__MACH__))
  2875. struct sigaction sigint_action;
  2876. sigint_action.sa_handler = signal_handler;
  2877. sigemptyset (&sigint_action.sa_mask);
  2878. sigint_action.sa_flags = 0;
  2879. sigaction(SIGINT, &sigint_action, NULL);
  2880. #elif defined (_WIN32)
  2881. auto console_ctrl_handler = +[](DWORD ctrl_type) -> BOOL {
  2882. return (ctrl_type == CTRL_C_EVENT) ? (signal_handler(SIGINT), true) : false;
  2883. };
  2884. SetConsoleCtrlHandler(reinterpret_cast<PHANDLER_ROUTINE>(console_ctrl_handler), true);
  2885. for (int i = 0; i < argc; ++i) {
  2886. delete[] argv[i];
  2887. }
  2888. delete[] argv;
  2889. #endif
  2890. llama.queue_tasks.start_loop();
  2891. svr.stop();
  2892. t.join();
  2893. llama_backend_free();
  2894. return 0;
  2895. }