server-models.cpp 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960
  1. #include "server-common.h"
  2. #include "server-models.h"
  3. #include "preset.h"
  4. #include "download.h"
  5. #include <cpp-httplib/httplib.h> // TODO: remove this once we use HTTP client from download.h
  6. #include <sheredom/subprocess.h>
  7. #include <functional>
  8. #include <algorithm>
  9. #include <thread>
  10. #include <mutex>
  11. #include <condition_variable>
  12. #include <cstring>
  13. #include <atomic>
  14. #include <chrono>
  15. #include <queue>
  16. #include <filesystem>
  17. #include <cstring>
  18. #ifdef _WIN32
  19. #include <winsock2.h>
  20. #else
  21. #include <sys/socket.h>
  22. #include <netinet/in.h>
  23. #include <arpa/inet.h>
  24. #include <unistd.h>
  25. #endif
  26. #if defined(__APPLE__) && defined(__MACH__)
  27. // macOS: use _NSGetExecutablePath to get the executable path
  28. #include <mach-o/dyld.h>
  29. #include <limits.h>
  30. #endif
  31. #define CMD_ROUTER_TO_CHILD_EXIT "cmd_router_to_child:exit"
  32. #define CMD_CHILD_TO_ROUTER_READY "cmd_child_to_router:ready"
  33. // address for child process, this is needed because router may run on 0.0.0.0
  34. // ref: https://github.com/ggml-org/llama.cpp/issues/17862
  35. #define CHILD_ADDR "127.0.0.1"
  36. static std::filesystem::path get_server_exec_path() {
  37. #if defined(_WIN32)
  38. wchar_t buf[32768] = { 0 }; // Large buffer to handle long paths
  39. DWORD len = GetModuleFileNameW(nullptr, buf, _countof(buf));
  40. if (len == 0 || len >= _countof(buf)) {
  41. throw std::runtime_error("GetModuleFileNameW failed or path too long");
  42. }
  43. return std::filesystem::path(buf);
  44. #elif defined(__APPLE__) && defined(__MACH__)
  45. char small_path[PATH_MAX];
  46. uint32_t size = sizeof(small_path);
  47. if (_NSGetExecutablePath(small_path, &size) == 0) {
  48. // resolve any symlinks to get absolute path
  49. try {
  50. return std::filesystem::canonical(std::filesystem::path(small_path));
  51. } catch (...) {
  52. return std::filesystem::path(small_path);
  53. }
  54. } else {
  55. // buffer was too small, allocate required size and call again
  56. std::vector<char> buf(size);
  57. if (_NSGetExecutablePath(buf.data(), &size) == 0) {
  58. try {
  59. return std::filesystem::canonical(std::filesystem::path(buf.data()));
  60. } catch (...) {
  61. return std::filesystem::path(buf.data());
  62. }
  63. }
  64. throw std::runtime_error("_NSGetExecutablePath failed after buffer resize");
  65. }
  66. #else
  67. char path[FILENAME_MAX];
  68. ssize_t count = readlink("/proc/self/exe", path, FILENAME_MAX);
  69. if (count <= 0) {
  70. throw std::runtime_error("failed to resolve /proc/self/exe");
  71. }
  72. return std::filesystem::path(std::string(path, count));
  73. #endif
  74. }
  75. static void unset_reserved_args(common_preset & preset, bool unset_model_args) {
  76. preset.unset_option("LLAMA_ARG_SSL_KEY_FILE");
  77. preset.unset_option("LLAMA_ARG_SSL_CERT_FILE");
  78. preset.unset_option("LLAMA_API_KEY");
  79. preset.unset_option("LLAMA_ARG_MODELS_DIR");
  80. preset.unset_option("LLAMA_ARG_MODELS_MAX");
  81. preset.unset_option("LLAMA_ARG_MODELS_PRESET");
  82. preset.unset_option("LLAMA_ARG_MODELS_AUTOLOAD");
  83. if (unset_model_args) {
  84. preset.unset_option("LLAMA_ARG_MODEL");
  85. preset.unset_option("LLAMA_ARG_MMPROJ");
  86. preset.unset_option("LLAMA_ARG_HF_REPO");
  87. }
  88. }
  89. void server_model_meta::update_args(common_preset_context & ctx_preset, std::string bin_path) {
  90. // update params
  91. unset_reserved_args(preset, false);
  92. preset.set_option(ctx_preset, "LLAMA_ARG_HOST", CHILD_ADDR);
  93. preset.set_option(ctx_preset, "LLAMA_ARG_PORT", std::to_string(port));
  94. preset.set_option(ctx_preset, "LLAMA_ARG_ALIAS", name);
  95. // TODO: maybe validate preset before rendering ?
  96. // render args
  97. args = preset.to_args(bin_path);
  98. }
  99. //
  100. // server_models
  101. //
  102. server_models::server_models(
  103. const common_params & params,
  104. int argc,
  105. char ** argv,
  106. char ** envp)
  107. : ctx_preset(LLAMA_EXAMPLE_SERVER),
  108. base_params(params),
  109. base_preset(ctx_preset.load_from_args(argc, argv)) {
  110. for (char ** env = envp; *env != nullptr; env++) {
  111. base_env.push_back(std::string(*env));
  112. }
  113. // clean up base preset
  114. unset_reserved_args(base_preset, true);
  115. // set binary path
  116. try {
  117. bin_path = get_server_exec_path().string();
  118. } catch (const std::exception & e) {
  119. bin_path = argv[0];
  120. LOG_WRN("failed to get server executable path: %s\n", e.what());
  121. LOG_WRN("using original argv[0] as fallback: %s\n", argv[0]);
  122. }
  123. load_models();
  124. }
  125. void server_models::add_model(server_model_meta && meta) {
  126. if (mapping.find(meta.name) != mapping.end()) {
  127. throw std::runtime_error(string_format("model '%s' appears multiple times", meta.name.c_str()));
  128. }
  129. meta.update_args(ctx_preset, bin_path); // render args
  130. std::string name = meta.name;
  131. mapping[name] = instance_t{
  132. /* subproc */ std::make_shared<subprocess_s>(),
  133. /* th */ std::thread(),
  134. /* meta */ std::move(meta)
  135. };
  136. }
  137. // TODO: allow refreshing cached model list
  138. void server_models::load_models() {
  139. // loading models from 3 sources:
  140. // 1. cached models
  141. common_presets cached_models = ctx_preset.load_from_cache();
  142. SRV_INF("Loaded %zu cached model presets\n", cached_models.size());
  143. // 2. local models from --models-dir
  144. common_presets local_models;
  145. if (!base_params.models_dir.empty()) {
  146. local_models = ctx_preset.load_from_models_dir(base_params.models_dir);
  147. SRV_INF("Loaded %zu local model presets from %s\n", local_models.size(), base_params.models_dir.c_str());
  148. }
  149. // 3. custom-path models from presets
  150. common_preset global = {};
  151. common_presets custom_presets = {};
  152. if (!base_params.models_preset.empty()) {
  153. custom_presets = ctx_preset.load_from_ini(base_params.models_preset, global);
  154. SRV_INF("Loaded %zu custom model presets from %s\n", custom_presets.size(), base_params.models_preset.c_str());
  155. }
  156. // cascade, apply global preset first
  157. cached_models = ctx_preset.cascade(global, cached_models);
  158. local_models = ctx_preset.cascade(global, local_models);
  159. custom_presets = ctx_preset.cascade(global, custom_presets);
  160. // note: if a model exists in both cached and local, local takes precedence
  161. common_presets final_presets;
  162. for (const auto & [name, preset] : cached_models) {
  163. final_presets[name] = preset;
  164. }
  165. for (const auto & [name, preset] : local_models) {
  166. final_presets[name] = preset;
  167. }
  168. // process custom presets from INI
  169. for (const auto & [name, custom] : custom_presets) {
  170. if (final_presets.find(name) != final_presets.end()) {
  171. // apply custom config if exists
  172. common_preset & target = final_presets[name];
  173. target.merge(custom);
  174. } else {
  175. // otherwise add directly
  176. final_presets[name] = custom;
  177. }
  178. }
  179. // server base preset from CLI args take highest precedence
  180. for (auto & [name, preset] : final_presets) {
  181. preset.merge(base_preset);
  182. }
  183. // convert presets to server_model_meta and add to mapping
  184. for (const auto & preset : final_presets) {
  185. server_model_meta meta{
  186. /* preset */ preset.second,
  187. /* name */ preset.first,
  188. /* port */ 0,
  189. /* status */ SERVER_MODEL_STATUS_UNLOADED,
  190. /* last_used */ 0,
  191. /* args */ std::vector<std::string>(),
  192. /* exit_code */ 0
  193. };
  194. add_model(std::move(meta));
  195. }
  196. // log available models
  197. {
  198. std::unordered_set<std::string> custom_names;
  199. for (const auto & [name, preset] : custom_presets) {
  200. custom_names.insert(name);
  201. }
  202. SRV_INF("Available models (%zu) (*: custom preset)\n", mapping.size());
  203. for (const auto & [name, inst] : mapping) {
  204. bool has_custom = custom_names.find(name) != custom_names.end();
  205. SRV_INF(" %c %s\n", has_custom ? '*' : ' ', name.c_str());
  206. }
  207. }
  208. }
  209. void server_models::update_meta(const std::string & name, const server_model_meta & meta) {
  210. std::lock_guard<std::mutex> lk(mutex);
  211. auto it = mapping.find(name);
  212. if (it != mapping.end()) {
  213. it->second.meta = meta;
  214. }
  215. cv.notify_all(); // notify wait_until_loaded
  216. }
  217. bool server_models::has_model(const std::string & name) {
  218. std::lock_guard<std::mutex> lk(mutex);
  219. return mapping.find(name) != mapping.end();
  220. }
  221. std::optional<server_model_meta> server_models::get_meta(const std::string & name) {
  222. std::lock_guard<std::mutex> lk(mutex);
  223. auto it = mapping.find(name);
  224. if (it != mapping.end()) {
  225. return it->second.meta;
  226. }
  227. return std::nullopt;
  228. }
  229. static int get_free_port() {
  230. #ifdef _WIN32
  231. WSADATA wsaData;
  232. if (WSAStartup(MAKEWORD(2, 2), &wsaData) != 0) {
  233. return -1;
  234. }
  235. typedef SOCKET native_socket_t;
  236. #define INVALID_SOCKET_VAL INVALID_SOCKET
  237. #define CLOSE_SOCKET(s) closesocket(s)
  238. #else
  239. typedef int native_socket_t;
  240. #define INVALID_SOCKET_VAL -1
  241. #define CLOSE_SOCKET(s) close(s)
  242. #endif
  243. native_socket_t sock = socket(AF_INET, SOCK_STREAM, 0);
  244. if (sock == INVALID_SOCKET_VAL) {
  245. #ifdef _WIN32
  246. WSACleanup();
  247. #endif
  248. return -1;
  249. }
  250. struct sockaddr_in serv_addr;
  251. std::memset(&serv_addr, 0, sizeof(serv_addr));
  252. serv_addr.sin_family = AF_INET;
  253. serv_addr.sin_addr.s_addr = htonl(INADDR_ANY);
  254. serv_addr.sin_port = htons(0);
  255. if (bind(sock, (struct sockaddr*)&serv_addr, sizeof(serv_addr)) != 0) {
  256. CLOSE_SOCKET(sock);
  257. #ifdef _WIN32
  258. WSACleanup();
  259. #endif
  260. return -1;
  261. }
  262. #ifdef _WIN32
  263. int namelen = sizeof(serv_addr);
  264. #else
  265. socklen_t namelen = sizeof(serv_addr);
  266. #endif
  267. if (getsockname(sock, (struct sockaddr*)&serv_addr, &namelen) != 0) {
  268. CLOSE_SOCKET(sock);
  269. #ifdef _WIN32
  270. WSACleanup();
  271. #endif
  272. return -1;
  273. }
  274. int port = ntohs(serv_addr.sin_port);
  275. CLOSE_SOCKET(sock);
  276. #ifdef _WIN32
  277. WSACleanup();
  278. #endif
  279. return port;
  280. }
  281. // helper to convert vector<string> to char **
  282. // pointers are only valid as long as the original vector is valid
  283. static std::vector<char *> to_char_ptr_array(const std::vector<std::string> & vec) {
  284. std::vector<char *> result;
  285. result.reserve(vec.size() + 1);
  286. for (const auto & s : vec) {
  287. result.push_back(const_cast<char*>(s.c_str()));
  288. }
  289. result.push_back(nullptr);
  290. return result;
  291. }
  292. std::vector<server_model_meta> server_models::get_all_meta() {
  293. std::lock_guard<std::mutex> lk(mutex);
  294. std::vector<server_model_meta> result;
  295. result.reserve(mapping.size());
  296. for (const auto & [name, inst] : mapping) {
  297. result.push_back(inst.meta);
  298. }
  299. return result;
  300. }
  301. void server_models::unload_lru() {
  302. if (base_params.models_max <= 0) {
  303. return; // no limit
  304. }
  305. // remove one of the servers if we passed the models_max (least recently used - LRU)
  306. std::string lru_model_name = "";
  307. int64_t lru_last_used = ggml_time_ms();
  308. size_t count_active = 0;
  309. {
  310. std::lock_guard<std::mutex> lk(mutex);
  311. for (const auto & m : mapping) {
  312. if (m.second.meta.is_active()) {
  313. count_active++;
  314. if (m.second.meta.last_used < lru_last_used) {
  315. lru_model_name = m.first;
  316. lru_last_used = m.second.meta.last_used;
  317. }
  318. }
  319. }
  320. }
  321. if (!lru_model_name.empty() && count_active >= (size_t)base_params.models_max) {
  322. SRV_INF("models_max limit reached, removing LRU name=%s\n", lru_model_name.c_str());
  323. unload(lru_model_name);
  324. }
  325. }
  326. void server_models::load(const std::string & name) {
  327. if (!has_model(name)) {
  328. throw std::runtime_error("model name=" + name + " is not found");
  329. }
  330. unload_lru();
  331. std::lock_guard<std::mutex> lk(mutex);
  332. auto meta = mapping[name].meta;
  333. if (meta.status != SERVER_MODEL_STATUS_UNLOADED) {
  334. SRV_INF("model %s is not ready\n", name.c_str());
  335. return;
  336. }
  337. // prepare new instance info
  338. instance_t inst;
  339. inst.meta = meta;
  340. inst.meta.port = get_free_port();
  341. inst.meta.status = SERVER_MODEL_STATUS_LOADING;
  342. inst.meta.last_used = ggml_time_ms();
  343. if (inst.meta.port <= 0) {
  344. throw std::runtime_error("failed to get a port number");
  345. }
  346. inst.subproc = std::make_shared<subprocess_s>();
  347. {
  348. SRV_INF("spawning server instance with name=%s on port %d\n", inst.meta.name.c_str(), inst.meta.port);
  349. inst.meta.update_args(ctx_preset, bin_path); // render args
  350. std::vector<std::string> child_args = inst.meta.args; // copy
  351. std::vector<std::string> child_env = base_env; // copy
  352. child_env.push_back("LLAMA_SERVER_ROUTER_PORT=" + std::to_string(base_params.port));
  353. SRV_INF("%s", "spawning server instance with args:\n");
  354. for (const auto & arg : child_args) {
  355. SRV_INF(" %s\n", arg.c_str());
  356. }
  357. inst.meta.args = child_args; // save for debugging
  358. std::vector<char *> argv = to_char_ptr_array(child_args);
  359. std::vector<char *> envp = to_char_ptr_array(child_env);
  360. // TODO @ngxson : maybe separate stdout and stderr in the future
  361. // so that we can use stdout for commands and stderr for logging
  362. int options = subprocess_option_no_window | subprocess_option_combined_stdout_stderr;
  363. int result = subprocess_create_ex(argv.data(), options, envp.data(), inst.subproc.get());
  364. if (result != 0) {
  365. throw std::runtime_error("failed to spawn server instance");
  366. }
  367. inst.stdin_file = subprocess_stdin(inst.subproc.get());
  368. }
  369. // start a thread to manage the child process
  370. // captured variables are guaranteed to be destroyed only after the thread is joined
  371. inst.th = std::thread([this, name, child_proc = inst.subproc, port = inst.meta.port]() {
  372. // read stdout/stderr and forward to main server log
  373. bool state_received = false; // true if child state received
  374. FILE * p_stdout_stderr = subprocess_stdout(child_proc.get());
  375. if (p_stdout_stderr) {
  376. char buffer[4096];
  377. while (fgets(buffer, sizeof(buffer), p_stdout_stderr) != nullptr) {
  378. LOG("[%5d] %s", port, buffer);
  379. if (!state_received && std::strstr(buffer, CMD_CHILD_TO_ROUTER_READY) != nullptr) {
  380. // child process is ready
  381. this->update_status(name, SERVER_MODEL_STATUS_LOADED);
  382. state_received = true;
  383. }
  384. }
  385. } else {
  386. SRV_ERR("failed to get stdout/stderr of child process for name=%s\n", name.c_str());
  387. }
  388. // we reach here when the child process exits
  389. int exit_code = 0;
  390. subprocess_join(child_proc.get(), &exit_code);
  391. subprocess_destroy(child_proc.get());
  392. // update PID and status
  393. {
  394. std::lock_guard<std::mutex> lk(mutex);
  395. auto it = mapping.find(name);
  396. if (it != mapping.end()) {
  397. auto & meta = it->second.meta;
  398. meta.exit_code = exit_code;
  399. meta.status = SERVER_MODEL_STATUS_UNLOADED;
  400. }
  401. cv.notify_all();
  402. }
  403. SRV_INF("instance name=%s exited with status %d\n", name.c_str(), exit_code);
  404. });
  405. // clean up old process/thread if exists
  406. {
  407. auto & old_instance = mapping[name];
  408. // old process should have exited already, but just in case, we clean it up here
  409. if (subprocess_alive(old_instance.subproc.get())) {
  410. SRV_WRN("old process for model name=%s is still alive, this is unexpected\n", name.c_str());
  411. subprocess_terminate(old_instance.subproc.get()); // force kill
  412. }
  413. if (old_instance.th.joinable()) {
  414. old_instance.th.join();
  415. }
  416. }
  417. mapping[name] = std::move(inst);
  418. cv.notify_all();
  419. }
  420. static void interrupt_subprocess(FILE * stdin_file) {
  421. // because subprocess.h does not provide a way to send SIGINT,
  422. // we will send a command to the child process to exit gracefully
  423. if (stdin_file) {
  424. fprintf(stdin_file, "%s\n", CMD_ROUTER_TO_CHILD_EXIT);
  425. fflush(stdin_file);
  426. }
  427. }
  428. void server_models::unload(const std::string & name) {
  429. std::lock_guard<std::mutex> lk(mutex);
  430. auto it = mapping.find(name);
  431. if (it != mapping.end()) {
  432. if (it->second.meta.is_active()) {
  433. SRV_INF("unloading model instance name=%s\n", name.c_str());
  434. interrupt_subprocess(it->second.stdin_file);
  435. // status change will be handled by the managing thread
  436. } else {
  437. SRV_WRN("model instance name=%s is not loaded\n", name.c_str());
  438. }
  439. }
  440. }
  441. void server_models::unload_all() {
  442. std::vector<std::thread> to_join;
  443. {
  444. std::lock_guard<std::mutex> lk(mutex);
  445. for (auto & [name, inst] : mapping) {
  446. if (inst.meta.is_active()) {
  447. SRV_INF("unloading model instance name=%s\n", name.c_str());
  448. interrupt_subprocess(inst.stdin_file);
  449. // status change will be handled by the managing thread
  450. }
  451. // moving the thread to join list to avoid deadlock
  452. to_join.push_back(std::move(inst.th));
  453. }
  454. }
  455. for (auto & th : to_join) {
  456. if (th.joinable()) {
  457. th.join();
  458. }
  459. }
  460. }
  461. void server_models::update_status(const std::string & name, server_model_status status) {
  462. // for now, we only allow updating to LOADED status
  463. if (status != SERVER_MODEL_STATUS_LOADED) {
  464. throw std::runtime_error("invalid status value");
  465. }
  466. auto meta = get_meta(name);
  467. if (meta.has_value()) {
  468. meta->status = status;
  469. update_meta(name, meta.value());
  470. }
  471. }
  472. void server_models::wait_until_loaded(const std::string & name) {
  473. std::unique_lock<std::mutex> lk(mutex);
  474. cv.wait(lk, [this, &name]() {
  475. auto it = mapping.find(name);
  476. if (it != mapping.end()) {
  477. return it->second.meta.status != SERVER_MODEL_STATUS_LOADING;
  478. }
  479. return false;
  480. });
  481. }
  482. bool server_models::ensure_model_loaded(const std::string & name) {
  483. auto meta = get_meta(name);
  484. if (!meta.has_value()) {
  485. throw std::runtime_error("model name=" + name + " is not found");
  486. }
  487. if (meta->status == SERVER_MODEL_STATUS_LOADED) {
  488. return false; // already loaded
  489. }
  490. if (meta->status == SERVER_MODEL_STATUS_UNLOADED) {
  491. SRV_INF("model name=%s is not loaded, loading...\n", name.c_str());
  492. load(name);
  493. }
  494. SRV_INF("waiting until model name=%s is fully loaded...\n", name.c_str());
  495. wait_until_loaded(name);
  496. // check final status
  497. meta = get_meta(name);
  498. if (!meta.has_value() || meta->is_failed()) {
  499. throw std::runtime_error("model name=" + name + " failed to load");
  500. }
  501. return true;
  502. }
  503. server_http_res_ptr server_models::proxy_request(const server_http_req & req, const std::string & method, const std::string & name, bool update_last_used) {
  504. auto meta = get_meta(name);
  505. if (!meta.has_value()) {
  506. throw std::runtime_error("model name=" + name + " is not found");
  507. }
  508. if (meta->status != SERVER_MODEL_STATUS_LOADED) {
  509. throw std::invalid_argument("model name=" + name + " is not loaded");
  510. }
  511. if (update_last_used) {
  512. std::unique_lock<std::mutex> lk(mutex);
  513. mapping[name].meta.last_used = ggml_time_ms();
  514. }
  515. SRV_INF("proxying request to model %s on port %d\n", name.c_str(), meta->port);
  516. auto proxy = std::make_unique<server_http_proxy>(
  517. method,
  518. CHILD_ADDR,
  519. meta->port,
  520. req.path,
  521. req.headers,
  522. req.body,
  523. req.should_stop);
  524. return proxy;
  525. }
  526. std::thread server_models::setup_child_server(const std::function<void(int)> & shutdown_handler) {
  527. // send a notification to the router server that a model instance is ready
  528. common_log_pause(common_log_main());
  529. fflush(stdout);
  530. fprintf(stdout, "%s\n", CMD_CHILD_TO_ROUTER_READY);
  531. fflush(stdout);
  532. common_log_resume(common_log_main());
  533. // setup thread for monitoring stdin
  534. return std::thread([shutdown_handler]() {
  535. // wait for EOF on stdin
  536. SRV_INF("%s", "child server monitoring thread started, waiting for EOF on stdin...\n");
  537. bool eof = false;
  538. while (true) {
  539. std::string line;
  540. if (!std::getline(std::cin, line)) {
  541. // EOF detected, that means the router server is unexpectedly exit or killed
  542. eof = true;
  543. break;
  544. }
  545. if (line.find(CMD_ROUTER_TO_CHILD_EXIT) != std::string::npos) {
  546. SRV_INF("%s", "exit command received, exiting...\n");
  547. shutdown_handler(0);
  548. break;
  549. }
  550. }
  551. if (eof) {
  552. SRV_INF("%s", "EOF on stdin detected, forcing shutdown...\n");
  553. exit(1);
  554. }
  555. });
  556. }
  557. //
  558. // server_models_routes
  559. //
  560. static void res_ok(std::unique_ptr<server_http_res> & res, const json & response_data) {
  561. res->status = 200;
  562. res->data = safe_json_to_str(response_data);
  563. }
  564. static void res_err(std::unique_ptr<server_http_res> & res, const json & error_data) {
  565. res->status = json_value(error_data, "code", 500);
  566. res->data = safe_json_to_str({{ "error", error_data }});
  567. }
  568. static bool router_validate_model(const std::string & name, server_models & models, bool models_autoload, std::unique_ptr<server_http_res> & res) {
  569. if (name.empty()) {
  570. res_err(res, format_error_response("model name is missing from the request", ERROR_TYPE_INVALID_REQUEST));
  571. return false;
  572. }
  573. auto meta = models.get_meta(name);
  574. if (!meta.has_value()) {
  575. res_err(res, format_error_response("model not found", ERROR_TYPE_INVALID_REQUEST));
  576. return false;
  577. }
  578. if (models_autoload) {
  579. models.ensure_model_loaded(name);
  580. } else {
  581. if (meta->status != SERVER_MODEL_STATUS_LOADED) {
  582. res_err(res, format_error_response("model is not loaded", ERROR_TYPE_INVALID_REQUEST));
  583. return false;
  584. }
  585. }
  586. return true;
  587. }
  588. static bool is_autoload(const common_params & params, const server_http_req & req) {
  589. std::string autoload = req.get_param("autoload");
  590. if (autoload.empty()) {
  591. return params.models_autoload;
  592. } else {
  593. return autoload == "true" || autoload == "1";
  594. }
  595. }
  596. void server_models_routes::init_routes() {
  597. this->get_router_props = [this](const server_http_req & req) {
  598. std::string name = req.get_param("model");
  599. if (name.empty()) {
  600. // main instance
  601. auto res = std::make_unique<server_http_res>();
  602. res_ok(res, {
  603. // TODO: add support for this on web UI
  604. {"role", "router"},
  605. {"max_instances", 4}, // dummy value for testing
  606. // this is a dummy response to make sure webui doesn't break
  607. {"model_alias", "llama-server"},
  608. {"model_path", "none"},
  609. {"default_generation_settings", {
  610. {"params", json{}},
  611. {"n_ctx", 0},
  612. }},
  613. {"webui_settings", webui_settings},
  614. });
  615. return res;
  616. }
  617. return proxy_get(req);
  618. };
  619. this->proxy_get = [this](const server_http_req & req) {
  620. std::string method = "GET";
  621. std::string name = req.get_param("model");
  622. bool autoload = is_autoload(params, req);
  623. auto error_res = std::make_unique<server_http_res>();
  624. if (!router_validate_model(name, models, autoload, error_res)) {
  625. return error_res;
  626. }
  627. return models.proxy_request(req, method, name, false);
  628. };
  629. this->proxy_post = [this](const server_http_req & req) {
  630. std::string method = "POST";
  631. json body = json::parse(req.body);
  632. std::string name = json_value(body, "model", std::string());
  633. bool autoload = is_autoload(params, req);
  634. auto error_res = std::make_unique<server_http_res>();
  635. if (!router_validate_model(name, models, autoload, error_res)) {
  636. return error_res;
  637. }
  638. return models.proxy_request(req, method, name, true); // update last usage for POST request only
  639. };
  640. this->post_router_models_load = [this](const server_http_req & req) {
  641. auto res = std::make_unique<server_http_res>();
  642. json body = json::parse(req.body);
  643. std::string name = json_value(body, "model", std::string());
  644. auto model = models.get_meta(name);
  645. if (!model.has_value()) {
  646. res_err(res, format_error_response("model is not found", ERROR_TYPE_NOT_FOUND));
  647. return res;
  648. }
  649. if (model->status == SERVER_MODEL_STATUS_LOADED) {
  650. res_err(res, format_error_response("model is already loaded", ERROR_TYPE_INVALID_REQUEST));
  651. return res;
  652. }
  653. models.load(name);
  654. res_ok(res, {{"success", true}});
  655. return res;
  656. };
  657. this->get_router_models = [this](const server_http_req &) {
  658. auto res = std::make_unique<server_http_res>();
  659. json models_json = json::array();
  660. auto all_models = models.get_all_meta();
  661. std::time_t t = std::time(0);
  662. for (const auto & meta : all_models) {
  663. json status {
  664. {"value", server_model_status_to_string(meta.status)},
  665. {"args", meta.args},
  666. };
  667. if (!meta.preset.name.empty()) {
  668. common_preset preset_copy = meta.preset;
  669. unset_reserved_args(preset_copy, false);
  670. preset_copy.unset_option("LLAMA_ARG_HOST");
  671. preset_copy.unset_option("LLAMA_ARG_PORT");
  672. preset_copy.unset_option("LLAMA_ARG_ALIAS");
  673. status["preset"] = preset_copy.to_ini();
  674. }
  675. if (meta.is_failed()) {
  676. status["exit_code"] = meta.exit_code;
  677. status["failed"] = true;
  678. }
  679. models_json.push_back(json {
  680. {"id", meta.name},
  681. {"object", "model"}, // for OAI-compat
  682. {"owned_by", "llamacpp"}, // for OAI-compat
  683. {"created", t}, // for OAI-compat
  684. {"status", status},
  685. // TODO: add other fields, may require reading GGUF metadata
  686. });
  687. }
  688. res_ok(res, {
  689. {"data", models_json},
  690. {"object", "list"},
  691. });
  692. return res;
  693. };
  694. this->post_router_models_unload = [this](const server_http_req & req) {
  695. auto res = std::make_unique<server_http_res>();
  696. json body = json::parse(req.body);
  697. std::string name = json_value(body, "model", std::string());
  698. auto model = models.get_meta(name);
  699. if (!model.has_value()) {
  700. res_err(res, format_error_response("model is not found", ERROR_TYPE_INVALID_REQUEST));
  701. return res;
  702. }
  703. if (model->status != SERVER_MODEL_STATUS_LOADED) {
  704. res_err(res, format_error_response("model is not loaded", ERROR_TYPE_INVALID_REQUEST));
  705. return res;
  706. }
  707. models.unload(name);
  708. res_ok(res, {{"success", true}});
  709. return res;
  710. };
  711. }
  712. //
  713. // server_http_proxy
  714. //
  715. // simple implementation of a pipe
  716. // used for streaming data between threads
  717. template<typename T>
  718. struct pipe_t {
  719. std::mutex mutex;
  720. std::condition_variable cv;
  721. std::queue<T> queue;
  722. std::atomic<bool> writer_closed{false};
  723. std::atomic<bool> reader_closed{false};
  724. void close_write() {
  725. writer_closed.store(true, std::memory_order_relaxed);
  726. cv.notify_all();
  727. }
  728. void close_read() {
  729. reader_closed.store(true, std::memory_order_relaxed);
  730. cv.notify_all();
  731. }
  732. bool read(T & output, const std::function<bool()> & should_stop) {
  733. std::unique_lock<std::mutex> lk(mutex);
  734. constexpr auto poll_interval = std::chrono::milliseconds(500);
  735. while (true) {
  736. if (!queue.empty()) {
  737. output = std::move(queue.front());
  738. queue.pop();
  739. return true;
  740. }
  741. if (writer_closed.load()) {
  742. return false; // clean EOF
  743. }
  744. if (should_stop()) {
  745. close_read(); // signal broken pipe to writer
  746. return false; // cancelled / reader no longer alive
  747. }
  748. cv.wait_for(lk, poll_interval);
  749. }
  750. }
  751. bool write(T && data) {
  752. std::lock_guard<std::mutex> lk(mutex);
  753. if (reader_closed.load()) {
  754. return false; // broken pipe
  755. }
  756. queue.push(std::move(data));
  757. cv.notify_one();
  758. return true;
  759. }
  760. };
  761. static std::string to_lower_copy(const std::string & value) {
  762. std::string lowered(value.size(), '\0');
  763. std::transform(value.begin(), value.end(), lowered.begin(), [](unsigned char c) { return std::tolower(c); });
  764. return lowered;
  765. }
  766. static bool should_strip_proxy_header(const std::string & header_name) {
  767. // Headers that get duplicated when router forwards child responses
  768. if (header_name == "server" ||
  769. header_name == "transfer-encoding" ||
  770. header_name == "content-length" || // quick fix for https://github.com/ggml-org/llama.cpp/issues/17710
  771. header_name == "keep-alive") {
  772. return true;
  773. }
  774. // Router injects CORS, child also sends them: duplicate
  775. if (header_name.rfind("access-control-", 0) == 0) {
  776. return true;
  777. }
  778. return false;
  779. }
  780. server_http_proxy::server_http_proxy(
  781. const std::string & method,
  782. const std::string & host,
  783. int port,
  784. const std::string & path,
  785. const std::map<std::string, std::string> & headers,
  786. const std::string & body,
  787. const std::function<bool()> should_stop) {
  788. // shared between reader and writer threads
  789. auto cli = std::make_shared<httplib::Client>(host, port);
  790. auto pipe = std::make_shared<pipe_t<msg_t>>();
  791. // setup Client
  792. cli->set_connection_timeout(0, 200000); // 200 milliseconds
  793. this->status = 500; // to be overwritten upon response
  794. this->cleanup = [pipe]() {
  795. pipe->close_read();
  796. pipe->close_write();
  797. };
  798. // wire up the receive end of the pipe
  799. this->next = [pipe, should_stop](std::string & out) -> bool {
  800. msg_t msg;
  801. bool has_next = pipe->read(msg, should_stop);
  802. if (!msg.data.empty()) {
  803. out = std::move(msg.data);
  804. }
  805. return has_next; // false if EOF or pipe broken
  806. };
  807. // wire up the HTTP client
  808. // note: do NOT capture `this` pointer, as it may be destroyed before the thread ends
  809. httplib::ResponseHandler response_handler = [pipe, cli](const httplib::Response & response) {
  810. msg_t msg;
  811. msg.status = response.status;
  812. for (const auto & [key, value] : response.headers) {
  813. const auto lowered = to_lower_copy(key);
  814. if (should_strip_proxy_header(lowered)) {
  815. continue;
  816. }
  817. if (lowered == "content-type") {
  818. msg.content_type = value;
  819. continue;
  820. }
  821. msg.headers[key] = value;
  822. }
  823. return pipe->write(std::move(msg)); // send headers first
  824. };
  825. httplib::ContentReceiverWithProgress content_receiver = [pipe](const char * data, size_t data_length, size_t, size_t) {
  826. // send data chunks
  827. // returns false if pipe is closed / broken (signal to stop receiving)
  828. return pipe->write({{}, 0, std::string(data, data_length), ""});
  829. };
  830. // prepare the request to destination server
  831. httplib::Request req;
  832. {
  833. req.method = method;
  834. req.path = path;
  835. for (const auto & [key, value] : headers) {
  836. req.set_header(key, value);
  837. }
  838. req.body = body;
  839. req.response_handler = response_handler;
  840. req.content_receiver = content_receiver;
  841. }
  842. // start the proxy thread
  843. SRV_DBG("start proxy thread %s %s\n", req.method.c_str(), req.path.c_str());
  844. this->thread = std::thread([cli, pipe, req]() {
  845. auto result = cli->send(std::move(req));
  846. if (result.error() != httplib::Error::Success) {
  847. auto err_str = httplib::to_string(result.error());
  848. SRV_ERR("http client error: %s\n", err_str.c_str());
  849. pipe->write({{}, 500, "", ""}); // header
  850. pipe->write({{}, 0, "proxy error: " + err_str, ""}); // body
  851. }
  852. pipe->close_write(); // signal EOF to reader
  853. SRV_DBG("%s", "client request thread ended\n");
  854. });
  855. this->thread.detach();
  856. // wait for the first chunk (headers)
  857. {
  858. msg_t header;
  859. if (pipe->read(header, should_stop)) {
  860. SRV_DBG("%s", "received response headers\n");
  861. this->status = header.status;
  862. this->headers = std::move(header.headers);
  863. if (!header.content_type.empty()) {
  864. this->content_type = std::move(header.content_type);
  865. }
  866. } else {
  867. SRV_DBG("%s", "no response headers received (request cancelled?)\n");
  868. }
  869. }
  870. }