server.cpp 116 KB

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