| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960 |
- #include "server-common.h"
- #include "server-models.h"
- #include "preset.h"
- #include "download.h"
- #include <cpp-httplib/httplib.h> // TODO: remove this once we use HTTP client from download.h
- #include <sheredom/subprocess.h>
- #include <functional>
- #include <algorithm>
- #include <thread>
- #include <mutex>
- #include <condition_variable>
- #include <cstring>
- #include <atomic>
- #include <chrono>
- #include <queue>
- #include <filesystem>
- #include <cstring>
- #ifdef _WIN32
- #include <winsock2.h>
- #else
- #include <sys/socket.h>
- #include <netinet/in.h>
- #include <arpa/inet.h>
- #include <unistd.h>
- #endif
- #if defined(__APPLE__) && defined(__MACH__)
- // macOS: use _NSGetExecutablePath to get the executable path
- #include <mach-o/dyld.h>
- #include <limits.h>
- #endif
- #define CMD_ROUTER_TO_CHILD_EXIT "cmd_router_to_child:exit"
- #define CMD_CHILD_TO_ROUTER_READY "cmd_child_to_router:ready"
- // address for child process, this is needed because router may run on 0.0.0.0
- // ref: https://github.com/ggml-org/llama.cpp/issues/17862
- #define CHILD_ADDR "127.0.0.1"
- static std::filesystem::path get_server_exec_path() {
- #if defined(_WIN32)
- wchar_t buf[32768] = { 0 }; // Large buffer to handle long paths
- DWORD len = GetModuleFileNameW(nullptr, buf, _countof(buf));
- if (len == 0 || len >= _countof(buf)) {
- throw std::runtime_error("GetModuleFileNameW failed or path too long");
- }
- return std::filesystem::path(buf);
- #elif defined(__APPLE__) && defined(__MACH__)
- char small_path[PATH_MAX];
- uint32_t size = sizeof(small_path);
- if (_NSGetExecutablePath(small_path, &size) == 0) {
- // resolve any symlinks to get absolute path
- try {
- return std::filesystem::canonical(std::filesystem::path(small_path));
- } catch (...) {
- return std::filesystem::path(small_path);
- }
- } else {
- // buffer was too small, allocate required size and call again
- std::vector<char> buf(size);
- if (_NSGetExecutablePath(buf.data(), &size) == 0) {
- try {
- return std::filesystem::canonical(std::filesystem::path(buf.data()));
- } catch (...) {
- return std::filesystem::path(buf.data());
- }
- }
- throw std::runtime_error("_NSGetExecutablePath failed after buffer resize");
- }
- #else
- char path[FILENAME_MAX];
- ssize_t count = readlink("/proc/self/exe", path, FILENAME_MAX);
- if (count <= 0) {
- throw std::runtime_error("failed to resolve /proc/self/exe");
- }
- return std::filesystem::path(std::string(path, count));
- #endif
- }
- static void unset_reserved_args(common_preset & preset, bool unset_model_args) {
- preset.unset_option("LLAMA_ARG_SSL_KEY_FILE");
- preset.unset_option("LLAMA_ARG_SSL_CERT_FILE");
- preset.unset_option("LLAMA_API_KEY");
- preset.unset_option("LLAMA_ARG_MODELS_DIR");
- preset.unset_option("LLAMA_ARG_MODELS_MAX");
- preset.unset_option("LLAMA_ARG_MODELS_PRESET");
- preset.unset_option("LLAMA_ARG_MODELS_AUTOLOAD");
- if (unset_model_args) {
- preset.unset_option("LLAMA_ARG_MODEL");
- preset.unset_option("LLAMA_ARG_MMPROJ");
- preset.unset_option("LLAMA_ARG_HF_REPO");
- }
- }
- void server_model_meta::update_args(common_preset_context & ctx_preset, std::string bin_path) {
- // update params
- unset_reserved_args(preset, false);
- preset.set_option(ctx_preset, "LLAMA_ARG_HOST", CHILD_ADDR);
- preset.set_option(ctx_preset, "LLAMA_ARG_PORT", std::to_string(port));
- preset.set_option(ctx_preset, "LLAMA_ARG_ALIAS", name);
- // TODO: maybe validate preset before rendering ?
- // render args
- args = preset.to_args(bin_path);
- }
- //
- // server_models
- //
- server_models::server_models(
- const common_params & params,
- int argc,
- char ** argv,
- char ** envp)
- : ctx_preset(LLAMA_EXAMPLE_SERVER),
- base_params(params),
- base_preset(ctx_preset.load_from_args(argc, argv)) {
- for (char ** env = envp; *env != nullptr; env++) {
- base_env.push_back(std::string(*env));
- }
- // clean up base preset
- unset_reserved_args(base_preset, true);
- // set binary path
- try {
- bin_path = get_server_exec_path().string();
- } catch (const std::exception & e) {
- bin_path = argv[0];
- LOG_WRN("failed to get server executable path: %s\n", e.what());
- LOG_WRN("using original argv[0] as fallback: %s\n", argv[0]);
- }
- load_models();
- }
- void server_models::add_model(server_model_meta && meta) {
- if (mapping.find(meta.name) != mapping.end()) {
- throw std::runtime_error(string_format("model '%s' appears multiple times", meta.name.c_str()));
- }
- meta.update_args(ctx_preset, bin_path); // render args
- std::string name = meta.name;
- mapping[name] = instance_t{
- /* subproc */ std::make_shared<subprocess_s>(),
- /* th */ std::thread(),
- /* meta */ std::move(meta)
- };
- }
- // TODO: allow refreshing cached model list
- void server_models::load_models() {
- // loading models from 3 sources:
- // 1. cached models
- common_presets cached_models = ctx_preset.load_from_cache();
- SRV_INF("Loaded %zu cached model presets\n", cached_models.size());
- // 2. local models from --models-dir
- common_presets local_models;
- if (!base_params.models_dir.empty()) {
- local_models = ctx_preset.load_from_models_dir(base_params.models_dir);
- SRV_INF("Loaded %zu local model presets from %s\n", local_models.size(), base_params.models_dir.c_str());
- }
- // 3. custom-path models from presets
- common_preset global = {};
- common_presets custom_presets = {};
- if (!base_params.models_preset.empty()) {
- custom_presets = ctx_preset.load_from_ini(base_params.models_preset, global);
- SRV_INF("Loaded %zu custom model presets from %s\n", custom_presets.size(), base_params.models_preset.c_str());
- }
- // cascade, apply global preset first
- cached_models = ctx_preset.cascade(global, cached_models);
- local_models = ctx_preset.cascade(global, local_models);
- custom_presets = ctx_preset.cascade(global, custom_presets);
- // note: if a model exists in both cached and local, local takes precedence
- common_presets final_presets;
- for (const auto & [name, preset] : cached_models) {
- final_presets[name] = preset;
- }
- for (const auto & [name, preset] : local_models) {
- final_presets[name] = preset;
- }
- // process custom presets from INI
- for (const auto & [name, custom] : custom_presets) {
- if (final_presets.find(name) != final_presets.end()) {
- // apply custom config if exists
- common_preset & target = final_presets[name];
- target.merge(custom);
- } else {
- // otherwise add directly
- final_presets[name] = custom;
- }
- }
- // server base preset from CLI args take highest precedence
- for (auto & [name, preset] : final_presets) {
- preset.merge(base_preset);
- }
- // convert presets to server_model_meta and add to mapping
- for (const auto & preset : final_presets) {
- server_model_meta meta{
- /* preset */ preset.second,
- /* name */ preset.first,
- /* port */ 0,
- /* status */ SERVER_MODEL_STATUS_UNLOADED,
- /* last_used */ 0,
- /* args */ std::vector<std::string>(),
- /* exit_code */ 0
- };
- add_model(std::move(meta));
- }
- // log available models
- {
- std::unordered_set<std::string> custom_names;
- for (const auto & [name, preset] : custom_presets) {
- custom_names.insert(name);
- }
- SRV_INF("Available models (%zu) (*: custom preset)\n", mapping.size());
- for (const auto & [name, inst] : mapping) {
- bool has_custom = custom_names.find(name) != custom_names.end();
- SRV_INF(" %c %s\n", has_custom ? '*' : ' ', name.c_str());
- }
- }
- }
- void server_models::update_meta(const std::string & name, const server_model_meta & meta) {
- std::lock_guard<std::mutex> lk(mutex);
- auto it = mapping.find(name);
- if (it != mapping.end()) {
- it->second.meta = meta;
- }
- cv.notify_all(); // notify wait_until_loaded
- }
- bool server_models::has_model(const std::string & name) {
- std::lock_guard<std::mutex> lk(mutex);
- return mapping.find(name) != mapping.end();
- }
- std::optional<server_model_meta> server_models::get_meta(const std::string & name) {
- std::lock_guard<std::mutex> lk(mutex);
- auto it = mapping.find(name);
- if (it != mapping.end()) {
- return it->second.meta;
- }
- return std::nullopt;
- }
- static int get_free_port() {
- #ifdef _WIN32
- WSADATA wsaData;
- if (WSAStartup(MAKEWORD(2, 2), &wsaData) != 0) {
- return -1;
- }
- typedef SOCKET native_socket_t;
- #define INVALID_SOCKET_VAL INVALID_SOCKET
- #define CLOSE_SOCKET(s) closesocket(s)
- #else
- typedef int native_socket_t;
- #define INVALID_SOCKET_VAL -1
- #define CLOSE_SOCKET(s) close(s)
- #endif
- native_socket_t sock = socket(AF_INET, SOCK_STREAM, 0);
- if (sock == INVALID_SOCKET_VAL) {
- #ifdef _WIN32
- WSACleanup();
- #endif
- return -1;
- }
- struct sockaddr_in serv_addr;
- std::memset(&serv_addr, 0, sizeof(serv_addr));
- serv_addr.sin_family = AF_INET;
- serv_addr.sin_addr.s_addr = htonl(INADDR_ANY);
- serv_addr.sin_port = htons(0);
- if (bind(sock, (struct sockaddr*)&serv_addr, sizeof(serv_addr)) != 0) {
- CLOSE_SOCKET(sock);
- #ifdef _WIN32
- WSACleanup();
- #endif
- return -1;
- }
- #ifdef _WIN32
- int namelen = sizeof(serv_addr);
- #else
- socklen_t namelen = sizeof(serv_addr);
- #endif
- if (getsockname(sock, (struct sockaddr*)&serv_addr, &namelen) != 0) {
- CLOSE_SOCKET(sock);
- #ifdef _WIN32
- WSACleanup();
- #endif
- return -1;
- }
- int port = ntohs(serv_addr.sin_port);
- CLOSE_SOCKET(sock);
- #ifdef _WIN32
- WSACleanup();
- #endif
- return port;
- }
- // helper to convert vector<string> to char **
- // pointers are only valid as long as the original vector is valid
- static std::vector<char *> to_char_ptr_array(const std::vector<std::string> & vec) {
- std::vector<char *> result;
- result.reserve(vec.size() + 1);
- for (const auto & s : vec) {
- result.push_back(const_cast<char*>(s.c_str()));
- }
- result.push_back(nullptr);
- return result;
- }
- std::vector<server_model_meta> server_models::get_all_meta() {
- std::lock_guard<std::mutex> lk(mutex);
- std::vector<server_model_meta> result;
- result.reserve(mapping.size());
- for (const auto & [name, inst] : mapping) {
- result.push_back(inst.meta);
- }
- return result;
- }
- void server_models::unload_lru() {
- if (base_params.models_max <= 0) {
- return; // no limit
- }
- // remove one of the servers if we passed the models_max (least recently used - LRU)
- std::string lru_model_name = "";
- int64_t lru_last_used = ggml_time_ms();
- size_t count_active = 0;
- {
- std::lock_guard<std::mutex> lk(mutex);
- for (const auto & m : mapping) {
- if (m.second.meta.is_active()) {
- count_active++;
- if (m.second.meta.last_used < lru_last_used) {
- lru_model_name = m.first;
- lru_last_used = m.second.meta.last_used;
- }
- }
- }
- }
- if (!lru_model_name.empty() && count_active >= (size_t)base_params.models_max) {
- SRV_INF("models_max limit reached, removing LRU name=%s\n", lru_model_name.c_str());
- unload(lru_model_name);
- }
- }
- void server_models::load(const std::string & name) {
- if (!has_model(name)) {
- throw std::runtime_error("model name=" + name + " is not found");
- }
- unload_lru();
- std::lock_guard<std::mutex> lk(mutex);
- auto meta = mapping[name].meta;
- if (meta.status != SERVER_MODEL_STATUS_UNLOADED) {
- SRV_INF("model %s is not ready\n", name.c_str());
- return;
- }
- // prepare new instance info
- instance_t inst;
- inst.meta = meta;
- inst.meta.port = get_free_port();
- inst.meta.status = SERVER_MODEL_STATUS_LOADING;
- inst.meta.last_used = ggml_time_ms();
- if (inst.meta.port <= 0) {
- throw std::runtime_error("failed to get a port number");
- }
- inst.subproc = std::make_shared<subprocess_s>();
- {
- SRV_INF("spawning server instance with name=%s on port %d\n", inst.meta.name.c_str(), inst.meta.port);
- inst.meta.update_args(ctx_preset, bin_path); // render args
- std::vector<std::string> child_args = inst.meta.args; // copy
- std::vector<std::string> child_env = base_env; // copy
- child_env.push_back("LLAMA_SERVER_ROUTER_PORT=" + std::to_string(base_params.port));
- SRV_INF("%s", "spawning server instance with args:\n");
- for (const auto & arg : child_args) {
- SRV_INF(" %s\n", arg.c_str());
- }
- inst.meta.args = child_args; // save for debugging
- std::vector<char *> argv = to_char_ptr_array(child_args);
- std::vector<char *> envp = to_char_ptr_array(child_env);
- // TODO @ngxson : maybe separate stdout and stderr in the future
- // so that we can use stdout for commands and stderr for logging
- int options = subprocess_option_no_window | subprocess_option_combined_stdout_stderr;
- int result = subprocess_create_ex(argv.data(), options, envp.data(), inst.subproc.get());
- if (result != 0) {
- throw std::runtime_error("failed to spawn server instance");
- }
- inst.stdin_file = subprocess_stdin(inst.subproc.get());
- }
- // start a thread to manage the child process
- // captured variables are guaranteed to be destroyed only after the thread is joined
- inst.th = std::thread([this, name, child_proc = inst.subproc, port = inst.meta.port]() {
- // read stdout/stderr and forward to main server log
- bool state_received = false; // true if child state received
- FILE * p_stdout_stderr = subprocess_stdout(child_proc.get());
- if (p_stdout_stderr) {
- char buffer[4096];
- while (fgets(buffer, sizeof(buffer), p_stdout_stderr) != nullptr) {
- LOG("[%5d] %s", port, buffer);
- if (!state_received && std::strstr(buffer, CMD_CHILD_TO_ROUTER_READY) != nullptr) {
- // child process is ready
- this->update_status(name, SERVER_MODEL_STATUS_LOADED);
- state_received = true;
- }
- }
- } else {
- SRV_ERR("failed to get stdout/stderr of child process for name=%s\n", name.c_str());
- }
- // we reach here when the child process exits
- int exit_code = 0;
- subprocess_join(child_proc.get(), &exit_code);
- subprocess_destroy(child_proc.get());
- // update PID and status
- {
- std::lock_guard<std::mutex> lk(mutex);
- auto it = mapping.find(name);
- if (it != mapping.end()) {
- auto & meta = it->second.meta;
- meta.exit_code = exit_code;
- meta.status = SERVER_MODEL_STATUS_UNLOADED;
- }
- cv.notify_all();
- }
- SRV_INF("instance name=%s exited with status %d\n", name.c_str(), exit_code);
- });
- // clean up old process/thread if exists
- {
- auto & old_instance = mapping[name];
- // old process should have exited already, but just in case, we clean it up here
- if (subprocess_alive(old_instance.subproc.get())) {
- SRV_WRN("old process for model name=%s is still alive, this is unexpected\n", name.c_str());
- subprocess_terminate(old_instance.subproc.get()); // force kill
- }
- if (old_instance.th.joinable()) {
- old_instance.th.join();
- }
- }
- mapping[name] = std::move(inst);
- cv.notify_all();
- }
- static void interrupt_subprocess(FILE * stdin_file) {
- // because subprocess.h does not provide a way to send SIGINT,
- // we will send a command to the child process to exit gracefully
- if (stdin_file) {
- fprintf(stdin_file, "%s\n", CMD_ROUTER_TO_CHILD_EXIT);
- fflush(stdin_file);
- }
- }
- void server_models::unload(const std::string & name) {
- std::lock_guard<std::mutex> lk(mutex);
- auto it = mapping.find(name);
- if (it != mapping.end()) {
- if (it->second.meta.is_active()) {
- SRV_INF("unloading model instance name=%s\n", name.c_str());
- interrupt_subprocess(it->second.stdin_file);
- // status change will be handled by the managing thread
- } else {
- SRV_WRN("model instance name=%s is not loaded\n", name.c_str());
- }
- }
- }
- void server_models::unload_all() {
- std::vector<std::thread> to_join;
- {
- std::lock_guard<std::mutex> lk(mutex);
- for (auto & [name, inst] : mapping) {
- if (inst.meta.is_active()) {
- SRV_INF("unloading model instance name=%s\n", name.c_str());
- interrupt_subprocess(inst.stdin_file);
- // status change will be handled by the managing thread
- }
- // moving the thread to join list to avoid deadlock
- to_join.push_back(std::move(inst.th));
- }
- }
- for (auto & th : to_join) {
- if (th.joinable()) {
- th.join();
- }
- }
- }
- void server_models::update_status(const std::string & name, server_model_status status) {
- // for now, we only allow updating to LOADED status
- if (status != SERVER_MODEL_STATUS_LOADED) {
- throw std::runtime_error("invalid status value");
- }
- auto meta = get_meta(name);
- if (meta.has_value()) {
- meta->status = status;
- update_meta(name, meta.value());
- }
- }
- void server_models::wait_until_loaded(const std::string & name) {
- std::unique_lock<std::mutex> lk(mutex);
- cv.wait(lk, [this, &name]() {
- auto it = mapping.find(name);
- if (it != mapping.end()) {
- return it->second.meta.status != SERVER_MODEL_STATUS_LOADING;
- }
- return false;
- });
- }
- bool server_models::ensure_model_loaded(const std::string & name) {
- auto meta = get_meta(name);
- if (!meta.has_value()) {
- throw std::runtime_error("model name=" + name + " is not found");
- }
- if (meta->status == SERVER_MODEL_STATUS_LOADED) {
- return false; // already loaded
- }
- if (meta->status == SERVER_MODEL_STATUS_UNLOADED) {
- SRV_INF("model name=%s is not loaded, loading...\n", name.c_str());
- load(name);
- }
- SRV_INF("waiting until model name=%s is fully loaded...\n", name.c_str());
- wait_until_loaded(name);
- // check final status
- meta = get_meta(name);
- if (!meta.has_value() || meta->is_failed()) {
- throw std::runtime_error("model name=" + name + " failed to load");
- }
- return true;
- }
- 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) {
- auto meta = get_meta(name);
- if (!meta.has_value()) {
- throw std::runtime_error("model name=" + name + " is not found");
- }
- if (meta->status != SERVER_MODEL_STATUS_LOADED) {
- throw std::invalid_argument("model name=" + name + " is not loaded");
- }
- if (update_last_used) {
- std::unique_lock<std::mutex> lk(mutex);
- mapping[name].meta.last_used = ggml_time_ms();
- }
- SRV_INF("proxying request to model %s on port %d\n", name.c_str(), meta->port);
- auto proxy = std::make_unique<server_http_proxy>(
- method,
- CHILD_ADDR,
- meta->port,
- req.path,
- req.headers,
- req.body,
- req.should_stop);
- return proxy;
- }
- std::thread server_models::setup_child_server(const std::function<void(int)> & shutdown_handler) {
- // send a notification to the router server that a model instance is ready
- common_log_pause(common_log_main());
- fflush(stdout);
- fprintf(stdout, "%s\n", CMD_CHILD_TO_ROUTER_READY);
- fflush(stdout);
- common_log_resume(common_log_main());
- // setup thread for monitoring stdin
- return std::thread([shutdown_handler]() {
- // wait for EOF on stdin
- SRV_INF("%s", "child server monitoring thread started, waiting for EOF on stdin...\n");
- bool eof = false;
- while (true) {
- std::string line;
- if (!std::getline(std::cin, line)) {
- // EOF detected, that means the router server is unexpectedly exit or killed
- eof = true;
- break;
- }
- if (line.find(CMD_ROUTER_TO_CHILD_EXIT) != std::string::npos) {
- SRV_INF("%s", "exit command received, exiting...\n");
- shutdown_handler(0);
- break;
- }
- }
- if (eof) {
- SRV_INF("%s", "EOF on stdin detected, forcing shutdown...\n");
- exit(1);
- }
- });
- }
- //
- // server_models_routes
- //
- static void res_ok(std::unique_ptr<server_http_res> & res, const json & response_data) {
- res->status = 200;
- res->data = safe_json_to_str(response_data);
- }
- static void res_err(std::unique_ptr<server_http_res> & res, const json & error_data) {
- res->status = json_value(error_data, "code", 500);
- res->data = safe_json_to_str({{ "error", error_data }});
- }
- static bool router_validate_model(const std::string & name, server_models & models, bool models_autoload, std::unique_ptr<server_http_res> & res) {
- if (name.empty()) {
- res_err(res, format_error_response("model name is missing from the request", ERROR_TYPE_INVALID_REQUEST));
- return false;
- }
- auto meta = models.get_meta(name);
- if (!meta.has_value()) {
- res_err(res, format_error_response("model not found", ERROR_TYPE_INVALID_REQUEST));
- return false;
- }
- if (models_autoload) {
- models.ensure_model_loaded(name);
- } else {
- if (meta->status != SERVER_MODEL_STATUS_LOADED) {
- res_err(res, format_error_response("model is not loaded", ERROR_TYPE_INVALID_REQUEST));
- return false;
- }
- }
- return true;
- }
- static bool is_autoload(const common_params & params, const server_http_req & req) {
- std::string autoload = req.get_param("autoload");
- if (autoload.empty()) {
- return params.models_autoload;
- } else {
- return autoload == "true" || autoload == "1";
- }
- }
- void server_models_routes::init_routes() {
- this->get_router_props = [this](const server_http_req & req) {
- std::string name = req.get_param("model");
- if (name.empty()) {
- // main instance
- auto res = std::make_unique<server_http_res>();
- res_ok(res, {
- // TODO: add support for this on web UI
- {"role", "router"},
- {"max_instances", 4}, // dummy value for testing
- // this is a dummy response to make sure webui doesn't break
- {"model_alias", "llama-server"},
- {"model_path", "none"},
- {"default_generation_settings", {
- {"params", json{}},
- {"n_ctx", 0},
- }},
- {"webui_settings", webui_settings},
- });
- return res;
- }
- return proxy_get(req);
- };
- this->proxy_get = [this](const server_http_req & req) {
- std::string method = "GET";
- std::string name = req.get_param("model");
- bool autoload = is_autoload(params, req);
- auto error_res = std::make_unique<server_http_res>();
- if (!router_validate_model(name, models, autoload, error_res)) {
- return error_res;
- }
- return models.proxy_request(req, method, name, false);
- };
- this->proxy_post = [this](const server_http_req & req) {
- std::string method = "POST";
- json body = json::parse(req.body);
- std::string name = json_value(body, "model", std::string());
- bool autoload = is_autoload(params, req);
- auto error_res = std::make_unique<server_http_res>();
- if (!router_validate_model(name, models, autoload, error_res)) {
- return error_res;
- }
- return models.proxy_request(req, method, name, true); // update last usage for POST request only
- };
- this->post_router_models_load = [this](const server_http_req & req) {
- auto res = std::make_unique<server_http_res>();
- json body = json::parse(req.body);
- std::string name = json_value(body, "model", std::string());
- auto model = models.get_meta(name);
- if (!model.has_value()) {
- res_err(res, format_error_response("model is not found", ERROR_TYPE_NOT_FOUND));
- return res;
- }
- if (model->status == SERVER_MODEL_STATUS_LOADED) {
- res_err(res, format_error_response("model is already loaded", ERROR_TYPE_INVALID_REQUEST));
- return res;
- }
- models.load(name);
- res_ok(res, {{"success", true}});
- return res;
- };
- this->get_router_models = [this](const server_http_req &) {
- auto res = std::make_unique<server_http_res>();
- json models_json = json::array();
- auto all_models = models.get_all_meta();
- std::time_t t = std::time(0);
- for (const auto & meta : all_models) {
- json status {
- {"value", server_model_status_to_string(meta.status)},
- {"args", meta.args},
- };
- if (!meta.preset.name.empty()) {
- common_preset preset_copy = meta.preset;
- unset_reserved_args(preset_copy, false);
- preset_copy.unset_option("LLAMA_ARG_HOST");
- preset_copy.unset_option("LLAMA_ARG_PORT");
- preset_copy.unset_option("LLAMA_ARG_ALIAS");
- status["preset"] = preset_copy.to_ini();
- }
- if (meta.is_failed()) {
- status["exit_code"] = meta.exit_code;
- status["failed"] = true;
- }
- models_json.push_back(json {
- {"id", meta.name},
- {"object", "model"}, // for OAI-compat
- {"owned_by", "llamacpp"}, // for OAI-compat
- {"created", t}, // for OAI-compat
- {"status", status},
- // TODO: add other fields, may require reading GGUF metadata
- });
- }
- res_ok(res, {
- {"data", models_json},
- {"object", "list"},
- });
- return res;
- };
- this->post_router_models_unload = [this](const server_http_req & req) {
- auto res = std::make_unique<server_http_res>();
- json body = json::parse(req.body);
- std::string name = json_value(body, "model", std::string());
- auto model = models.get_meta(name);
- if (!model.has_value()) {
- res_err(res, format_error_response("model is not found", ERROR_TYPE_INVALID_REQUEST));
- return res;
- }
- if (model->status != SERVER_MODEL_STATUS_LOADED) {
- res_err(res, format_error_response("model is not loaded", ERROR_TYPE_INVALID_REQUEST));
- return res;
- }
- models.unload(name);
- res_ok(res, {{"success", true}});
- return res;
- };
- }
- //
- // server_http_proxy
- //
- // simple implementation of a pipe
- // used for streaming data between threads
- template<typename T>
- struct pipe_t {
- std::mutex mutex;
- std::condition_variable cv;
- std::queue<T> queue;
- std::atomic<bool> writer_closed{false};
- std::atomic<bool> reader_closed{false};
- void close_write() {
- writer_closed.store(true, std::memory_order_relaxed);
- cv.notify_all();
- }
- void close_read() {
- reader_closed.store(true, std::memory_order_relaxed);
- cv.notify_all();
- }
- bool read(T & output, const std::function<bool()> & should_stop) {
- std::unique_lock<std::mutex> lk(mutex);
- constexpr auto poll_interval = std::chrono::milliseconds(500);
- while (true) {
- if (!queue.empty()) {
- output = std::move(queue.front());
- queue.pop();
- return true;
- }
- if (writer_closed.load()) {
- return false; // clean EOF
- }
- if (should_stop()) {
- close_read(); // signal broken pipe to writer
- return false; // cancelled / reader no longer alive
- }
- cv.wait_for(lk, poll_interval);
- }
- }
- bool write(T && data) {
- std::lock_guard<std::mutex> lk(mutex);
- if (reader_closed.load()) {
- return false; // broken pipe
- }
- queue.push(std::move(data));
- cv.notify_one();
- return true;
- }
- };
- static std::string to_lower_copy(const std::string & value) {
- std::string lowered(value.size(), '\0');
- std::transform(value.begin(), value.end(), lowered.begin(), [](unsigned char c) { return std::tolower(c); });
- return lowered;
- }
- static bool should_strip_proxy_header(const std::string & header_name) {
- // Headers that get duplicated when router forwards child responses
- if (header_name == "server" ||
- header_name == "transfer-encoding" ||
- header_name == "content-length" || // quick fix for https://github.com/ggml-org/llama.cpp/issues/17710
- header_name == "keep-alive") {
- return true;
- }
- // Router injects CORS, child also sends them: duplicate
- if (header_name.rfind("access-control-", 0) == 0) {
- return true;
- }
- return false;
- }
- server_http_proxy::server_http_proxy(
- const std::string & method,
- const std::string & host,
- int port,
- const std::string & path,
- const std::map<std::string, std::string> & headers,
- const std::string & body,
- const std::function<bool()> should_stop) {
- // shared between reader and writer threads
- auto cli = std::make_shared<httplib::Client>(host, port);
- auto pipe = std::make_shared<pipe_t<msg_t>>();
- // setup Client
- cli->set_connection_timeout(0, 200000); // 200 milliseconds
- this->status = 500; // to be overwritten upon response
- this->cleanup = [pipe]() {
- pipe->close_read();
- pipe->close_write();
- };
- // wire up the receive end of the pipe
- this->next = [pipe, should_stop](std::string & out) -> bool {
- msg_t msg;
- bool has_next = pipe->read(msg, should_stop);
- if (!msg.data.empty()) {
- out = std::move(msg.data);
- }
- return has_next; // false if EOF or pipe broken
- };
- // wire up the HTTP client
- // note: do NOT capture `this` pointer, as it may be destroyed before the thread ends
- httplib::ResponseHandler response_handler = [pipe, cli](const httplib::Response & response) {
- msg_t msg;
- msg.status = response.status;
- for (const auto & [key, value] : response.headers) {
- const auto lowered = to_lower_copy(key);
- if (should_strip_proxy_header(lowered)) {
- continue;
- }
- if (lowered == "content-type") {
- msg.content_type = value;
- continue;
- }
- msg.headers[key] = value;
- }
- return pipe->write(std::move(msg)); // send headers first
- };
- httplib::ContentReceiverWithProgress content_receiver = [pipe](const char * data, size_t data_length, size_t, size_t) {
- // send data chunks
- // returns false if pipe is closed / broken (signal to stop receiving)
- return pipe->write({{}, 0, std::string(data, data_length), ""});
- };
- // prepare the request to destination server
- httplib::Request req;
- {
- req.method = method;
- req.path = path;
- for (const auto & [key, value] : headers) {
- req.set_header(key, value);
- }
- req.body = body;
- req.response_handler = response_handler;
- req.content_receiver = content_receiver;
- }
- // start the proxy thread
- SRV_DBG("start proxy thread %s %s\n", req.method.c_str(), req.path.c_str());
- this->thread = std::thread([cli, pipe, req]() {
- auto result = cli->send(std::move(req));
- if (result.error() != httplib::Error::Success) {
- auto err_str = httplib::to_string(result.error());
- SRV_ERR("http client error: %s\n", err_str.c_str());
- pipe->write({{}, 500, "", ""}); // header
- pipe->write({{}, 0, "proxy error: " + err_str, ""}); // body
- }
- pipe->close_write(); // signal EOF to reader
- SRV_DBG("%s", "client request thread ended\n");
- });
- this->thread.detach();
- // wait for the first chunk (headers)
- {
- msg_t header;
- if (pipe->read(header, should_stop)) {
- SRV_DBG("%s", "received response headers\n");
- this->status = header.status;
- this->headers = std::move(header.headers);
- if (!header.content_type.empty()) {
- this->content_type = std::move(header.content_type);
- }
- } else {
- SRV_DBG("%s", "no response headers received (request cancelled?)\n");
- }
- }
- }
|