server.cpp 63 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780
  1. #include "common.h"
  2. #include "llama.h"
  3. #include "build-info.h"
  4. #include "grammar-parser.h"
  5. #ifndef NDEBUG
  6. // crash the server in debug mode, otherwise send an http 500 error
  7. #define CPPHTTPLIB_NO_EXCEPTIONS 1
  8. #endif
  9. #include "httplib.h"
  10. #include "json.hpp"
  11. // auto generated files (update with ./deps.sh)
  12. #include "index.html.hpp"
  13. #include "index.js.hpp"
  14. #include "completion.js.hpp"
  15. #include "json-schema-to-grammar.mjs.hpp"
  16. #include <cstddef>
  17. #ifndef SERVER_VERBOSE
  18. #define SERVER_VERBOSE 1
  19. #endif
  20. using namespace httplib;
  21. using json = nlohmann::json;
  22. struct server_params
  23. {
  24. std::string hostname = "127.0.0.1";
  25. std::string public_path = "examples/server/public";
  26. int32_t port = 8080;
  27. int32_t read_timeout = 600;
  28. int32_t write_timeout = 600;
  29. };
  30. // completion token output with probabilities
  31. struct completion_token_output
  32. {
  33. struct token_prob
  34. {
  35. llama_token tok;
  36. float prob;
  37. };
  38. std::vector<token_prob> probs;
  39. llama_token tok;
  40. };
  41. static size_t common_part(const std::vector<llama_token> &a, const std::vector<llama_token> &b)
  42. {
  43. size_t i;
  44. for (i = 0; i < a.size() && i < b.size() && a[i] == b[i]; i++)
  45. {
  46. }
  47. return i;
  48. }
  49. enum stop_type
  50. {
  51. STOP_FULL,
  52. STOP_PARTIAL,
  53. };
  54. static bool ends_with(const std::string &str, const std::string &suffix)
  55. {
  56. return str.size() >= suffix.size() &&
  57. 0 == str.compare(str.size() - suffix.size(), suffix.size(), suffix);
  58. }
  59. static size_t find_partial_stop_string(const std::string &stop,
  60. const std::string &text)
  61. {
  62. if (!text.empty() && !stop.empty())
  63. {
  64. const char text_last_char = text.back();
  65. for (int64_t char_index = stop.size() - 1; char_index >= 0; char_index--)
  66. {
  67. if (stop[char_index] == text_last_char)
  68. {
  69. const std::string current_partial = stop.substr(0, char_index + 1);
  70. if (ends_with(text, current_partial))
  71. {
  72. return text.size() - char_index - 1;
  73. }
  74. }
  75. }
  76. }
  77. return std::string::npos;
  78. }
  79. template <class Iter>
  80. static std::string tokens_to_str(llama_context *ctx, Iter begin, Iter end)
  81. {
  82. std::string ret;
  83. for (; begin != end; ++begin)
  84. {
  85. ret += llama_token_to_piece(ctx, *begin);
  86. }
  87. return ret;
  88. }
  89. static void server_log(const char *level, const char *function, int line,
  90. const char *message, const nlohmann::ordered_json &extra)
  91. {
  92. nlohmann::ordered_json log{
  93. {"timestamp", time(nullptr)},
  94. {"level", level},
  95. {"function", function},
  96. {"line", line},
  97. {"message", message},
  98. };
  99. if (!extra.empty())
  100. {
  101. log.merge_patch(extra);
  102. }
  103. const std::string str = log.dump(-1, ' ', false, json::error_handler_t::replace);
  104. printf("%.*s\n", (int)str.size(), str.data());
  105. fflush(stdout);
  106. }
  107. // format incomplete utf-8 multibyte character for output
  108. static std::string tokens_to_output_formatted_string(const llama_context *ctx, const llama_token token)
  109. {
  110. std::string out = token == -1 ? "" : llama_token_to_piece(ctx, token);
  111. // if the size is 1 and first bit is 1, meaning it's a partial character
  112. // (size > 1 meaning it's already a known token)
  113. if (out.size() == 1 && (out[0] & 0x80) == 0x80)
  114. {
  115. std::stringstream ss;
  116. ss << std::hex << (out[0] & 0xff);
  117. std::string res(ss.str());
  118. out = "byte: \\x" + res;
  119. }
  120. return out;
  121. }
  122. // convert a vector of completion_token_output to json
  123. static json probs_vector_to_json(const llama_context *ctx, const std::vector<completion_token_output> & probs)
  124. {
  125. json out = json::array();
  126. for (const auto &prob : probs)
  127. {
  128. json probs_for_token = json::array();
  129. for (const auto &p : prob.probs)
  130. {
  131. std::string tok_str = tokens_to_output_formatted_string(ctx, p.tok);
  132. probs_for_token.push_back(json{
  133. {"tok_str", tok_str},
  134. {"prob", p.prob},
  135. });
  136. }
  137. std::string tok_str = tokens_to_output_formatted_string(ctx, prob.tok);
  138. out.push_back(json{
  139. {"content", tok_str},
  140. {"probs", probs_for_token},
  141. });
  142. }
  143. return out;
  144. }
  145. static bool server_verbose = false;
  146. #if SERVER_VERBOSE != 1
  147. #define LOG_VERBOSE(MSG, ...)
  148. #else
  149. #define LOG_VERBOSE(MSG, ...) \
  150. do \
  151. { \
  152. if (server_verbose) \
  153. { \
  154. server_log("VERBOSE", __func__, __LINE__, MSG, __VA_ARGS__); \
  155. } \
  156. } while (0)
  157. #endif
  158. #define LOG_ERROR(MSG, ...) server_log("ERROR", __func__, __LINE__, MSG, __VA_ARGS__)
  159. #define LOG_WARNING(MSG, ...) server_log("WARNING", __func__, __LINE__, MSG, __VA_ARGS__)
  160. #define LOG_INFO(MSG, ...) server_log("INFO", __func__, __LINE__, MSG, __VA_ARGS__)
  161. struct llama_server_context
  162. {
  163. bool stream = false;
  164. bool has_next_token = false;
  165. std::string generated_text;
  166. std::vector<completion_token_output> generated_token_probs;
  167. size_t num_prompt_tokens = 0;
  168. size_t num_tokens_predicted = 0;
  169. size_t n_past = 0;
  170. size_t n_remain = 0;
  171. json prompt;
  172. std::vector<llama_token> embd;
  173. std::vector<llama_token> last_n_tokens;
  174. llama_model *model = nullptr;
  175. llama_context *ctx = nullptr;
  176. gpt_params params;
  177. int n_ctx;
  178. grammar_parser::parse_state parsed_grammar;
  179. llama_grammar *grammar = nullptr;
  180. bool truncated = false;
  181. bool stopped_eos = false;
  182. bool stopped_word = false;
  183. bool stopped_limit = false;
  184. std::string stopping_word;
  185. int32_t multibyte_pending = 0;
  186. std::mutex mutex;
  187. std::unique_lock<std::mutex> lock()
  188. {
  189. return std::unique_lock<std::mutex>(mutex);
  190. }
  191. ~llama_server_context()
  192. {
  193. if (ctx)
  194. {
  195. llama_free(ctx);
  196. ctx = nullptr;
  197. }
  198. if (model)
  199. {
  200. llama_free_model(model);
  201. model = nullptr;
  202. }
  203. }
  204. void rewind()
  205. {
  206. params.antiprompt.clear();
  207. params.grammar.clear();
  208. num_prompt_tokens = 0;
  209. num_tokens_predicted = 0;
  210. generated_text = "";
  211. generated_text.reserve(n_ctx);
  212. generated_token_probs.clear();
  213. truncated = false;
  214. stopped_eos = false;
  215. stopped_word = false;
  216. stopped_limit = false;
  217. stopping_word = "";
  218. multibyte_pending = 0;
  219. n_remain = 0;
  220. n_past = 0;
  221. if (grammar != nullptr) {
  222. llama_grammar_free(grammar);
  223. grammar = nullptr;
  224. }
  225. }
  226. bool loadModel(const gpt_params &params_)
  227. {
  228. params = params_;
  229. std::tie(model, ctx) = llama_init_from_gpt_params(params);
  230. if (model == nullptr)
  231. {
  232. LOG_ERROR("unable to load model", {{"model", params_.model}});
  233. return false;
  234. }
  235. n_ctx = llama_n_ctx(ctx);
  236. last_n_tokens.resize(n_ctx);
  237. std::fill(last_n_tokens.begin(), last_n_tokens.end(), 0);
  238. return true;
  239. }
  240. std::vector<llama_token> tokenize(const json & json_prompt, bool add_bos) const
  241. {
  242. // If `add_bos` is true, we only add BOS, when json_prompt is a string,
  243. // or the first element of the json_prompt array is a string.
  244. std::vector<llama_token> prompt_tokens;
  245. if (json_prompt.is_array())
  246. {
  247. bool first = true;
  248. for (const auto& p : json_prompt)
  249. {
  250. if (p.is_string())
  251. {
  252. auto s = p.template get<std::string>();
  253. std::vector<llama_token> p;
  254. if (first)
  255. {
  256. p = ::llama_tokenize(ctx, s, add_bos);
  257. first = false;
  258. }
  259. else
  260. {
  261. p = ::llama_tokenize(ctx, s, false);
  262. }
  263. prompt_tokens.insert(prompt_tokens.end(), p.begin(), p.end());
  264. }
  265. else
  266. {
  267. if (first)
  268. {
  269. first = false;
  270. }
  271. prompt_tokens.push_back(p.template get<llama_token>());
  272. }
  273. }
  274. }
  275. else
  276. {
  277. auto s = json_prompt.template get<std::string>();
  278. prompt_tokens = ::llama_tokenize(ctx, s, add_bos);
  279. }
  280. return prompt_tokens;
  281. }
  282. bool loadGrammar()
  283. {
  284. if (!params.grammar.empty()) {
  285. parsed_grammar = grammar_parser::parse(params.grammar.c_str());
  286. // will be empty (default) if there are parse errors
  287. if (parsed_grammar.rules.empty()) {
  288. LOG_ERROR("grammar parse error", {{"grammar", params.grammar}});
  289. return false;
  290. }
  291. grammar_parser::print_grammar(stderr, parsed_grammar);
  292. {
  293. auto it = params.logit_bias.find(llama_token_eos(ctx));
  294. if (it != params.logit_bias.end() && it->second == -INFINITY) {
  295. LOG_WARNING("EOS token is disabled, which will cause most grammars to fail", {});
  296. }
  297. }
  298. std::vector<const llama_grammar_element *> grammar_rules(parsed_grammar.c_rules());
  299. grammar = llama_grammar_init(
  300. grammar_rules.data(), grammar_rules.size(), parsed_grammar.symbol_ids.at("root"));
  301. }
  302. return true;
  303. }
  304. void loadInfill()
  305. {
  306. bool suff_rm_leading_spc = true;
  307. if (params.input_suffix.find_first_of(" ") == 0 && params.input_suffix.size() > 1) {
  308. params.input_suffix.erase(0, 1);
  309. suff_rm_leading_spc = false;
  310. }
  311. auto prefix_tokens = tokenize(params.input_prefix, false);
  312. auto suffix_tokens = tokenize(params.input_suffix, false);
  313. const int space_token = 29871;
  314. if (suff_rm_leading_spc && suffix_tokens[0] == space_token) {
  315. suffix_tokens.erase(suffix_tokens.begin());
  316. }
  317. prefix_tokens.insert(prefix_tokens.begin(), llama_token_prefix(ctx));
  318. prefix_tokens.insert(prefix_tokens.begin(), llama_token_bos(ctx)); // always add BOS
  319. prefix_tokens.insert(prefix_tokens.end(), llama_token_suffix(ctx));
  320. prefix_tokens.insert(prefix_tokens.end(), suffix_tokens.begin(), suffix_tokens.end());
  321. prefix_tokens.push_back(llama_token_middle(ctx));
  322. auto prompt_tokens = prefix_tokens;
  323. num_prompt_tokens = prompt_tokens.size();
  324. if (params.n_keep < 0)
  325. {
  326. params.n_keep = (int)num_prompt_tokens;
  327. }
  328. params.n_keep = std::min(params.n_ctx - 4, params.n_keep);
  329. // if input prompt is too big, truncate like normal
  330. if (num_prompt_tokens >= (size_t)params.n_ctx)
  331. {
  332. printf("Input prompt is too big, truncating. Can only take %d tokens but got %zu\n", params.n_ctx, num_prompt_tokens);
  333. // todo we probably want to cut from both sides
  334. const int n_left = (params.n_ctx - params.n_keep) / 2;
  335. std::vector<llama_token> new_tokens(prompt_tokens.begin(), prompt_tokens.begin() + params.n_keep);
  336. const int erased_blocks = (num_prompt_tokens - params.n_keep - n_left - 1) / n_left;
  337. new_tokens.insert(new_tokens.end(), prompt_tokens.begin() + params.n_keep + erased_blocks * n_left, prompt_tokens.end());
  338. std::copy(prompt_tokens.end() - params.n_ctx, prompt_tokens.end(), last_n_tokens.begin());
  339. LOG_VERBOSE("input truncated", {
  340. {"n_ctx", params.n_ctx},
  341. {"n_keep", params.n_keep},
  342. {"n_left", n_left},
  343. {"new_tokens", tokens_to_str(ctx, new_tokens.cbegin(), new_tokens.cend())},
  344. });
  345. truncated = true;
  346. prompt_tokens = new_tokens;
  347. }
  348. else
  349. {
  350. const size_t ps = num_prompt_tokens;
  351. std::fill(last_n_tokens.begin(), last_n_tokens.end() - ps, 0);
  352. std::copy(prompt_tokens.begin(), prompt_tokens.end(), last_n_tokens.end() - ps);
  353. }
  354. // compare the evaluated prompt with the new prompt
  355. n_past = common_part(embd, prompt_tokens);
  356. embd = prompt_tokens;
  357. if (n_past == num_prompt_tokens)
  358. {
  359. // we have to evaluate at least 1 token to generate logits.
  360. printf("we have to evaluate at least 1 token to generate logits\n");
  361. n_past--;
  362. }
  363. LOG_VERBOSE("prompt ingested", {
  364. {"n_past", n_past},
  365. {"cached", tokens_to_str(ctx, embd.cbegin(), embd.cbegin() + n_past)},
  366. {"to_eval", tokens_to_str(ctx, embd.cbegin() + n_past, embd.cend())},
  367. });
  368. has_next_token = true;
  369. }
  370. void loadPrompt()
  371. {
  372. auto prompt_tokens = tokenize(prompt, true); // always add BOS
  373. num_prompt_tokens = prompt_tokens.size();
  374. if (params.n_keep < 0)
  375. {
  376. params.n_keep = (int)num_prompt_tokens;
  377. }
  378. params.n_keep = std::min(n_ctx - 4, params.n_keep);
  379. // if input prompt is too big, truncate like normal
  380. if (num_prompt_tokens >= (size_t)n_ctx)
  381. {
  382. const int n_left = (n_ctx - params.n_keep) / 2;
  383. std::vector<llama_token> new_tokens(prompt_tokens.begin(), prompt_tokens.begin() + params.n_keep);
  384. const int erased_blocks = (num_prompt_tokens - params.n_keep - n_left - 1) / n_left;
  385. new_tokens.insert(new_tokens.end(), prompt_tokens.begin() + params.n_keep + erased_blocks * n_left, prompt_tokens.end());
  386. std::copy(prompt_tokens.end() - n_ctx, prompt_tokens.end(), last_n_tokens.begin());
  387. LOG_VERBOSE("input truncated", {
  388. {"n_ctx", n_ctx},
  389. {"n_keep", params.n_keep},
  390. {"n_left", n_left},
  391. {"new_tokens", tokens_to_str(ctx, new_tokens.cbegin(), new_tokens.cend())},
  392. });
  393. truncated = true;
  394. prompt_tokens = new_tokens;
  395. }
  396. else
  397. {
  398. const size_t ps = num_prompt_tokens;
  399. std::fill(last_n_tokens.begin(), last_n_tokens.end() - ps, 0);
  400. std::copy(prompt_tokens.begin(), prompt_tokens.end(), last_n_tokens.end() - ps);
  401. }
  402. // compare the evaluated prompt with the new prompt
  403. n_past = common_part(embd, prompt_tokens);
  404. // since #3228 we now have to manually manage the KV cache
  405. llama_kv_cache_seq_rm(ctx, 0, n_past, -1);
  406. embd = prompt_tokens;
  407. if (n_past == num_prompt_tokens)
  408. {
  409. // we have to evaluate at least 1 token to generate logits.
  410. n_past--;
  411. }
  412. LOG_VERBOSE("prompt ingested", {
  413. {"n_past", n_past},
  414. {"cached", tokens_to_str(ctx, embd.cbegin(), embd.cbegin() + n_past)},
  415. {"to_eval", tokens_to_str(ctx, embd.cbegin() + n_past, embd.cend())},
  416. });
  417. has_next_token = true;
  418. }
  419. void beginCompletion()
  420. {
  421. // number of tokens to keep when resetting context
  422. n_remain = params.n_predict;
  423. llama_set_rng_seed(ctx, params.seed);
  424. }
  425. completion_token_output nextToken()
  426. {
  427. completion_token_output result;
  428. result.tok = -1;
  429. if (embd.size() >= (size_t)n_ctx)
  430. {
  431. // Shift context
  432. const int n_left = n_past - params.n_keep - 1;
  433. const int n_discard = n_left/2;
  434. llama_kv_cache_seq_rm (ctx, 0, params.n_keep + 1 , params.n_keep + n_discard + 1);
  435. llama_kv_cache_seq_shift(ctx, 0, params.n_keep + 1 + n_discard, n_past, -n_discard);
  436. for (size_t i = params.n_keep + 1 + n_discard; i < embd.size(); i++)
  437. {
  438. embd[i - n_discard] = embd[i];
  439. }
  440. embd.resize(embd.size() - n_discard);
  441. n_past -= n_discard;
  442. truncated = true;
  443. LOG_VERBOSE("input truncated", {
  444. {"n_ctx", n_ctx},
  445. {"n_keep", params.n_keep},
  446. {"n_left", n_left},
  447. });
  448. }
  449. bool tg = true;
  450. while (n_past < embd.size())
  451. {
  452. int n_eval = (int)embd.size() - n_past;
  453. tg = n_eval == 1;
  454. if (n_eval > params.n_batch)
  455. {
  456. n_eval = params.n_batch;
  457. }
  458. if (llama_decode(ctx, llama_batch_get_one(&embd[n_past], n_eval, n_past, 0)))
  459. {
  460. LOG_ERROR("failed to eval", {
  461. {"n_eval", n_eval},
  462. {"n_past", n_past},
  463. {"embd", tokens_to_str(ctx, embd.cbegin() + n_past, embd.cend())},
  464. });
  465. has_next_token = false;
  466. return result;
  467. }
  468. n_past += n_eval;
  469. }
  470. if (params.n_predict == 0)
  471. {
  472. has_next_token = false;
  473. result.tok = llama_token_eos(ctx);
  474. return result;
  475. }
  476. {
  477. // out of user input, sample next token
  478. std::vector<llama_token_data> candidates;
  479. candidates.reserve(llama_n_vocab(model));
  480. result.tok = llama_sample_token(ctx, NULL, grammar, params, last_n_tokens, candidates);
  481. llama_token_data_array candidates_p = { candidates.data(), candidates.size(), false };
  482. const int32_t n_probs = params.n_probs;
  483. if (params.temp <= 0 && n_probs > 0)
  484. {
  485. // For llama_sample_token_greedy we need to sort candidates
  486. llama_sample_softmax(ctx, &candidates_p);
  487. }
  488. for (size_t i = 0; i < std::min(candidates_p.size, (size_t)n_probs); ++i)
  489. {
  490. result.probs.push_back({candidates_p.data[i].id, candidates_p.data[i].p});
  491. }
  492. last_n_tokens.erase(last_n_tokens.begin());
  493. last_n_tokens.push_back(result.tok);
  494. if (tg) {
  495. num_tokens_predicted++;
  496. }
  497. }
  498. // add it to the context
  499. embd.push_back(result.tok);
  500. // decrement remaining sampling budget
  501. --n_remain;
  502. if (!embd.empty() && embd.back() == llama_token_eos(ctx))
  503. {
  504. // stopping_word = llama_token_to_piece(ctx, embd.back());
  505. has_next_token = false;
  506. stopped_eos = true;
  507. LOG_VERBOSE("eos token found", {});
  508. return result;
  509. }
  510. has_next_token = params.n_predict == -1 || n_remain != 0;
  511. return result;
  512. }
  513. size_t findStoppingStrings(const std::string &text, const size_t last_token_size,
  514. const stop_type type)
  515. {
  516. size_t stop_pos = std::string::npos;
  517. for (const std::string &word : params.antiprompt)
  518. {
  519. size_t pos;
  520. if (type == STOP_FULL)
  521. {
  522. const size_t tmp = word.size() + last_token_size;
  523. const size_t from_pos = text.size() > tmp ? text.size() - tmp : 0;
  524. pos = text.find(word, from_pos);
  525. }
  526. else
  527. {
  528. pos = find_partial_stop_string(word, text);
  529. }
  530. if (pos != std::string::npos &&
  531. (stop_pos == std::string::npos || pos < stop_pos))
  532. {
  533. if (type == STOP_FULL)
  534. {
  535. stopping_word = word;
  536. stopped_word = true;
  537. has_next_token = false;
  538. }
  539. stop_pos = pos;
  540. }
  541. }
  542. return stop_pos;
  543. }
  544. completion_token_output doCompletion()
  545. {
  546. auto token_with_probs = nextToken();
  547. const std::string token_text = token_with_probs.tok == -1 ? "" : llama_token_to_piece(ctx, token_with_probs.tok);
  548. generated_text += token_text;
  549. if (params.n_probs > 0)
  550. {
  551. generated_token_probs.push_back(token_with_probs);
  552. }
  553. if (multibyte_pending > 0)
  554. {
  555. multibyte_pending -= token_text.size();
  556. }
  557. else if (token_text.size() == 1)
  558. {
  559. const char c = token_text[0];
  560. // 2-byte characters: 110xxxxx 10xxxxxx
  561. if ((c & 0xE0) == 0xC0)
  562. {
  563. multibyte_pending = 1;
  564. // 3-byte characters: 1110xxxx 10xxxxxx 10xxxxxx
  565. }
  566. else if ((c & 0xF0) == 0xE0)
  567. {
  568. multibyte_pending = 2;
  569. // 4-byte characters: 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx
  570. }
  571. else if ((c & 0xF8) == 0xF0)
  572. {
  573. multibyte_pending = 3;
  574. }
  575. else
  576. {
  577. multibyte_pending = 0;
  578. }
  579. }
  580. if (multibyte_pending > 0 && !has_next_token)
  581. {
  582. has_next_token = true;
  583. n_remain++;
  584. }
  585. if (!has_next_token && n_remain == 0)
  586. {
  587. stopped_limit = true;
  588. }
  589. LOG_VERBOSE("next token", {
  590. {"token", token_with_probs.tok},
  591. {"token_text", tokens_to_output_formatted_string(ctx, token_with_probs.tok)},
  592. {"has_next_token", has_next_token},
  593. {"n_remain", n_remain},
  594. {"num_tokens_predicted", num_tokens_predicted},
  595. {"stopped_eos", stopped_eos},
  596. {"stopped_word", stopped_word},
  597. {"stopped_limit", stopped_limit},
  598. {"stopping_word", stopping_word},
  599. });
  600. return token_with_probs;
  601. }
  602. std::vector<float> getEmbedding()
  603. {
  604. static const int n_embd = llama_n_embd(model);
  605. if (!params.embedding)
  606. {
  607. LOG_WARNING("embedding disabled", {
  608. {"params.embedding", params.embedding},
  609. });
  610. return std::vector<float>(n_embd, 0.0f);
  611. }
  612. const float *data = llama_get_embeddings(ctx);
  613. std::vector<float> embedding(data, data + n_embd);
  614. return embedding;
  615. }
  616. };
  617. static void server_print_usage(const char *argv0, const gpt_params &params,
  618. const server_params &sparams)
  619. {
  620. printf("usage: %s [options]\n", argv0);
  621. printf("\n");
  622. printf("options:\n");
  623. printf(" -h, --help show this help message and exit\n");
  624. printf(" -v, --verbose verbose output (default: %s)\n", server_verbose ? "enabled" : "disabled");
  625. printf(" -t N, --threads N number of threads to use during computation (default: %d)\n", params.n_threads);
  626. printf(" -c N, --ctx-size N size of the prompt context (default: %d)\n", params.n_ctx);
  627. printf(" --rope-freq-base N RoPE base frequency (default: loaded from model)\n");
  628. printf(" --rope-freq-scale N RoPE frequency scaling factor (default: loaded from model)\n");
  629. printf(" -b N, --batch-size N batch size for prompt processing (default: %d)\n", params.n_batch);
  630. printf(" --memory-f32 use f32 instead of f16 for memory key+value (default: disabled)\n");
  631. printf(" not recommended: doubles context memory required and no measurable increase in quality\n");
  632. if (llama_mlock_supported())
  633. {
  634. printf(" --mlock force system to keep model in RAM rather than swapping or compressing\n");
  635. }
  636. if (llama_mmap_supported())
  637. {
  638. printf(" --no-mmap do not memory-map model (slower load but may reduce pageouts if not using mlock)\n");
  639. }
  640. printf(" --numa attempt optimizations that help on some NUMA systems\n");
  641. #ifdef LLAMA_SUPPORTS_GPU_OFFLOAD
  642. printf(" -ngl N, --n-gpu-layers N\n");
  643. printf(" number of layers to store in VRAM\n");
  644. printf(" -ts SPLIT --tensor-split SPLIT\n");
  645. printf(" how to split tensors across multiple GPUs, comma-separated list of proportions, e.g. 3,1\n");
  646. printf(" -mg i, --main-gpu i the GPU to use for scratch and small tensors\n");
  647. printf(" -nommq, --no-mul-mat-q\n");
  648. printf(" use cuBLAS instead of custom mul_mat_q CUDA kernels.\n");
  649. printf(" Not recommended since this is both slower and uses more VRAM.\n");
  650. #endif
  651. printf(" -m FNAME, --model FNAME\n");
  652. printf(" model path (default: %s)\n", params.model.c_str());
  653. printf(" -a ALIAS, --alias ALIAS\n");
  654. printf(" set an alias for the model, will be added as `model` field in completion response\n");
  655. printf(" --lora FNAME apply LoRA adapter (implies --no-mmap)\n");
  656. printf(" --lora-base FNAME optional model to use as a base for the layers modified by the LoRA adapter\n");
  657. printf(" --host ip address to listen (default (default: %s)\n", sparams.hostname.c_str());
  658. printf(" --port PORT port to listen (default (default: %d)\n", sparams.port);
  659. printf(" --path PUBLIC_PATH path from which to serve static files (default %s)\n", sparams.public_path.c_str());
  660. printf(" -to N, --timeout N server read/write timeout in seconds (default: %d)\n", sparams.read_timeout);
  661. printf(" --embedding enable embedding vector output (default: %s)\n", params.embedding ? "enabled" : "disabled");
  662. printf("\n");
  663. }
  664. static void server_params_parse(int argc, char **argv, server_params &sparams,
  665. gpt_params &params)
  666. {
  667. gpt_params default_params;
  668. server_params default_sparams;
  669. std::string arg;
  670. bool invalid_param = false;
  671. for (int i = 1; i < argc; i++)
  672. {
  673. arg = argv[i];
  674. if (arg == "--port")
  675. {
  676. if (++i >= argc)
  677. {
  678. invalid_param = true;
  679. break;
  680. }
  681. sparams.port = std::stoi(argv[i]);
  682. }
  683. else if (arg == "--host")
  684. {
  685. if (++i >= argc)
  686. {
  687. invalid_param = true;
  688. break;
  689. }
  690. sparams.hostname = argv[i];
  691. }
  692. else if (arg == "--path")
  693. {
  694. if (++i >= argc)
  695. {
  696. invalid_param = true;
  697. break;
  698. }
  699. sparams.public_path = argv[i];
  700. }
  701. else if (arg == "--timeout" || arg == "-to")
  702. {
  703. if (++i >= argc)
  704. {
  705. invalid_param = true;
  706. break;
  707. }
  708. sparams.read_timeout = std::stoi(argv[i]);
  709. sparams.write_timeout = std::stoi(argv[i]);
  710. }
  711. else if (arg == "-m" || arg == "--model")
  712. {
  713. if (++i >= argc)
  714. {
  715. invalid_param = true;
  716. break;
  717. }
  718. params.model = argv[i];
  719. }
  720. else if (arg == "-a" || arg == "--alias")
  721. {
  722. if (++i >= argc)
  723. {
  724. invalid_param = true;
  725. break;
  726. }
  727. params.model_alias = argv[i];
  728. }
  729. else if (arg == "-h" || arg == "--help")
  730. {
  731. server_print_usage(argv[0], default_params, default_sparams);
  732. exit(0);
  733. }
  734. else if (arg == "-c" || arg == "--ctx-size" || arg == "--ctx_size")
  735. {
  736. if (++i >= argc)
  737. {
  738. invalid_param = true;
  739. break;
  740. }
  741. params.n_ctx = std::stoi(argv[i]);
  742. }
  743. else if (arg == "--rope-freq-base")
  744. {
  745. if (++i >= argc)
  746. {
  747. invalid_param = true;
  748. break;
  749. }
  750. params.rope_freq_base = std::stof(argv[i]);
  751. }
  752. else if (arg == "--rope-freq-scale")
  753. {
  754. if (++i >= argc)
  755. {
  756. invalid_param = true;
  757. break;
  758. }
  759. params.rope_freq_scale = std::stof(argv[i]);
  760. }
  761. else if (arg == "--memory-f32" || arg == "--memory_f32")
  762. {
  763. params.memory_f16 = false;
  764. }
  765. else if (arg == "--threads" || arg == "-t")
  766. {
  767. if (++i >= argc)
  768. {
  769. invalid_param = true;
  770. break;
  771. }
  772. params.n_threads = std::stoi(argv[i]);
  773. }
  774. else if (arg == "-b" || arg == "--batch-size")
  775. {
  776. if (++i >= argc)
  777. {
  778. invalid_param = true;
  779. break;
  780. }
  781. params.n_batch = std::stoi(argv[i]);
  782. params.n_batch = std::min(512, params.n_batch);
  783. }
  784. else if (arg == "--gpu-layers" || arg == "-ngl" || arg == "--n-gpu-layers")
  785. {
  786. if (++i >= argc)
  787. {
  788. invalid_param = true;
  789. break;
  790. }
  791. #ifdef LLAMA_SUPPORTS_GPU_OFFLOAD
  792. params.n_gpu_layers = std::stoi(argv[i]);
  793. #else
  794. LOG_WARNING("Not compiled with GPU offload support, --n-gpu-layers option will be ignored. "
  795. "See main README.md for information on enabling GPU BLAS support",
  796. {{"n_gpu_layers", params.n_gpu_layers}});
  797. #endif
  798. }
  799. else if (arg == "--tensor-split" || arg == "-ts")
  800. {
  801. if (++i >= argc)
  802. {
  803. invalid_param = true;
  804. break;
  805. }
  806. #ifdef GGML_USE_CUBLAS
  807. std::string arg_next = argv[i];
  808. // split string by , and /
  809. const std::regex regex{R"([,/]+)"};
  810. std::sregex_token_iterator it{arg_next.begin(), arg_next.end(), regex, -1};
  811. std::vector<std::string> split_arg{it, {}};
  812. GGML_ASSERT(split_arg.size() <= LLAMA_MAX_DEVICES);
  813. for (size_t i_device = 0; i_device < LLAMA_MAX_DEVICES; ++i_device)
  814. {
  815. if (i_device < split_arg.size())
  816. {
  817. params.tensor_split[i_device] = std::stof(split_arg[i_device]);
  818. }
  819. else
  820. {
  821. params.tensor_split[i_device] = 0.0f;
  822. }
  823. }
  824. #else
  825. LOG_WARNING("llama.cpp was compiled without cuBLAS. It is not possible to set a tensor split.\n", {});
  826. #endif // GGML_USE_CUBLAS
  827. }
  828. else if (arg == "--no-mul-mat-q" || arg == "-nommq")
  829. {
  830. #ifdef GGML_USE_CUBLAS
  831. params.mul_mat_q = false;
  832. #else
  833. LOG_WARNING("warning: llama.cpp was compiled without cuBLAS. Disabling mul_mat_q kernels has no effect.\n", {});
  834. #endif // GGML_USE_CUBLAS
  835. }
  836. else if (arg == "--main-gpu" || arg == "-mg")
  837. {
  838. if (++i >= argc)
  839. {
  840. invalid_param = true;
  841. break;
  842. }
  843. #ifdef GGML_USE_CUBLAS
  844. params.main_gpu = std::stoi(argv[i]);
  845. #else
  846. LOG_WARNING("llama.cpp was compiled without cuBLAS. It is not possible to set a main GPU.", {});
  847. #endif
  848. }
  849. else if (arg == "--lora")
  850. {
  851. if (++i >= argc)
  852. {
  853. invalid_param = true;
  854. break;
  855. }
  856. params.lora_adapter.push_back(std::make_tuple(argv[i], 1.0f));
  857. params.use_mmap = false;
  858. }
  859. else if (arg == "--lora-scaled")
  860. {
  861. if (++i >= argc)
  862. {
  863. invalid_param = true;
  864. break;
  865. }
  866. const char * lora_adapter = argv[i];
  867. if (++i >= argc)
  868. {
  869. invalid_param = true;
  870. break;
  871. }
  872. params.lora_adapter.push_back(std::make_tuple(lora_adapter, std::stof(argv[i])));
  873. params.use_mmap = false;
  874. }
  875. else if (arg == "--lora-base")
  876. {
  877. if (++i >= argc)
  878. {
  879. invalid_param = true;
  880. break;
  881. }
  882. params.lora_base = argv[i];
  883. }
  884. else if (arg == "-v" || arg == "--verbose")
  885. {
  886. #if SERVER_VERBOSE != 1
  887. LOG_WARNING("server.cpp is not built with verbose logging.", {});
  888. #else
  889. server_verbose = true;
  890. #endif
  891. }
  892. else if (arg == "--mlock")
  893. {
  894. params.use_mlock = true;
  895. }
  896. else if (arg == "--no-mmap")
  897. {
  898. params.use_mmap = false;
  899. }
  900. else if (arg == "--numa")
  901. {
  902. params.numa = true;
  903. }
  904. else if (arg == "--embedding")
  905. {
  906. params.embedding = true;
  907. }
  908. else
  909. {
  910. fprintf(stderr, "error: unknown argument: %s\n", arg.c_str());
  911. server_print_usage(argv[0], default_params, default_sparams);
  912. exit(1);
  913. }
  914. }
  915. if (invalid_param)
  916. {
  917. fprintf(stderr, "error: invalid parameter for argument: %s\n", arg.c_str());
  918. server_print_usage(argv[0], default_params, default_sparams);
  919. exit(1);
  920. }
  921. }
  922. static json format_generation_settings(llama_server_context &llama)
  923. {
  924. const auto eos_bias = llama.params.logit_bias.find(llama_token_eos(llama.ctx));
  925. const bool ignore_eos = eos_bias != llama.params.logit_bias.end() &&
  926. eos_bias->second < 0.0f && std::isinf(eos_bias->second);
  927. return json{
  928. {"n_ctx", llama.n_ctx},
  929. {"model", llama.params.model_alias},
  930. {"seed", llama.params.seed},
  931. {"temp", llama.params.temp},
  932. {"top_k", llama.params.top_k},
  933. {"top_p", llama.params.top_p},
  934. {"tfs_z", llama.params.tfs_z},
  935. {"typical_p", llama.params.typical_p},
  936. {"repeat_last_n", llama.params.repeat_last_n},
  937. {"repeat_penalty", llama.params.repeat_penalty},
  938. {"presence_penalty", llama.params.presence_penalty},
  939. {"frequency_penalty", llama.params.frequency_penalty},
  940. {"mirostat", llama.params.mirostat},
  941. {"mirostat_tau", llama.params.mirostat_tau},
  942. {"mirostat_eta", llama.params.mirostat_eta},
  943. {"penalize_nl", llama.params.penalize_nl},
  944. {"stop", llama.params.antiprompt},
  945. {"n_predict", llama.params.n_predict},
  946. {"n_keep", llama.params.n_keep},
  947. {"ignore_eos", ignore_eos},
  948. {"stream", llama.stream},
  949. {"logit_bias", llama.params.logit_bias},
  950. {"n_probs", llama.params.n_probs},
  951. {"grammar", llama.params.grammar},
  952. };
  953. }
  954. static json format_embedding_response(llama_server_context &llama)
  955. {
  956. return json{
  957. {"embedding", llama.getEmbedding()},
  958. };
  959. }
  960. static json format_timings(llama_server_context &llama)
  961. {
  962. const auto timings = llama_get_timings(llama.ctx);
  963. return json{
  964. {"prompt_n", timings.n_p_eval},
  965. {"prompt_ms", timings.t_p_eval_ms},
  966. {"prompt_per_token_ms", timings.t_p_eval_ms / timings.n_p_eval},
  967. {"prompt_per_second", 1e3 / timings.t_p_eval_ms * timings.n_p_eval},
  968. {"predicted_n", timings.n_eval},
  969. {"predicted_ms", timings.t_eval_ms},
  970. {"predicted_per_token_ms", timings.t_eval_ms / timings.n_eval},
  971. {"predicted_per_second", 1e3 / timings.t_eval_ms * timings.n_eval},
  972. };
  973. }
  974. static json format_final_response(llama_server_context &llama, const std::string &content, const std::vector<completion_token_output> &probs)
  975. {
  976. json res = json{
  977. {"content", content},
  978. {"stop", true},
  979. {"model", llama.params.model_alias},
  980. {"tokens_predicted", llama.num_tokens_predicted},
  981. {"tokens_evaluated", llama.num_prompt_tokens},
  982. {"generation_settings", format_generation_settings(llama)},
  983. {"prompt", llama.prompt},
  984. {"truncated", llama.truncated},
  985. {"stopped_eos", llama.stopped_eos},
  986. {"stopped_word", llama.stopped_word},
  987. {"stopped_limit", llama.stopped_limit},
  988. {"stopping_word", llama.stopping_word},
  989. {"tokens_cached", llama.n_past},
  990. {"timings", format_timings(llama)},
  991. };
  992. if (llama.params.n_probs > 0)
  993. {
  994. res["completion_probabilities"] = probs_vector_to_json(llama.ctx, probs);
  995. }
  996. return res;
  997. }
  998. static json format_partial_response(
  999. llama_server_context &llama, const std::string &content, const std::vector<completion_token_output> &probs
  1000. ) {
  1001. json res = json{
  1002. {"content", content},
  1003. {"stop", false},
  1004. };
  1005. if (llama.params.n_probs > 0)
  1006. {
  1007. res["completion_probabilities"] = probs_vector_to_json(llama.ctx, probs);
  1008. }
  1009. return res;
  1010. }
  1011. static json format_tokenizer_response(const std::vector<llama_token> &tokens)
  1012. {
  1013. return json{
  1014. {"tokens", tokens}};
  1015. }
  1016. static json format_detokenized_response(std::string content)
  1017. {
  1018. return json{
  1019. {"content", content}};
  1020. }
  1021. template <typename T>
  1022. static T json_value(const json &body, const std::string &key, const T &default_value)
  1023. {
  1024. // Fallback null to default value
  1025. return body.contains(key) && !body.at(key).is_null()
  1026. ? body.value(key, default_value)
  1027. : default_value;
  1028. }
  1029. static void parse_options_completion(const json &body, llama_server_context &llama)
  1030. {
  1031. gpt_params default_params;
  1032. llama.stream = json_value(body, "stream", false);
  1033. llama.params.n_predict = json_value(body, "n_predict", default_params.n_predict);
  1034. llama.params.top_k = json_value(body, "top_k", default_params.top_k);
  1035. llama.params.top_p = json_value(body, "top_p", default_params.top_p);
  1036. llama.params.tfs_z = json_value(body, "tfs_z", default_params.tfs_z);
  1037. llama.params.typical_p = json_value(body, "typical_p", default_params.typical_p);
  1038. llama.params.repeat_last_n = json_value(body, "repeat_last_n", default_params.repeat_last_n);
  1039. llama.params.temp = json_value(body, "temperature", default_params.temp);
  1040. llama.params.repeat_penalty = json_value(body, "repeat_penalty", default_params.repeat_penalty);
  1041. llama.params.presence_penalty = json_value(body, "presence_penalty", default_params.presence_penalty);
  1042. llama.params.frequency_penalty = json_value(body, "frequency_penalty", default_params.frequency_penalty);
  1043. llama.params.mirostat = json_value(body, "mirostat", default_params.mirostat);
  1044. llama.params.mirostat_tau = json_value(body, "mirostat_tau", default_params.mirostat_tau);
  1045. llama.params.mirostat_eta = json_value(body, "mirostat_eta", default_params.mirostat_eta);
  1046. llama.params.penalize_nl = json_value(body, "penalize_nl", default_params.penalize_nl);
  1047. llama.params.n_keep = json_value(body, "n_keep", default_params.n_keep);
  1048. llama.params.seed = json_value(body, "seed", default_params.seed);
  1049. llama.params.grammar = json_value(body, "grammar", default_params.grammar);
  1050. llama.params.n_probs = json_value(body, "n_probs", default_params.n_probs);
  1051. if (body.count("prompt") != 0)
  1052. {
  1053. llama.prompt = body["prompt"];
  1054. }
  1055. else
  1056. {
  1057. llama.prompt = "";
  1058. }
  1059. llama.params.logit_bias.clear();
  1060. if (json_value(body, "ignore_eos", false))
  1061. {
  1062. llama.params.logit_bias[llama_token_eos(llama.ctx)] = -INFINITY;
  1063. }
  1064. const auto &logit_bias = body.find("logit_bias");
  1065. if (logit_bias != body.end() && logit_bias->is_array())
  1066. {
  1067. const int n_vocab = llama_n_vocab(llama.model);
  1068. for (const auto &el : *logit_bias)
  1069. {
  1070. if (el.is_array() && el.size() == 2 && el[0].is_number_integer())
  1071. {
  1072. llama_token tok = el[0].get<llama_token>();
  1073. if (tok >= 0 && tok < n_vocab)
  1074. {
  1075. if (el[1].is_number())
  1076. {
  1077. llama.params.logit_bias[tok] = el[1].get<float>();
  1078. }
  1079. else if (el[1].is_boolean() && !el[1].get<bool>())
  1080. {
  1081. llama.params.logit_bias[tok] = -INFINITY;
  1082. }
  1083. }
  1084. }
  1085. }
  1086. }
  1087. llama.params.antiprompt.clear();
  1088. const auto &stop = body.find("stop");
  1089. if (stop != body.end() && stop->is_array())
  1090. {
  1091. for (const auto &word : *stop)
  1092. {
  1093. if (!word.empty())
  1094. {
  1095. llama.params.antiprompt.push_back(word);
  1096. }
  1097. }
  1098. }
  1099. LOG_VERBOSE("completion parameters parsed", format_generation_settings(llama));
  1100. }
  1101. static void parse_options_infill(const json &body, llama_server_context &llama)
  1102. {
  1103. if (body.count("input_prefix") != 0)
  1104. {
  1105. llama.params.input_prefix = body["input_prefix"];
  1106. }
  1107. else
  1108. {
  1109. llama.params.input_prefix = "";
  1110. }
  1111. if (body.count("input_suffix") != 0)
  1112. {
  1113. llama.params.input_suffix = body["input_suffix"];
  1114. }
  1115. else
  1116. {
  1117. llama.params.input_suffix = "";
  1118. }
  1119. parse_options_completion(body, llama);
  1120. }
  1121. static void log_server_request(const Request &req, const Response &res)
  1122. {
  1123. LOG_INFO("request", {
  1124. {"remote_addr", req.remote_addr},
  1125. {"remote_port", req.remote_port},
  1126. {"status", res.status},
  1127. {"method", req.method},
  1128. {"path", req.path},
  1129. {"params", req.params},
  1130. });
  1131. LOG_VERBOSE("request", {
  1132. {"request", req.body},
  1133. {"response", res.body},
  1134. });
  1135. }
  1136. static bool is_at_eob(llama_server_context &server_context, const llama_token *tokens, const size_t n_tokens) {
  1137. return n_tokens && tokens[n_tokens-1] == llama_token_eos(server_context.ctx);
  1138. }
  1139. // Function matching type llama_beam_search_callback_fn_t.
  1140. // Custom callback example is called each time the beams lengths increase:
  1141. // * Show progress by printing ',' following by number of convergent beam tokens if any.
  1142. // * When all beams converge to a common prefix, they are made available in beams_state.beams[0].
  1143. // This is also called when the stop condition is met.
  1144. // Collect tokens into std::vector<llama_token> response which is pointed to by callback_data.
  1145. static void beam_search_callback(void *callback_data, llama_beams_state beams_state) {
  1146. auto & llama = *static_cast<llama_server_context*>(callback_data);
  1147. // Mark beams as EOS as needed.
  1148. for (size_t i = 0 ; i < beams_state.n_beams ; ++i) {
  1149. llama_beam_view& beam_view = beams_state.beam_views[i];
  1150. if (!beam_view.eob && is_at_eob(llama, beam_view.tokens, beam_view.n_tokens)) {
  1151. beam_view.eob = true;
  1152. }
  1153. }
  1154. printf(","); // Show progress
  1155. if (const size_t n = beams_state.common_prefix_length) {
  1156. llama.generated_token_probs.resize(llama.generated_token_probs.size() + n);
  1157. assert(0u < beams_state.n_beams);
  1158. const llama_token * tokens = beams_state.beam_views[0].tokens;
  1159. const auto map = [](llama_token tok) { return completion_token_output{{},tok}; };
  1160. std::transform(tokens, tokens + n, llama.generated_token_probs.end() - n, map);
  1161. printf("%zu", n);
  1162. }
  1163. fflush(stdout);
  1164. #if 0 // DEBUG: print current beams for this iteration
  1165. std::cout << "\n\nCurrent beams:\n";
  1166. for (size_t i=0 ; i < beams_state.n_beams ; ++i) {
  1167. std::cout << "beams["<<i<<"]: " << ostream_beam_view{state.ctx,beams_state.beam_views[i]} << std::endl;
  1168. }
  1169. #endif
  1170. }
  1171. struct token_translator {
  1172. llama_context * ctx;
  1173. std::string operator()(llama_token tok) const { return llama_token_to_piece(ctx, tok); }
  1174. std::string operator()(const completion_token_output & cto) const { return (*this)(cto.tok); }
  1175. };
  1176. static void append_to_generated_text_from_generated_token_probs(llama_server_context &llama)
  1177. {
  1178. auto & gtps = llama.generated_token_probs;
  1179. auto translator = token_translator{llama.ctx};
  1180. auto add_strlen = [=](size_t sum, const completion_token_output & cto) { return sum + translator(cto).size(); };
  1181. const size_t len = std::accumulate(gtps.begin(), gtps.end(), size_t(0), add_strlen);
  1182. if (llama.generated_text.capacity() < llama.generated_text.size() + len) {
  1183. llama.generated_text.reserve(llama.generated_text.size() + len);
  1184. }
  1185. for (const completion_token_output & cto : gtps) {
  1186. llama.generated_text += translator(cto);
  1187. }
  1188. }
  1189. int main(int argc, char **argv)
  1190. {
  1191. // own arguments required by this example
  1192. gpt_params params;
  1193. server_params sparams;
  1194. // struct that contains llama context and inference
  1195. llama_server_context llama;
  1196. server_params_parse(argc, argv, sparams, params);
  1197. if (params.model_alias == "unknown")
  1198. {
  1199. params.model_alias = params.model;
  1200. }
  1201. llama_backend_init(params.numa);
  1202. LOG_INFO("build info", {{"build", BUILD_NUMBER},
  1203. {"commit", BUILD_COMMIT}});
  1204. LOG_INFO("system info", {
  1205. {"n_threads", params.n_threads},
  1206. {"n_threads_batch", params.n_threads_batch},
  1207. {"total_threads", std::thread::hardware_concurrency()},
  1208. {"system_info", llama_print_system_info()},
  1209. });
  1210. // load the model
  1211. if (!llama.loadModel(params))
  1212. {
  1213. return 1;
  1214. }
  1215. Server svr;
  1216. svr.set_default_headers({{"Server", "llama.cpp"},
  1217. {"Access-Control-Allow-Origin", "*"},
  1218. {"Access-Control-Allow-Headers", "content-type"}});
  1219. // this is only called if no index.html is found in the public --path
  1220. svr.Get("/", [](const Request &, Response &res)
  1221. {
  1222. res.set_content(reinterpret_cast<const char*>(&index_html), index_html_len, "text/html");
  1223. return false; });
  1224. // this is only called if no index.js is found in the public --path
  1225. svr.Get("/index.js", [](const Request &, Response &res)
  1226. {
  1227. res.set_content(reinterpret_cast<const char *>(&index_js), index_js_len, "text/javascript");
  1228. return false; });
  1229. // this is only called if no index.html is found in the public --path
  1230. svr.Get("/completion.js", [](const Request &, Response &res)
  1231. {
  1232. res.set_content(reinterpret_cast<const char*>(&completion_js), completion_js_len, "application/javascript");
  1233. return false; });
  1234. // this is only called if no index.html is found in the public --path
  1235. svr.Get("/json-schema-to-grammar.mjs", [](const Request &, Response &res)
  1236. {
  1237. res.set_content(reinterpret_cast<const char*>(&json_schema_to_grammar_mjs), json_schema_to_grammar_mjs_len, "application/javascript");
  1238. return false; });
  1239. svr.Post("/completion", [&llama](const Request &req, Response &res)
  1240. {
  1241. auto lock = llama.lock();
  1242. llama.rewind();
  1243. llama_reset_timings(llama.ctx);
  1244. parse_options_completion(json::parse(req.body), llama);
  1245. if (!llama.loadGrammar())
  1246. {
  1247. res.status = 400;
  1248. return;
  1249. }
  1250. llama.loadPrompt();
  1251. llama.beginCompletion();
  1252. if (!llama.stream) {
  1253. if (llama.params.n_beams) {
  1254. // Fill llama.generated_token_probs vector with final beam.
  1255. llama_beam_search(llama.ctx, beam_search_callback, &llama, llama.params.n_beams,
  1256. llama.n_past, llama.n_remain);
  1257. // Translate llama.generated_token_probs to llama.generated_text.
  1258. append_to_generated_text_from_generated_token_probs(llama);
  1259. } else {
  1260. size_t stop_pos = std::string::npos;
  1261. while (llama.has_next_token) {
  1262. const completion_token_output token_with_probs = llama.doCompletion();
  1263. const std::string token_text = token_with_probs.tok == -1 ? "" : llama_token_to_piece(llama.ctx, token_with_probs.tok);
  1264. stop_pos = llama.findStoppingStrings(llama.generated_text,
  1265. token_text.size(), STOP_FULL);
  1266. }
  1267. if (stop_pos == std::string::npos) {
  1268. stop_pos = llama.findStoppingStrings(llama.generated_text, 0, STOP_PARTIAL);
  1269. }
  1270. if (stop_pos != std::string::npos) {
  1271. llama.generated_text.erase(llama.generated_text.begin() + stop_pos,
  1272. llama.generated_text.end());
  1273. }
  1274. }
  1275. auto probs = llama.generated_token_probs;
  1276. if (llama.params.n_probs > 0 && llama.stopped_word) {
  1277. const std::vector<llama_token> stop_word_toks = llama_tokenize(llama.ctx, llama.stopping_word, false);
  1278. probs = std::vector<completion_token_output>(llama.generated_token_probs.begin(), llama.generated_token_probs.end() - stop_word_toks.size());
  1279. }
  1280. const json data = format_final_response(llama, llama.generated_text, probs);
  1281. llama_print_timings(llama.ctx);
  1282. res.set_content(data.dump(-1, ' ', false, json::error_handler_t::replace),
  1283. "application/json");
  1284. } else {
  1285. const auto chunked_content_provider = [&](size_t, DataSink & sink) {
  1286. size_t sent_count = 0;
  1287. size_t sent_token_probs_index = 0;
  1288. while (llama.has_next_token) {
  1289. const completion_token_output token_with_probs = llama.doCompletion();
  1290. if (token_with_probs.tok == -1 || llama.multibyte_pending > 0) {
  1291. continue;
  1292. }
  1293. const std::string token_text = llama_token_to_piece(llama.ctx, token_with_probs.tok);
  1294. size_t pos = std::min(sent_count, llama.generated_text.size());
  1295. const std::string str_test = llama.generated_text.substr(pos);
  1296. bool is_stop_full = false;
  1297. size_t stop_pos =
  1298. llama.findStoppingStrings(str_test, token_text.size(), STOP_FULL);
  1299. if (stop_pos != std::string::npos) {
  1300. is_stop_full = true;
  1301. llama.generated_text.erase(
  1302. llama.generated_text.begin() + pos + stop_pos,
  1303. llama.generated_text.end());
  1304. pos = std::min(sent_count, llama.generated_text.size());
  1305. } else {
  1306. is_stop_full = false;
  1307. stop_pos = llama.findStoppingStrings(str_test, token_text.size(),
  1308. STOP_PARTIAL);
  1309. }
  1310. if (
  1311. stop_pos == std::string::npos ||
  1312. // Send rest of the text if we are at the end of the generation
  1313. (!llama.has_next_token && !is_stop_full && stop_pos > 0)
  1314. ) {
  1315. const std::string to_send = llama.generated_text.substr(pos, std::string::npos);
  1316. sent_count += to_send.size();
  1317. std::vector<completion_token_output> probs_output = {};
  1318. if (llama.params.n_probs > 0) {
  1319. const std::vector<llama_token> to_send_toks = llama_tokenize(llama.ctx, to_send, false);
  1320. size_t probs_pos = std::min(sent_token_probs_index, llama.generated_token_probs.size());
  1321. size_t probs_stop_pos = std::min(sent_token_probs_index + to_send_toks.size(), llama.generated_token_probs.size());
  1322. if (probs_pos < probs_stop_pos) {
  1323. probs_output = std::vector<completion_token_output>(llama.generated_token_probs.begin() + probs_pos, llama.generated_token_probs.begin() + probs_stop_pos);
  1324. }
  1325. sent_token_probs_index = probs_stop_pos;
  1326. }
  1327. const json data = format_partial_response(llama, to_send, probs_output);
  1328. const std::string str =
  1329. "data: " +
  1330. data.dump(-1, ' ', false, json::error_handler_t::replace) +
  1331. "\n\n";
  1332. LOG_VERBOSE("data stream", {
  1333. { "to_send", str }
  1334. });
  1335. if (!sink.write(str.data(), str.size())) {
  1336. LOG_VERBOSE("stream closed", {});
  1337. llama_print_timings(llama.ctx);
  1338. return false;
  1339. }
  1340. }
  1341. if (!llama.has_next_token) {
  1342. // Generation is done, send extra information.
  1343. const json data = format_final_response(
  1344. llama,
  1345. "",
  1346. std::vector<completion_token_output>(llama.generated_token_probs.begin(), llama.generated_token_probs.begin() + sent_token_probs_index)
  1347. );
  1348. const std::string str =
  1349. "data: " +
  1350. data.dump(-1, ' ', false, json::error_handler_t::replace) +
  1351. "\n\n";
  1352. LOG_VERBOSE("data stream", {
  1353. { "to_send", str }
  1354. });
  1355. if (!sink.write(str.data(), str.size())) {
  1356. LOG_VERBOSE("stream closed", {});
  1357. llama_print_timings(llama.ctx);
  1358. return false;
  1359. }
  1360. }
  1361. }
  1362. llama_print_timings(llama.ctx);
  1363. sink.done();
  1364. return true;
  1365. };
  1366. const auto on_complete = [&](bool) {
  1367. llama.mutex.unlock();
  1368. };
  1369. lock.release();
  1370. res.set_chunked_content_provider("text/event-stream", chunked_content_provider, on_complete);
  1371. } });
  1372. svr.Post("/infill", [&llama](const Request &req, Response &res)
  1373. {
  1374. auto lock = llama.lock();
  1375. llama.rewind();
  1376. llama_reset_timings(llama.ctx);
  1377. parse_options_infill(json::parse(req.body), llama);
  1378. if (!llama.loadGrammar())
  1379. {
  1380. res.status = 400;
  1381. return;
  1382. }
  1383. llama.loadInfill();
  1384. llama.beginCompletion();
  1385. const auto chunked_content_provider = [&](size_t, DataSink & sink) {
  1386. size_t sent_count = 0;
  1387. size_t sent_token_probs_index = 0;
  1388. while (llama.has_next_token) {
  1389. const completion_token_output token_with_probs = llama.doCompletion();
  1390. if (token_with_probs.tok == -1 || llama.multibyte_pending > 0) {
  1391. continue;
  1392. }
  1393. const std::string token_text = llama_token_to_piece(llama.ctx, token_with_probs.tok);
  1394. size_t pos = std::min(sent_count, llama.generated_text.size());
  1395. const std::string str_test = llama.generated_text.substr(pos);
  1396. bool is_stop_full = false;
  1397. size_t stop_pos =
  1398. llama.findStoppingStrings(str_test, token_text.size(), STOP_FULL);
  1399. if (stop_pos != std::string::npos) {
  1400. is_stop_full = true;
  1401. llama.generated_text.erase(
  1402. llama.generated_text.begin() + pos + stop_pos,
  1403. llama.generated_text.end());
  1404. pos = std::min(sent_count, llama.generated_text.size());
  1405. } else {
  1406. is_stop_full = false;
  1407. stop_pos = llama.findStoppingStrings(str_test, token_text.size(),
  1408. STOP_PARTIAL);
  1409. }
  1410. if (
  1411. stop_pos == std::string::npos ||
  1412. // Send rest of the text if we are at the end of the generation
  1413. (!llama.has_next_token && !is_stop_full && stop_pos > 0)
  1414. ) {
  1415. const std::string to_send = llama.generated_text.substr(pos, std::string::npos);
  1416. sent_count += to_send.size();
  1417. std::vector<completion_token_output> probs_output = {};
  1418. if (llama.params.n_probs > 0) {
  1419. const std::vector<llama_token> to_send_toks = llama_tokenize(llama.ctx, to_send, false);
  1420. size_t probs_pos = std::min(sent_token_probs_index, llama.generated_token_probs.size());
  1421. size_t probs_stop_pos = std::min(sent_token_probs_index + to_send_toks.size(), llama.generated_token_probs.size());
  1422. if (probs_pos < probs_stop_pos) {
  1423. probs_output = std::vector<completion_token_output>(llama.generated_token_probs.begin() + probs_pos, llama.generated_token_probs.begin() + probs_stop_pos);
  1424. }
  1425. sent_token_probs_index = probs_stop_pos;
  1426. }
  1427. const json data = format_partial_response(llama, to_send, probs_output);
  1428. const std::string str =
  1429. "data: " +
  1430. data.dump(-1, ' ', false, json::error_handler_t::replace) +
  1431. "\n\n";
  1432. LOG_VERBOSE("data stream", {
  1433. { "to_send", str }
  1434. });
  1435. if (!sink.write(str.data(), str.size())) {
  1436. LOG_VERBOSE("stream closed", {});
  1437. llama_print_timings(llama.ctx);
  1438. return false;
  1439. }
  1440. }
  1441. if (!llama.has_next_token) {
  1442. // Generation is done, send extra information.
  1443. const json data = format_final_response(
  1444. llama,
  1445. "",
  1446. std::vector<completion_token_output>(llama.generated_token_probs.begin(), llama.generated_token_probs.begin() + sent_token_probs_index)
  1447. );
  1448. const std::string str =
  1449. "data: " +
  1450. data.dump(-1, ' ', false, json::error_handler_t::replace) +
  1451. "\n\n";
  1452. LOG_VERBOSE("data stream", {
  1453. { "to_send", str }
  1454. });
  1455. if (!sink.write(str.data(), str.size())) {
  1456. LOG_VERBOSE("stream closed", {});
  1457. llama_print_timings(llama.ctx);
  1458. return false;
  1459. }
  1460. }
  1461. }
  1462. llama_print_timings(llama.ctx);
  1463. sink.done();
  1464. return true;
  1465. };
  1466. const auto on_complete = [&](bool) {
  1467. llama.mutex.unlock();
  1468. };
  1469. lock.release();
  1470. res.set_chunked_content_provider("text/event-stream", chunked_content_provider, on_complete);
  1471. });
  1472. svr.Get("/model.json", [&llama](const Request &, Response &res)
  1473. {
  1474. const json data = format_generation_settings(llama);
  1475. return res.set_content(data.dump(), "application/json"); });
  1476. svr.Options(R"(/.*)", [](const Request &, Response &res)
  1477. { return res.set_content("", "application/json"); });
  1478. svr.Post("/tokenize", [&llama](const Request &req, Response &res)
  1479. {
  1480. auto lock = llama.lock();
  1481. const json body = json::parse(req.body);
  1482. std::vector<llama_token> tokens;
  1483. if (body.count("content") != 0)
  1484. {
  1485. tokens = llama.tokenize(body["content"], false);
  1486. }
  1487. const json data = format_tokenizer_response(tokens);
  1488. return res.set_content(data.dump(), "application/json"); });
  1489. svr.Post("/detokenize", [&llama](const Request &req, Response &res)
  1490. {
  1491. auto lock = llama.lock();
  1492. const json body = json::parse(req.body);
  1493. std::string content;
  1494. if (body.count("tokens") != 0)
  1495. {
  1496. const std::vector<llama_token> tokens = body["tokens"];
  1497. content = tokens_to_str(llama.ctx, tokens.cbegin(), tokens.cend());
  1498. }
  1499. const json data = format_detokenized_response(content);
  1500. return res.set_content(data.dump(), "application/json"); });
  1501. svr.Post("/embedding", [&llama](const Request &req, Response &res)
  1502. {
  1503. auto lock = llama.lock();
  1504. const json body = json::parse(req.body);
  1505. llama.rewind();
  1506. llama_reset_timings(llama.ctx);
  1507. if (body.count("content") != 0)
  1508. {
  1509. llama.prompt = body["content"];
  1510. }
  1511. else
  1512. {
  1513. llama.prompt = "";
  1514. }
  1515. llama.params.n_predict = 0;
  1516. llama.loadPrompt();
  1517. llama.beginCompletion();
  1518. llama.doCompletion();
  1519. const json data = format_embedding_response(llama);
  1520. return res.set_content(data.dump(), "application/json"); });
  1521. svr.set_logger(log_server_request);
  1522. svr.set_exception_handler([](const Request &, Response &res, std::exception_ptr ep)
  1523. {
  1524. const char fmt[] = "500 Internal Server Error\n%s";
  1525. char buf[BUFSIZ];
  1526. try {
  1527. std::rethrow_exception(std::move(ep));
  1528. } catch (std::exception & e) {
  1529. snprintf(buf, sizeof(buf), fmt, e.what());
  1530. } catch (...) {
  1531. snprintf(buf, sizeof(buf), fmt, "Unknown Exception");
  1532. }
  1533. res.set_content(buf, "text/plain");
  1534. res.status = 500; });
  1535. svr.set_error_handler([](const Request &, Response &res)
  1536. {
  1537. if (res.status == 400) {
  1538. res.set_content("Invalid request", "text/plain");
  1539. } else if (res.status != 500) {
  1540. res.set_content("File Not Found", "text/plain");
  1541. res.status = 404;
  1542. } });
  1543. // set timeouts and change hostname and port
  1544. svr.set_read_timeout(sparams.read_timeout);
  1545. svr.set_write_timeout(sparams.write_timeout);
  1546. if (!svr.bind_to_port(sparams.hostname, sparams.port))
  1547. {
  1548. fprintf(stderr, "\ncouldn't bind to server socket: hostname=%s port=%d\n\n", sparams.hostname.c_str(), sparams.port);
  1549. return 1;
  1550. }
  1551. // Set the base directory for serving static files
  1552. svr.set_base_dir(sparams.public_path);
  1553. // to make it ctrl+clickable:
  1554. printf("\nllama server listening at http://%s:%d\n\n", sparams.hostname.c_str(), sparams.port);
  1555. LOG_INFO("HTTP server listening", {
  1556. {"hostname", sparams.hostname},
  1557. {"port", sparams.port},
  1558. });
  1559. if (!svr.listen_after_bind())
  1560. {
  1561. return 1;
  1562. }
  1563. if (llama.grammar != nullptr) {
  1564. llama_grammar_free(llama.grammar);
  1565. }
  1566. llama_backend_free();
  1567. return 0;
  1568. }