run.cpp 39 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180
  1. #if defined(_WIN32)
  2. # include <windows.h>
  3. # include <io.h>
  4. #else
  5. # include <sys/file.h>
  6. # include <sys/ioctl.h>
  7. # include <unistd.h>
  8. #endif
  9. #if defined(LLAMA_USE_CURL)
  10. # include <curl/curl.h>
  11. #endif
  12. #include <signal.h>
  13. #include <climits>
  14. #include <cstdarg>
  15. #include <cstdio>
  16. #include <cstring>
  17. #include <filesystem>
  18. #include <iostream>
  19. #include <list>
  20. #include <sstream>
  21. #include <string>
  22. #include <vector>
  23. #include "chat-template.hpp"
  24. #include "common.h"
  25. #include "json.hpp"
  26. #include "linenoise.cpp/linenoise.h"
  27. #include "llama-cpp.h"
  28. #include "log.h"
  29. #if defined(__unix__) || (defined(__APPLE__) && defined(__MACH__)) || defined(_WIN32)
  30. [[noreturn]] static void sigint_handler(int) {
  31. printf("\n" LOG_COL_DEFAULT);
  32. exit(0); // not ideal, but it's the only way to guarantee exit in all cases
  33. }
  34. #endif
  35. GGML_ATTRIBUTE_FORMAT(1, 2)
  36. static std::string fmt(const char * fmt, ...) {
  37. va_list ap;
  38. va_list ap2;
  39. va_start(ap, fmt);
  40. va_copy(ap2, ap);
  41. const int size = vsnprintf(NULL, 0, fmt, ap);
  42. GGML_ASSERT(size >= 0 && size < INT_MAX); // NOLINT
  43. std::string buf;
  44. buf.resize(size);
  45. const int size2 = vsnprintf(const_cast<char *>(buf.data()), buf.size() + 1, fmt, ap2);
  46. GGML_ASSERT(size2 == size);
  47. va_end(ap2);
  48. va_end(ap);
  49. return buf;
  50. }
  51. GGML_ATTRIBUTE_FORMAT(1, 2)
  52. static int printe(const char * fmt, ...) {
  53. va_list args;
  54. va_start(args, fmt);
  55. const int ret = vfprintf(stderr, fmt, args);
  56. va_end(args);
  57. return ret;
  58. }
  59. static std::string strftime_fmt(const char * fmt, const std::tm & tm) {
  60. std::ostringstream oss;
  61. oss << std::put_time(&tm, fmt);
  62. return oss.str();
  63. }
  64. class Opt {
  65. public:
  66. int init(int argc, const char ** argv) {
  67. ctx_params = llama_context_default_params();
  68. model_params = llama_model_default_params();
  69. context_size_default = ctx_params.n_batch;
  70. ngl_default = model_params.n_gpu_layers;
  71. common_params_sampling sampling;
  72. temperature_default = sampling.temp;
  73. if (argc < 2) {
  74. printe("Error: No arguments provided.\n");
  75. print_help();
  76. return 1;
  77. }
  78. // Parse arguments
  79. if (parse(argc, argv)) {
  80. printe("Error: Failed to parse arguments.\n");
  81. print_help();
  82. return 1;
  83. }
  84. // If help is requested, show help and exit
  85. if (help) {
  86. print_help();
  87. return 2;
  88. }
  89. ctx_params.n_batch = context_size >= 0 ? context_size : context_size_default;
  90. ctx_params.n_ctx = ctx_params.n_batch;
  91. model_params.n_gpu_layers = ngl >= 0 ? ngl : ngl_default;
  92. temperature = temperature >= 0 ? temperature : temperature_default;
  93. return 0; // Success
  94. }
  95. llama_context_params ctx_params;
  96. llama_model_params model_params;
  97. std::string model_;
  98. std::string user;
  99. bool use_jinja = false;
  100. int context_size = -1, ngl = -1;
  101. float temperature = -1;
  102. bool verbose = false;
  103. private:
  104. int context_size_default = -1, ngl_default = -1;
  105. float temperature_default = -1;
  106. bool help = false;
  107. bool parse_flag(const char ** argv, int i, const char * short_opt, const char * long_opt) {
  108. return strcmp(argv[i], short_opt) == 0 || strcmp(argv[i], long_opt) == 0;
  109. }
  110. int handle_option_with_value(int argc, const char ** argv, int & i, int & option_value) {
  111. if (i + 1 >= argc) {
  112. return 1;
  113. }
  114. option_value = std::atoi(argv[++i]);
  115. return 0;
  116. }
  117. int handle_option_with_value(int argc, const char ** argv, int & i, float & option_value) {
  118. if (i + 1 >= argc) {
  119. return 1;
  120. }
  121. option_value = std::atof(argv[++i]);
  122. return 0;
  123. }
  124. int parse(int argc, const char ** argv) {
  125. bool options_parsing = true;
  126. for (int i = 1, positional_args_i = 0; i < argc; ++i) {
  127. if (options_parsing && (strcmp(argv[i], "-c") == 0 || strcmp(argv[i], "--context-size") == 0)) {
  128. if (handle_option_with_value(argc, argv, i, context_size) == 1) {
  129. return 1;
  130. }
  131. } else if (options_parsing &&
  132. (strcmp(argv[i], "-n") == 0 || strcmp(argv[i], "-ngl") == 0 || strcmp(argv[i], "--ngl") == 0)) {
  133. if (handle_option_with_value(argc, argv, i, ngl) == 1) {
  134. return 1;
  135. }
  136. } else if (options_parsing && strcmp(argv[i], "--temp") == 0) {
  137. if (handle_option_with_value(argc, argv, i, temperature) == 1) {
  138. return 1;
  139. }
  140. } else if (options_parsing &&
  141. (parse_flag(argv, i, "-v", "--verbose") || parse_flag(argv, i, "-v", "--log-verbose"))) {
  142. verbose = true;
  143. } else if (options_parsing && strcmp(argv[i], "--jinja") == 0) {
  144. use_jinja = true;
  145. } else if (options_parsing && parse_flag(argv, i, "-h", "--help")) {
  146. help = true;
  147. return 0;
  148. } else if (options_parsing && strcmp(argv[i], "--") == 0) {
  149. options_parsing = false;
  150. } else if (positional_args_i == 0) {
  151. if (!argv[i][0] || argv[i][0] == '-') {
  152. return 1;
  153. }
  154. ++positional_args_i;
  155. model_ = argv[i];
  156. } else if (positional_args_i == 1) {
  157. ++positional_args_i;
  158. user = argv[i];
  159. } else {
  160. user += " " + std::string(argv[i]);
  161. }
  162. }
  163. if (model_.empty()){
  164. return 1;
  165. }
  166. return 0;
  167. }
  168. void print_help() const {
  169. printf(
  170. "Description:\n"
  171. " Runs a llm\n"
  172. "\n"
  173. "Usage:\n"
  174. " llama-run [options] model [prompt]\n"
  175. "\n"
  176. "Options:\n"
  177. " -c, --context-size <value>\n"
  178. " Context size (default: %d)\n"
  179. " -n, -ngl, --ngl <value>\n"
  180. " Number of GPU layers (default: %d)\n"
  181. " --temp <value>\n"
  182. " Temperature (default: %.1f)\n"
  183. " -v, --verbose, --log-verbose\n"
  184. " Set verbosity level to infinity (i.e. log all messages, useful for debugging)\n"
  185. " -h, --help\n"
  186. " Show help message\n"
  187. "\n"
  188. "Commands:\n"
  189. " model\n"
  190. " Model is a string with an optional prefix of \n"
  191. " huggingface:// (hf://), ollama://, https:// or file://.\n"
  192. " If no protocol is specified and a file exists in the specified\n"
  193. " path, file:// is assumed, otherwise if a file does not exist in\n"
  194. " the specified path, ollama:// is assumed. Models that are being\n"
  195. " pulled are downloaded with .partial extension while being\n"
  196. " downloaded and then renamed as the file without the .partial\n"
  197. " extension when complete.\n"
  198. "\n"
  199. "Examples:\n"
  200. " llama-run llama3\n"
  201. " llama-run ollama://granite-code\n"
  202. " llama-run ollama://smollm:135m\n"
  203. " llama-run hf://QuantFactory/SmolLM-135M-GGUF/SmolLM-135M.Q2_K.gguf\n"
  204. " llama-run "
  205. "huggingface://bartowski/SmolLM-1.7B-Instruct-v0.2-GGUF/SmolLM-1.7B-Instruct-v0.2-IQ3_M.gguf\n"
  206. " llama-run https://example.com/some-file1.gguf\n"
  207. " llama-run some-file2.gguf\n"
  208. " llama-run file://some-file3.gguf\n"
  209. " llama-run --ngl 999 some-file4.gguf\n"
  210. " llama-run --ngl 999 some-file5.gguf Hello World\n",
  211. context_size_default, ngl_default, temperature_default);
  212. }
  213. };
  214. struct progress_data {
  215. size_t file_size = 0;
  216. std::chrono::steady_clock::time_point start_time = std::chrono::steady_clock::now();
  217. bool printed = false;
  218. };
  219. static int get_terminal_width() {
  220. #if defined(_WIN32)
  221. CONSOLE_SCREEN_BUFFER_INFO csbi;
  222. GetConsoleScreenBufferInfo(GetStdHandle(STD_OUTPUT_HANDLE), &csbi);
  223. return csbi.srWindow.Right - csbi.srWindow.Left + 1;
  224. #else
  225. struct winsize w;
  226. ioctl(STDOUT_FILENO, TIOCGWINSZ, &w);
  227. return w.ws_col;
  228. #endif
  229. }
  230. #ifdef LLAMA_USE_CURL
  231. class File {
  232. public:
  233. FILE * file = nullptr;
  234. FILE * open(const std::string & filename, const char * mode) {
  235. file = fopen(filename.c_str(), mode);
  236. return file;
  237. }
  238. int lock() {
  239. if (file) {
  240. # ifdef _WIN32
  241. fd = _fileno(file);
  242. hFile = (HANDLE) _get_osfhandle(fd);
  243. if (hFile == INVALID_HANDLE_VALUE) {
  244. fd = -1;
  245. return 1;
  246. }
  247. OVERLAPPED overlapped = {};
  248. if (!LockFileEx(hFile, LOCKFILE_EXCLUSIVE_LOCK | LOCKFILE_FAIL_IMMEDIATELY, 0, MAXDWORD, MAXDWORD,
  249. &overlapped)) {
  250. fd = -1;
  251. return 1;
  252. }
  253. # else
  254. fd = fileno(file);
  255. if (flock(fd, LOCK_EX | LOCK_NB) != 0) {
  256. fd = -1;
  257. return 1;
  258. }
  259. # endif
  260. }
  261. return 0;
  262. }
  263. ~File() {
  264. if (fd >= 0) {
  265. # ifdef _WIN32
  266. if (hFile != INVALID_HANDLE_VALUE) {
  267. OVERLAPPED overlapped = {};
  268. UnlockFileEx(hFile, 0, MAXDWORD, MAXDWORD, &overlapped);
  269. }
  270. # else
  271. flock(fd, LOCK_UN);
  272. # endif
  273. }
  274. if (file) {
  275. fclose(file);
  276. }
  277. }
  278. private:
  279. int fd = -1;
  280. # ifdef _WIN32
  281. HANDLE hFile = nullptr;
  282. # endif
  283. };
  284. class HttpClient {
  285. public:
  286. int init(const std::string & url, const std::vector<std::string> & headers, const std::string & output_file,
  287. const bool progress, std::string * response_str = nullptr) {
  288. if (std::filesystem::exists(output_file)) {
  289. return 0;
  290. }
  291. std::string output_file_partial;
  292. curl = curl_easy_init();
  293. if (!curl) {
  294. return 1;
  295. }
  296. progress_data data;
  297. File out;
  298. if (!output_file.empty()) {
  299. output_file_partial = output_file + ".partial";
  300. if (!out.open(output_file_partial, "ab")) {
  301. printe("Failed to open file\n");
  302. return 1;
  303. }
  304. if (out.lock()) {
  305. printe("Failed to exclusively lock file\n");
  306. return 1;
  307. }
  308. }
  309. set_write_options(response_str, out);
  310. data.file_size = set_resume_point(output_file_partial);
  311. set_progress_options(progress, data);
  312. set_headers(headers);
  313. CURLcode res = perform(url);
  314. if (res != CURLE_OK){
  315. printe("Fetching resource '%s' failed: %s\n", url.c_str(), curl_easy_strerror(res));
  316. return 1;
  317. }
  318. if (!output_file.empty()) {
  319. std::filesystem::rename(output_file_partial, output_file);
  320. }
  321. return 0;
  322. }
  323. ~HttpClient() {
  324. if (chunk) {
  325. curl_slist_free_all(chunk);
  326. }
  327. if (curl) {
  328. curl_easy_cleanup(curl);
  329. }
  330. }
  331. private:
  332. CURL * curl = nullptr;
  333. struct curl_slist * chunk = nullptr;
  334. void set_write_options(std::string * response_str, const File & out) {
  335. if (response_str) {
  336. curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, capture_data);
  337. curl_easy_setopt(curl, CURLOPT_WRITEDATA, response_str);
  338. } else {
  339. curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, write_data);
  340. curl_easy_setopt(curl, CURLOPT_WRITEDATA, out.file);
  341. }
  342. }
  343. size_t set_resume_point(const std::string & output_file) {
  344. size_t file_size = 0;
  345. if (std::filesystem::exists(output_file)) {
  346. file_size = std::filesystem::file_size(output_file);
  347. curl_easy_setopt(curl, CURLOPT_RESUME_FROM_LARGE, static_cast<curl_off_t>(file_size));
  348. }
  349. return file_size;
  350. }
  351. void set_progress_options(bool progress, progress_data & data) {
  352. if (progress) {
  353. curl_easy_setopt(curl, CURLOPT_NOPROGRESS, 0L);
  354. curl_easy_setopt(curl, CURLOPT_XFERINFODATA, &data);
  355. curl_easy_setopt(curl, CURLOPT_XFERINFOFUNCTION, update_progress);
  356. }
  357. }
  358. void set_headers(const std::vector<std::string> & headers) {
  359. if (!headers.empty()) {
  360. if (chunk) {
  361. curl_slist_free_all(chunk);
  362. chunk = 0;
  363. }
  364. for (const auto & header : headers) {
  365. chunk = curl_slist_append(chunk, header.c_str());
  366. }
  367. curl_easy_setopt(curl, CURLOPT_HTTPHEADER, chunk);
  368. }
  369. }
  370. CURLcode perform(const std::string & url) {
  371. curl_easy_setopt(curl, CURLOPT_URL, url.c_str());
  372. curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L);
  373. curl_easy_setopt(curl, CURLOPT_DEFAULT_PROTOCOL, "https");
  374. curl_easy_setopt(curl, CURLOPT_FAILONERROR, 1L);
  375. return curl_easy_perform(curl);
  376. }
  377. static std::string human_readable_time(double seconds) {
  378. int hrs = static_cast<int>(seconds) / 3600;
  379. int mins = (static_cast<int>(seconds) % 3600) / 60;
  380. int secs = static_cast<int>(seconds) % 60;
  381. if (hrs > 0) {
  382. return fmt("%dh %02dm %02ds", hrs, mins, secs);
  383. } else if (mins > 0) {
  384. return fmt("%dm %02ds", mins, secs);
  385. } else {
  386. return fmt("%ds", secs);
  387. }
  388. }
  389. static std::string human_readable_size(curl_off_t size) {
  390. static const char * suffix[] = { "B", "KB", "MB", "GB", "TB" };
  391. char length = sizeof(suffix) / sizeof(suffix[0]);
  392. int i = 0;
  393. double dbl_size = size;
  394. if (size > 1024) {
  395. for (i = 0; (size / 1024) > 0 && i < length - 1; i++, size /= 1024) {
  396. dbl_size = size / 1024.0;
  397. }
  398. }
  399. return fmt("%.2f %s", dbl_size, suffix[i]);
  400. }
  401. static int update_progress(void * ptr, curl_off_t total_to_download, curl_off_t now_downloaded, curl_off_t,
  402. curl_off_t) {
  403. progress_data * data = static_cast<progress_data *>(ptr);
  404. if (total_to_download <= 0) {
  405. return 0;
  406. }
  407. total_to_download += data->file_size;
  408. const curl_off_t now_downloaded_plus_file_size = now_downloaded + data->file_size;
  409. const curl_off_t percentage = calculate_percentage(now_downloaded_plus_file_size, total_to_download);
  410. std::string progress_prefix = generate_progress_prefix(percentage);
  411. const double speed = calculate_speed(now_downloaded, data->start_time);
  412. const double tim = (total_to_download - now_downloaded) / speed;
  413. std::string progress_suffix =
  414. generate_progress_suffix(now_downloaded_plus_file_size, total_to_download, speed, tim);
  415. int progress_bar_width = calculate_progress_bar_width(progress_prefix, progress_suffix);
  416. std::string progress_bar;
  417. generate_progress_bar(progress_bar_width, percentage, progress_bar);
  418. print_progress(progress_prefix, progress_bar, progress_suffix);
  419. data->printed = true;
  420. return 0;
  421. }
  422. static curl_off_t calculate_percentage(curl_off_t now_downloaded_plus_file_size, curl_off_t total_to_download) {
  423. return (now_downloaded_plus_file_size * 100) / total_to_download;
  424. }
  425. static std::string generate_progress_prefix(curl_off_t percentage) { return fmt("%3ld%% |", static_cast<long int>(percentage)); }
  426. static double calculate_speed(curl_off_t now_downloaded, const std::chrono::steady_clock::time_point & start_time) {
  427. const auto now = std::chrono::steady_clock::now();
  428. const std::chrono::duration<double> elapsed_seconds = now - start_time;
  429. return now_downloaded / elapsed_seconds.count();
  430. }
  431. static std::string generate_progress_suffix(curl_off_t now_downloaded_plus_file_size, curl_off_t total_to_download,
  432. double speed, double estimated_time) {
  433. const int width = 10;
  434. return fmt("%*s/%*s%*s/s%*s", width, human_readable_size(now_downloaded_plus_file_size).c_str(), width,
  435. human_readable_size(total_to_download).c_str(), width, human_readable_size(speed).c_str(), width,
  436. human_readable_time(estimated_time).c_str());
  437. }
  438. static int calculate_progress_bar_width(const std::string & progress_prefix, const std::string & progress_suffix) {
  439. int progress_bar_width = get_terminal_width() - progress_prefix.size() - progress_suffix.size() - 3;
  440. if (progress_bar_width < 1) {
  441. progress_bar_width = 1;
  442. }
  443. return progress_bar_width;
  444. }
  445. static std::string generate_progress_bar(int progress_bar_width, curl_off_t percentage,
  446. std::string & progress_bar) {
  447. const curl_off_t pos = (percentage * progress_bar_width) / 100;
  448. for (int i = 0; i < progress_bar_width; ++i) {
  449. progress_bar.append((i < pos) ? "█" : " ");
  450. }
  451. return progress_bar;
  452. }
  453. static void print_progress(const std::string & progress_prefix, const std::string & progress_bar,
  454. const std::string & progress_suffix) {
  455. printe("\r%*s\r%s%s| %s", get_terminal_width(), " ", progress_prefix.c_str(), progress_bar.c_str(),
  456. progress_suffix.c_str());
  457. }
  458. // Function to write data to a file
  459. static size_t write_data(void * ptr, size_t size, size_t nmemb, void * stream) {
  460. FILE * out = static_cast<FILE *>(stream);
  461. return fwrite(ptr, size, nmemb, out);
  462. }
  463. // Function to capture data into a string
  464. static size_t capture_data(void * ptr, size_t size, size_t nmemb, void * stream) {
  465. std::string * str = static_cast<std::string *>(stream);
  466. str->append(static_cast<char *>(ptr), size * nmemb);
  467. return size * nmemb;
  468. }
  469. };
  470. #endif
  471. class LlamaData {
  472. public:
  473. llama_model_ptr model;
  474. llama_sampler_ptr sampler;
  475. llama_context_ptr context;
  476. std::vector<llama_chat_message> messages;
  477. std::list<std::string> msg_strs;
  478. std::vector<char> fmtted;
  479. int init(Opt & opt) {
  480. model = initialize_model(opt);
  481. if (!model) {
  482. return 1;
  483. }
  484. context = initialize_context(model, opt);
  485. if (!context) {
  486. return 1;
  487. }
  488. sampler = initialize_sampler(opt);
  489. return 0;
  490. }
  491. private:
  492. #ifdef LLAMA_USE_CURL
  493. int download(const std::string & url, const std::string & output_file, const bool progress,
  494. const std::vector<std::string> & headers = {}, std::string * response_str = nullptr) {
  495. HttpClient http;
  496. if (http.init(url, headers, output_file, progress, response_str)) {
  497. return 1;
  498. }
  499. return 0;
  500. }
  501. #else
  502. int download(const std::string &, const std::string &, const bool, const std::vector<std::string> & = {},
  503. std::string * = nullptr) {
  504. printe("%s: llama.cpp built without libcurl, downloading from an url not supported.\n", __func__);
  505. return 1;
  506. }
  507. #endif
  508. // Helper function to handle model tag extraction and URL construction
  509. std::pair<std::string, std::string> extract_model_and_tag(std::string & model, const std::string & base_url) {
  510. std::string model_tag = "latest";
  511. const size_t colon_pos = model.find(':');
  512. if (colon_pos != std::string::npos) {
  513. model_tag = model.substr(colon_pos + 1);
  514. model = model.substr(0, colon_pos);
  515. }
  516. std::string url = base_url + model + "/manifests/" + model_tag;
  517. return { model, url };
  518. }
  519. // Helper function to download and parse the manifest
  520. int download_and_parse_manifest(const std::string & url, const std::vector<std::string> & headers,
  521. nlohmann::json & manifest) {
  522. std::string manifest_str;
  523. int ret = download(url, "", false, headers, &manifest_str);
  524. if (ret) {
  525. return ret;
  526. }
  527. manifest = nlohmann::json::parse(manifest_str);
  528. return 0;
  529. }
  530. int huggingface_dl(std::string & model, const std::string & bn) {
  531. // Find the second occurrence of '/' after protocol string
  532. size_t pos = model.find('/');
  533. pos = model.find('/', pos + 1);
  534. std::string hfr, hff;
  535. std::vector<std::string> headers = { "User-Agent: llama-cpp", "Accept: application/json" };
  536. std::string url;
  537. if (pos == std::string::npos) {
  538. auto [model_name, manifest_url] = extract_model_and_tag(model, "https://huggingface.co/v2/");
  539. hfr = model_name;
  540. nlohmann::json manifest;
  541. int ret = download_and_parse_manifest(manifest_url, headers, manifest);
  542. if (ret) {
  543. return ret;
  544. }
  545. hff = manifest["ggufFile"]["rfilename"];
  546. } else {
  547. hfr = model.substr(0, pos);
  548. hff = model.substr(pos + 1);
  549. }
  550. url = "https://huggingface.co/" + hfr + "/resolve/main/" + hff;
  551. return download(url, bn, true, headers);
  552. }
  553. int ollama_dl(std::string & model, const std::string & bn) {
  554. const std::vector<std::string> headers = { "Accept: application/vnd.docker.distribution.manifest.v2+json" };
  555. if (model.find('/') == std::string::npos) {
  556. model = "library/" + model;
  557. }
  558. auto [model_name, manifest_url] = extract_model_and_tag(model, "https://registry.ollama.ai/v2/");
  559. nlohmann::json manifest;
  560. int ret = download_and_parse_manifest(manifest_url, {}, manifest);
  561. if (ret) {
  562. return ret;
  563. }
  564. std::string layer;
  565. for (const auto & l : manifest["layers"]) {
  566. if (l["mediaType"] == "application/vnd.ollama.image.model") {
  567. layer = l["digest"];
  568. break;
  569. }
  570. }
  571. std::string blob_url = "https://registry.ollama.ai/v2/" + model_name + "/blobs/" + layer;
  572. return download(blob_url, bn, true, headers);
  573. }
  574. int github_dl(const std::string & model, const std::string & bn) {
  575. std::string repository = model;
  576. std::string branch = "main";
  577. const size_t at_pos = model.find('@');
  578. if (at_pos != std::string::npos) {
  579. repository = model.substr(0, at_pos);
  580. branch = model.substr(at_pos + 1);
  581. }
  582. const std::vector<std::string> repo_parts = string_split(repository, "/");
  583. if (repo_parts.size() < 3) {
  584. printe("Invalid GitHub repository format\n");
  585. return 1;
  586. }
  587. const std::string & org = repo_parts[0];
  588. const std::string & project = repo_parts[1];
  589. std::string url = "https://raw.githubusercontent.com/" + org + "/" + project + "/" + branch;
  590. for (size_t i = 2; i < repo_parts.size(); ++i) {
  591. url += "/" + repo_parts[i];
  592. }
  593. return download(url, bn, true);
  594. }
  595. int s3_dl(const std::string & model, const std::string & bn) {
  596. const size_t slash_pos = model.find('/');
  597. if (slash_pos == std::string::npos) {
  598. return 1;
  599. }
  600. const std::string bucket = model.substr(0, slash_pos);
  601. const std::string key = model.substr(slash_pos + 1);
  602. const char * access_key = std::getenv("AWS_ACCESS_KEY_ID");
  603. const char * secret_key = std::getenv("AWS_SECRET_ACCESS_KEY");
  604. if (!access_key || !secret_key) {
  605. printe("AWS credentials not found in environment\n");
  606. return 1;
  607. }
  608. // Generate AWS Signature Version 4 headers
  609. // (Implementation requires HMAC-SHA256 and date handling)
  610. // Get current timestamp
  611. const time_t now = time(nullptr);
  612. const tm tm = *gmtime(&now);
  613. const std::string date = strftime_fmt("%Y%m%d", tm);
  614. const std::string datetime = strftime_fmt("%Y%m%dT%H%M%SZ", tm);
  615. const std::vector<std::string> headers = {
  616. "Authorization: AWS4-HMAC-SHA256 Credential=" + std::string(access_key) + "/" + date +
  617. "/us-east-1/s3/aws4_request",
  618. "x-amz-content-sha256: UNSIGNED-PAYLOAD", "x-amz-date: " + datetime
  619. };
  620. const std::string url = "https://" + bucket + ".s3.amazonaws.com/" + key;
  621. return download(url, bn, true, headers);
  622. }
  623. std::string basename(const std::string & path) {
  624. const size_t pos = path.find_last_of("/\\");
  625. if (pos == std::string::npos) {
  626. return path;
  627. }
  628. return path.substr(pos + 1);
  629. }
  630. int rm_until_substring(std::string & model_, const std::string & substring) {
  631. const std::string::size_type pos = model_.find(substring);
  632. if (pos == std::string::npos) {
  633. return 1;
  634. }
  635. model_ = model_.substr(pos + substring.size()); // Skip past the substring
  636. return 0;
  637. }
  638. int resolve_model(std::string & model_) {
  639. int ret = 0;
  640. if (string_starts_with(model_, "file://") || std::filesystem::exists(model_)) {
  641. rm_until_substring(model_, "://");
  642. return ret;
  643. }
  644. const std::string bn = basename(model_);
  645. if (string_starts_with(model_, "hf://") || string_starts_with(model_, "huggingface://") ||
  646. string_starts_with(model_, "hf.co/")) {
  647. rm_until_substring(model_, "hf.co/");
  648. rm_until_substring(model_, "://");
  649. ret = huggingface_dl(model_, bn);
  650. } else if ((string_starts_with(model_, "https://") || string_starts_with(model_, "http://")) &&
  651. !string_starts_with(model_, "https://ollama.com/library/")) {
  652. ret = download(model_, bn, true);
  653. } else if (string_starts_with(model_, "github:") || string_starts_with(model_, "github://")) {
  654. rm_until_substring(model_, "github:");
  655. rm_until_substring(model_, "://");
  656. ret = github_dl(model_, bn);
  657. } else if (string_starts_with(model_, "s3://")) {
  658. rm_until_substring(model_, "://");
  659. ret = s3_dl(model_, bn);
  660. } else { // ollama:// or nothing
  661. rm_until_substring(model_, "ollama.com/library/");
  662. rm_until_substring(model_, "://");
  663. ret = ollama_dl(model_, bn);
  664. }
  665. model_ = bn;
  666. return ret;
  667. }
  668. // Initializes the model and returns a unique pointer to it
  669. llama_model_ptr initialize_model(Opt & opt) {
  670. ggml_backend_load_all();
  671. resolve_model(opt.model_);
  672. printe(
  673. "\r%*s"
  674. "\rLoading model",
  675. get_terminal_width(), " ");
  676. llama_model_ptr model(llama_model_load_from_file(opt.model_.c_str(), opt.model_params));
  677. if (!model) {
  678. printe("%s: error: unable to load model from file: %s\n", __func__, opt.model_.c_str());
  679. }
  680. printe("\r%*s\r", static_cast<int>(sizeof("Loading model")), " ");
  681. return model;
  682. }
  683. // Initializes the context with the specified parameters
  684. llama_context_ptr initialize_context(const llama_model_ptr & model, const Opt & opt) {
  685. llama_context_ptr context(llama_init_from_model(model.get(), opt.ctx_params));
  686. if (!context) {
  687. printe("%s: error: failed to create the llama_context\n", __func__);
  688. }
  689. return context;
  690. }
  691. // Initializes and configures the sampler
  692. llama_sampler_ptr initialize_sampler(const Opt & opt) {
  693. llama_sampler_ptr sampler(llama_sampler_chain_init(llama_sampler_chain_default_params()));
  694. llama_sampler_chain_add(sampler.get(), llama_sampler_init_min_p(0.05f, 1));
  695. llama_sampler_chain_add(sampler.get(), llama_sampler_init_temp(opt.temperature));
  696. llama_sampler_chain_add(sampler.get(), llama_sampler_init_dist(LLAMA_DEFAULT_SEED));
  697. return sampler;
  698. }
  699. };
  700. // Add a message to `messages` and store its content in `msg_strs`
  701. static void add_message(const char * role, const std::string & text, LlamaData & llama_data) {
  702. llama_data.msg_strs.push_back(std::move(text));
  703. llama_data.messages.push_back({ role, llama_data.msg_strs.back().c_str() });
  704. }
  705. // Function to apply the chat template and resize `formatted` if needed
  706. static int apply_chat_template(const common_chat_template & tmpl, LlamaData & llama_data, const bool append, bool use_jinja) {
  707. if (use_jinja) {
  708. json messages = json::array();
  709. for (const auto & msg : llama_data.messages) {
  710. messages.push_back({
  711. {"role", msg.role},
  712. {"content", msg.content},
  713. });
  714. }
  715. try {
  716. minja::chat_template_inputs tmpl_inputs;
  717. tmpl_inputs.messages = messages;
  718. tmpl_inputs.add_generation_prompt = append;
  719. minja::chat_template_options tmpl_opts;
  720. tmpl_opts.use_bos_token = false;
  721. tmpl_opts.use_eos_token = false;
  722. auto result = tmpl.apply(tmpl_inputs, tmpl_opts);
  723. llama_data.fmtted.resize(result.size() + 1);
  724. memcpy(llama_data.fmtted.data(), result.c_str(), result.size() + 1);
  725. return result.size();
  726. } catch (const std::exception & e) {
  727. printe("failed to render the chat template: %s\n", e.what());
  728. return -1;
  729. }
  730. }
  731. int result = llama_chat_apply_template(
  732. tmpl.source().c_str(), llama_data.messages.data(), llama_data.messages.size(), append,
  733. append ? llama_data.fmtted.data() : nullptr, append ? llama_data.fmtted.size() : 0);
  734. if (append && result > static_cast<int>(llama_data.fmtted.size())) {
  735. llama_data.fmtted.resize(result);
  736. result = llama_chat_apply_template(tmpl.source().c_str(), llama_data.messages.data(),
  737. llama_data.messages.size(), append, llama_data.fmtted.data(),
  738. llama_data.fmtted.size());
  739. }
  740. return result;
  741. }
  742. // Function to tokenize the prompt
  743. static int tokenize_prompt(const llama_vocab * vocab, const std::string & prompt,
  744. std::vector<llama_token> & prompt_tokens, const LlamaData & llama_data) {
  745. const bool is_first = llama_get_kv_cache_used_cells(llama_data.context.get()) == 0;
  746. const int n_prompt_tokens = -llama_tokenize(vocab, prompt.c_str(), prompt.size(), NULL, 0, is_first, true);
  747. prompt_tokens.resize(n_prompt_tokens);
  748. if (llama_tokenize(vocab, prompt.c_str(), prompt.size(), prompt_tokens.data(), prompt_tokens.size(), is_first,
  749. true) < 0) {
  750. printe("failed to tokenize the prompt\n");
  751. return -1;
  752. }
  753. return n_prompt_tokens;
  754. }
  755. // Check if we have enough space in the context to evaluate this batch
  756. static int check_context_size(const llama_context_ptr & ctx, const llama_batch & batch) {
  757. const int n_ctx = llama_n_ctx(ctx.get());
  758. const int n_ctx_used = llama_get_kv_cache_used_cells(ctx.get());
  759. if (n_ctx_used + batch.n_tokens > n_ctx) {
  760. printf(LOG_COL_DEFAULT "\n");
  761. printe("context size exceeded\n");
  762. return 1;
  763. }
  764. return 0;
  765. }
  766. // convert the token to a string
  767. static int convert_token_to_string(const llama_vocab * vocab, const llama_token token_id, std::string & piece) {
  768. char buf[256];
  769. int n = llama_token_to_piece(vocab, token_id, buf, sizeof(buf), 0, true);
  770. if (n < 0) {
  771. printe("failed to convert token to piece\n");
  772. return 1;
  773. }
  774. piece = std::string(buf, n);
  775. return 0;
  776. }
  777. static void print_word_and_concatenate_to_response(const std::string & piece, std::string & response) {
  778. printf("%s", piece.c_str());
  779. fflush(stdout);
  780. response += piece;
  781. }
  782. // helper function to evaluate a prompt and generate a response
  783. static int generate(LlamaData & llama_data, const std::string & prompt, std::string & response) {
  784. const llama_vocab * vocab = llama_model_get_vocab(llama_data.model.get());
  785. std::vector<llama_token> tokens;
  786. if (tokenize_prompt(vocab, prompt, tokens, llama_data) < 0) {
  787. return 1;
  788. }
  789. // prepare a batch for the prompt
  790. llama_batch batch = llama_batch_get_one(tokens.data(), tokens.size());
  791. llama_token new_token_id;
  792. while (true) {
  793. check_context_size(llama_data.context, batch);
  794. if (llama_decode(llama_data.context.get(), batch)) {
  795. printe("failed to decode\n");
  796. return 1;
  797. }
  798. // sample the next token, check is it an end of generation?
  799. new_token_id = llama_sampler_sample(llama_data.sampler.get(), llama_data.context.get(), -1);
  800. if (llama_vocab_is_eog(vocab, new_token_id)) {
  801. break;
  802. }
  803. std::string piece;
  804. if (convert_token_to_string(vocab, new_token_id, piece)) {
  805. return 1;
  806. }
  807. print_word_and_concatenate_to_response(piece, response);
  808. // prepare the next batch with the sampled token
  809. batch = llama_batch_get_one(&new_token_id, 1);
  810. }
  811. printf(LOG_COL_DEFAULT);
  812. return 0;
  813. }
  814. static int read_user_input(std::string & user_input) {
  815. static const char * prompt_prefix = "> ";
  816. #ifdef WIN32
  817. printf(
  818. "\r%*s"
  819. "\r" LOG_COL_DEFAULT "%s",
  820. get_terminal_width(), " ", prompt_prefix);
  821. std::getline(std::cin, user_input);
  822. if (std::cin.eof()) {
  823. printf("\n");
  824. return 1;
  825. }
  826. #else
  827. std::unique_ptr<char, decltype(&std::free)> line(const_cast<char *>(linenoise(prompt_prefix)), free);
  828. if (!line) {
  829. return 1;
  830. }
  831. user_input = line.get();
  832. #endif
  833. if (user_input == "/bye") {
  834. return 1;
  835. }
  836. if (user_input.empty()) {
  837. return 2;
  838. }
  839. #ifndef WIN32
  840. linenoiseHistoryAdd(line.get());
  841. #endif
  842. return 0; // Should have data in happy path
  843. }
  844. // Function to generate a response based on the prompt
  845. static int generate_response(LlamaData & llama_data, const std::string & prompt, std::string & response,
  846. const bool stdout_a_terminal) {
  847. // Set response color
  848. if (stdout_a_terminal) {
  849. printf(LOG_COL_YELLOW);
  850. }
  851. if (generate(llama_data, prompt, response)) {
  852. printe("failed to generate response\n");
  853. return 1;
  854. }
  855. // End response with color reset and newline
  856. printf("\n%s", stdout_a_terminal ? LOG_COL_DEFAULT : "");
  857. return 0;
  858. }
  859. // Helper function to apply the chat template and handle errors
  860. static int apply_chat_template_with_error_handling(const common_chat_template & tmpl, LlamaData & llama_data, const bool append, int & output_length, bool use_jinja) {
  861. const int new_len = apply_chat_template(tmpl, llama_data, append, use_jinja);
  862. if (new_len < 0) {
  863. printe("failed to apply the chat template\n");
  864. return -1;
  865. }
  866. output_length = new_len;
  867. return 0;
  868. }
  869. // Helper function to handle user input
  870. static int handle_user_input(std::string & user_input, const std::string & user) {
  871. if (!user.empty()) {
  872. user_input = user;
  873. return 0; // No need for interactive input
  874. }
  875. return read_user_input(user_input); // Returns true if input ends the loop
  876. }
  877. static bool is_stdin_a_terminal() {
  878. #if defined(_WIN32)
  879. HANDLE hStdin = GetStdHandle(STD_INPUT_HANDLE);
  880. DWORD mode;
  881. return GetConsoleMode(hStdin, &mode);
  882. #else
  883. return isatty(STDIN_FILENO);
  884. #endif
  885. }
  886. static bool is_stdout_a_terminal() {
  887. #if defined(_WIN32)
  888. HANDLE hStdout = GetStdHandle(STD_OUTPUT_HANDLE);
  889. DWORD mode;
  890. return GetConsoleMode(hStdout, &mode);
  891. #else
  892. return isatty(STDOUT_FILENO);
  893. #endif
  894. }
  895. // Function to handle user input
  896. static int get_user_input(std::string & user_input, const std::string & user) {
  897. while (true) {
  898. const int ret = handle_user_input(user_input, user);
  899. if (ret == 1) {
  900. return 1;
  901. }
  902. if (ret == 2) {
  903. continue;
  904. }
  905. break;
  906. }
  907. return 0;
  908. }
  909. // Main chat loop function
  910. static int chat_loop(LlamaData & llama_data, const std::string & user, bool use_jinja) {
  911. int prev_len = 0;
  912. llama_data.fmtted.resize(llama_n_ctx(llama_data.context.get()));
  913. auto chat_templates = common_chat_templates_from_model(llama_data.model.get(), "");
  914. GGML_ASSERT(chat_templates.template_default);
  915. static const bool stdout_a_terminal = is_stdout_a_terminal();
  916. while (true) {
  917. // Get user input
  918. std::string user_input;
  919. if (get_user_input(user_input, user) == 1) {
  920. return 0;
  921. }
  922. add_message("user", user.empty() ? user_input : user, llama_data);
  923. int new_len;
  924. if (apply_chat_template_with_error_handling(*chat_templates.template_default, llama_data, true, new_len, use_jinja) < 0) {
  925. return 1;
  926. }
  927. std::string prompt(llama_data.fmtted.begin() + prev_len, llama_data.fmtted.begin() + new_len);
  928. std::string response;
  929. if (generate_response(llama_data, prompt, response, stdout_a_terminal)) {
  930. return 1;
  931. }
  932. if (!user.empty()) {
  933. break;
  934. }
  935. add_message("assistant", response, llama_data);
  936. if (apply_chat_template_with_error_handling(*chat_templates.template_default, llama_data, false, prev_len, use_jinja) < 0) {
  937. return 1;
  938. }
  939. }
  940. return 0;
  941. }
  942. static void log_callback(const enum ggml_log_level level, const char * text, void * p) {
  943. const Opt * opt = static_cast<Opt *>(p);
  944. if (opt->verbose || level == GGML_LOG_LEVEL_ERROR) {
  945. printe("%s", text);
  946. }
  947. }
  948. static std::string read_pipe_data() {
  949. std::ostringstream result;
  950. result << std::cin.rdbuf(); // Read all data from std::cin
  951. return result.str();
  952. }
  953. static void ctrl_c_handling() {
  954. #if defined(__unix__) || (defined(__APPLE__) && defined(__MACH__))
  955. struct sigaction sigint_action;
  956. sigint_action.sa_handler = sigint_handler;
  957. sigemptyset(&sigint_action.sa_mask);
  958. sigint_action.sa_flags = 0;
  959. sigaction(SIGINT, &sigint_action, NULL);
  960. #elif defined(_WIN32)
  961. auto console_ctrl_handler = +[](DWORD ctrl_type) -> BOOL {
  962. return (ctrl_type == CTRL_C_EVENT) ? (sigint_handler(SIGINT), true) : false;
  963. };
  964. SetConsoleCtrlHandler(reinterpret_cast<PHANDLER_ROUTINE>(console_ctrl_handler), true);
  965. #endif
  966. }
  967. int main(int argc, const char ** argv) {
  968. ctrl_c_handling();
  969. Opt opt;
  970. const int ret = opt.init(argc, argv);
  971. if (ret == 2) {
  972. return 0;
  973. } else if (ret) {
  974. return 1;
  975. }
  976. if (!is_stdin_a_terminal()) {
  977. if (!opt.user.empty()) {
  978. opt.user += "\n\n";
  979. }
  980. opt.user += read_pipe_data();
  981. }
  982. llama_log_set(log_callback, &opt);
  983. LlamaData llama_data;
  984. if (llama_data.init(opt)) {
  985. return 1;
  986. }
  987. if (chat_loop(llama_data, opt.user, opt.use_jinja)) {
  988. return 1;
  989. }
  990. return 0;
  991. }