list servables in repository (#3287)

Ticket:CVS-163279

Author: atobiszei

src/BUILD

@@ -416,11 +416,21 @@ cc_library(
     copts = COPTS_ADJUSTED,
     linkopts = LINKOPTS_ADJUSTED,
 )
+cc_library(
+    name = "modelextensions",
+    hdrs = ["modelextensions.hpp",],
+    srcs = ["modelextensions.cpp",],
+    visibility = ["//visibility:public",],
+    local_defines = COMMON_LOCAL_DEFINES,
+    copts = COPTS_ADJUSTED,
+    linkopts = LINKOPTS_ADJUSTED,
+)
 cc_library(
     name = "modelinstance_h",
     hdrs = ["modelinstance.hpp",],
     srcs = [],
     deps = [
+        "modelextensions",
         "libovmslogging",
         "libovms_outputkeeper",
         "libovmsprofiler",
@@ -701,6 +711,7 @@ cc_library(
             "//src/kfserving_api:kfserving_api_cpp",
             "capimodule",
             "//src/pull_module:hf_pull_model_module",
+            "//src/servables_config_manager_module:servablesconfigmanagermodule",
             "predict_request_validation_utils", # to be removed when capi has its own lib and added there @atobisze
             "kfs_backend_impl",
             "tfs_backend_impl",
@@ -2966,6 +2977,7 @@ cc_test(
             "//src:custom_nodes_common_buffersqueue",
             "@com_google_googletest//:gtest",
             ":pull_hf_model_test",
+            ":listmodels_test",
             ":graph_export_test",
             ] + select({
                 "//conditions:default": [
@@ -3075,6 +3087,7 @@ cc_library(
     srcs = ["test/pull_hf_model_test.cpp"],
     linkopts = [],
     deps = [
+        "//src/servables_config_manager_module:listmodels",
         ":test_utils",
         "//src/pull_module:libgit2",
         "//src/pull_module:hf_pull_model_module",
@@ -3085,6 +3098,21 @@ cc_library(
     local_defines = COMMON_LOCAL_DEFINES,
     copts = COPTS_TESTS,
 )
+cc_library(
+    name = "listmodels_test",
+    srcs = ["test/listmodels_test.cpp"],
+    alwayslink = True,
+    linkopts = [],
+    deps = [
+        "//src/servables_config_manager_module:listmodels",
+        ":test_utils",
+        #"//src:ovms_lib",
+        "libovmsstring_utils",
+        "@com_google_googletest//:gtest",
+    ],
+    local_defines = COMMON_LOCAL_DEFINES,
+    copts = COPTS_TESTS,
+)
 cc_library(
     name = "graph_export_test",
     linkstatic = 1,

src/capi_frontend/server_settings.hpp

@@ -73,6 +73,7 @@ struct ServerSettingsImpl {
     std::string cacheDir;
     bool withPython = false;
     bool startedWithCLI = false;
+    bool listServables = false;
     HFSettingsImpl hfSettings;
 };
 

src/cli_parser.cpp

@@ -136,7 +136,11 @@ void CLIParser::parse(int argc, char** argv) {
             ("model_repository_path",
                 "HF model destination download path",
                 cxxopts::value<std::string>(),
-                "MODEL_REPOSITORY_PATH");
+                "MODEL_REPOSITORY_PATH")
+            ("list_models",
+                "Directive to show available servables in models repository",
+                cxxopts::value<bool>()->default_value("false"),
+                "LIST_MODELS");
 
         options->add_options("single model")
             ("model_name",
@@ -224,7 +228,13 @@ void CLIParser::prepare(ServerSettingsImpl* serverSettings, ModelsSettingsImpl*
     if (nullptr == result) {
         throw std::logic_error("Tried to prepare server and model settings without parse result");
     }
-
+    // list models mode
+    if (result->count("list_models")) {
+        serverSettings->listServables = result->operator[]("list_models").as<bool>();
+        if (result->count("model_repository_path"))
+            serverSettings->hfSettings.downloadPath = result->operator[]("model_repository_path").as<std::string>();
+        return;
+    }
     // Ovms Pull models mode
     if (result->count("pull")) {
         serverSettings->hfSettings.pullHfModelMode = result->operator[]("pull").as<bool>();

src/config.cpp

@@ -88,6 +88,14 @@ bool Config::validate() {
     if (this->serverSettings.hfSettings.pullHfModelMode) {
         return true;
     }
+    if (this->serverSettings.listServables) {
+        if (this->serverSettings.hfSettings.downloadPath.empty()) {
+            std::cerr << "Use --list_models with --model_repository_path" << std::endl;
+            return false;
+        }
+        return true;
+    }
+
     if (!configPath().empty() && (!modelName().empty() || !modelPath().empty())) {
         std::cerr << "Use either config_path or model_path with model_name" << std::endl;
         return false;

src/modelextensions.cpp

@@ -0,0 +1,24 @@
+//*****************************************************************************
+// Copyright 2025 Intel Corporation
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//*****************************************************************************
+#include "modelextensions.hpp"
+
+namespace ovms {
+const std::array<const char*, 2> OV_MODEL_FILES_EXTENSIONS{".xml", ".bin"};
+const std::array<const char*, 1> ONNX_MODEL_FILES_EXTENSIONS{".onnx"};
+const std::array<const char*, 2> PADDLE_MODEL_FILES_EXTENSIONS{".pdmodel", ".pdiparams"};
+const std::array<const char*, 1> TF_MODEL_FILES_EXTENSIONS{".pb"};
+const std::array<const char*, 1> TFLITE_MODEL_FILES_EXTENSIONS{".tflite"};
+}  // namespace ovms

src/modelextensions.hpp

@@ -0,0 +1,25 @@
+//*****************************************************************************
+// Copyright 2025 Intel Corporation
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//*****************************************************************************
+#pragma once
+#include <array>
+
+namespace ovms {
+extern const std::array<const char*, 2> OV_MODEL_FILES_EXTENSIONS;
+extern const std::array<const char*, 1> ONNX_MODEL_FILES_EXTENSIONS;
+extern const std::array<const char*, 2> PADDLE_MODEL_FILES_EXTENSIONS;
+extern const std::array<const char*, 1> TF_MODEL_FILES_EXTENSIONS;
+extern const std::array<const char*, 1> TFLITE_MODEL_FILES_EXTENSIONS;
+}  // namespace ovms

src/module_names.cpp

@@ -24,4 +24,5 @@ const std::string HF_MODEL_PULL_MODULE_NAME = "HfModelPullModule";
 const std::string METRICS_MODULE_NAME = "MetricsModule";
 const std::string PYTHON_INTERPRETER_MODULE_NAME = "PythonInterpreterModule";
 const std::string CAPI_MODULE_NAME = "C-APIModule";
+const std::string SERVABLES_CONFIG_MANAGER_MODULE_NAME = {"ServablesConfigManagerModule"};
 }  // namespace ovms

src/module_names.hpp

@@ -25,4 +25,5 @@ extern const std::string HF_MODEL_PULL_MODULE_NAME;
 extern const std::string METRICS_MODULE_NAME;
 extern const std::string PYTHON_INTERPRETER_MODULE_NAME;
 extern const std::string CAPI_MODULE_NAME;
+extern const std::string SERVABLES_CONFIG_MANAGER_MODULE_NAME;
 }  // namespace ovms

src/servables_config_manager_module/BUILD

@@ -0,0 +1,60 @@
+#
+# Copyright (c) 2025 Intel Corporation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+load("//:common_settings.bzl",
+     "COMMON_STATIC_LIBS_COPTS", "COMMON_STATIC_LIBS_LINKOPTS", "COMMON_FUZZER_COPTS", "COMMON_FUZZER_LINKOPTS", "COMMON_LOCAL_DEFINES", "PYBIND_DEPS")
+
+COPTS_ADJUSTED = COMMON_STATIC_LIBS_COPTS + select({
+        "//conditions:default": [],
+        "//:fuzzer_build" : COMMON_FUZZER_COPTS,
+})
+
+LINKOPTS_ADJUSTED = COMMON_STATIC_LIBS_LINKOPTS + select({
+    "//conditions:default": [],
+    "//:fuzzer_build" : COMMON_FUZZER_LINKOPTS,
+})
+
+cc_library(
+    name = "listmodels",
+    hdrs = ["listmodels.hpp",],
+    srcs = ["listmodels.cpp",],
+    deps = [
+        "//src:libovmsfilesystem",
+        "//src:libovmslogging",
+        "//src:modelextensions",
+    ],
+    visibility = ["//visibility:public",],
+    local_defines = COMMON_LOCAL_DEFINES,
+    copts = COPTS_ADJUSTED,
+    linkopts = LINKOPTS_ADJUSTED,
+)
+cc_library(
+    name = "servablesconfigmanagermodule",
+    srcs = ["servablesconfigmanagermodule.cpp"],
+    hdrs = ["servablesconfigmanagermodule.hpp"],
+    deps =  [
+             "listmodels",
+             "//src:cpp_headers",
+             "//src:libovmsstring_utils",
+             "//src:libovmslogging",
+             "//src:libovms_server_settings",
+             "//src:libovms_module",
+    ],
+    visibility = ["//visibility:public"],
+    copts = COPTS_ADJUSTED,
+    linkopts = LINKOPTS_ADJUSTED,
+    local_defines = COMMON_LOCAL_DEFINES,
+)

src/servables_config_manager_module/listmodels.cpp

@@ -0,0 +1,134 @@
+//*****************************************************************************
+// Copyright 2025 Intel Corporation
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//*****************************************************************************
+#include "listmodels.hpp"
+
+#include <filesystem>
+#include <fstream>
+#include <iostream>
+
+#include "src/filesystem.hpp"
+#include "src/modelextensions.hpp"
+#include "src/logging.hpp"
+
+namespace ovms {
+
+bool isMediapipeGraphDir(const std::string& path) {
+    std::filesystem::path graphPath(path);
+    graphPath /= "graph.pbtxt";
+    return std::filesystem::exists(graphPath) && std::filesystem::is_regular_file(graphPath);
+}
+bool isVersionDir(const std::string& path) {
+    std::string dirName = std::filesystem::path(path).filename().string();
+    return !dirName.empty() &&
+           std::all_of(dirName.begin(), dirName.end(), ::isdigit) &&
+           dirName[0] != '0' &&
+           std::filesystem::is_directory(path);
+}
+
+std::string getPartialPath(const std::filesystem::path& path, int depth) {
+    std::string partialPath = path.filename().string();
+    std::filesystem::path parentPath = path.parent_path();
+    for (int i = 0; i < depth; ++i) {
+        if (parentPath.empty() || parentPath == parentPath.root_path()) {
+            SPDLOG_ERROR("Error trying to get partial path:{}, {}", partialPath, i);
+            throw std::runtime_error("Depth is greater than the number of directories");
+        }
+        partialPath = ovms::FileSystem::appendSlash(parentPath.filename().string()) + partialPath;
+        parentPath = parentPath.parent_path();
+    }
+    SPDLOG_TRACE("Current partial path:{}", partialPath);
+    return partialPath;
+}
+static bool registeredModelFromThisDirectory(const std::filesystem::path& path, std::unordered_map<std::string, ServableType_t>& servablesList, int depth) {
+    const std::string partialPath(getPartialPath(path, depth));
+    for (const auto& entry : std::filesystem::directory_iterator(path)) {
+        if (!isVersionDir(entry.path().string())) {
+            continue;
+        }
+        SPDLOG_TRACE("Entry is a version directory: {}", entry.path().string());
+        // i want to have filename + up to 3 levels of directories
+        if (hasRequiredExtensions(entry.path().string(), OV_MODEL_FILES_EXTENSIONS)) {
+            servablesList[partialPath] = SERVABLE_TYPE_MODEL;
+            return true;
+        } else if (hasRequiredExtensions(entry.path().string(), ONNX_MODEL_FILES_EXTENSIONS)) {
+            servablesList[partialPath] = SERVABLE_TYPE_MODEL;
+            return true;
+        } else if (hasRequiredExtensions(entry.path().string(), PADDLE_MODEL_FILES_EXTENSIONS)) {
+            servablesList[partialPath] = SERVABLE_TYPE_MODEL;
+            return true;
+        } else if (hasRequiredExtensions(entry.path().string(), TF_MODEL_FILES_EXTENSIONS)) {
+            servablesList[partialPath] = SERVABLE_TYPE_MODEL;
+            return true;
+        } else if (hasRequiredExtensions(entry.path().string(), TFLITE_MODEL_FILES_EXTENSIONS)) {
+            servablesList[partialPath] = SERVABLE_TYPE_MODEL;
+            return true;
+        }
+    }
+    return false;
+}
+
+static bool registeredGraphFromThisDirectory(const std::filesystem::path& path, std::unordered_map<std::string, ServableType_t>& servablesList, int depth) {
+    if (isMediapipeGraphDir(path.string())) {
+        SPDLOG_TRACE("Found mediapipe graph: {}", path.string());
+        servablesList[getPartialPath(path, depth)] = SERVABLE_TYPE_MEDIAPIPEGRAPH;
+        return true;
+    }
+    return false;
+}
+
+static void listServables(const std::filesystem::path& directoryPath, std::unordered_map<std::string, ServableType_t>& servablesList, int depth) {
+    SPDLOG_TRACE("Listing servables in directory: {}", directoryPath.string());
+    if (!std::filesystem::is_directory(directoryPath)) {
+        SPDLOG_TRACE("Path is not a directory: {}", directoryPath.string());
+        return;
+    }
+    if (std::filesystem::is_empty(directoryPath)) {
+        SPDLOG_TRACE("Directory is empty: {}", directoryPath.string());
+        return;
+    }
+    SPDLOG_TRACE("Directory name: {}", directoryPath.filename().string());
+    if (registeredGraphFromThisDirectory(directoryPath.string(), servablesList, depth)) {
+        return;
+    }
+    if (registeredModelFromThisDirectory(directoryPath.string(), servablesList, depth)) {
+        return;
+    }
+    for (const auto& entry : std::filesystem::directory_iterator(directoryPath)) {
+        if (entry.is_directory()) {
+            listServables(entry.path(), servablesList, depth + 1);
+        }
+    }
+    SPDLOG_TRACE("No servables found in directory: {}", directoryPath.string());
+}
+std::unordered_map<std::string, ServableType_t> listServables(const std::string directoryPath) {
+    SPDLOG_TRACE("Listing servables in directory: {}", directoryPath);
+    std::unordered_map<std::string, ServableType_t> servablesList;
+    std::filesystem::path path(directoryPath);
+    if (!std::filesystem::is_directory(path)) {
+        SPDLOG_ERROR("Path is not a directory: {}", directoryPath);
+        return servablesList;
+    }
+    if (std::filesystem::is_empty(path)) {
+        SPDLOG_ERROR("Directory is empty: {}", directoryPath);
+        return servablesList;
+    }
+    SPDLOG_TRACE("Directory name: {}", path.filename().string());
+    for (const auto& file : std::filesystem::directory_iterator(path)) {
+        listServables(file.path(), servablesList, 0);
+    }
+    return servablesList;
+}
+}  // namespace ovms