server.cpp 115 KB

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