be/src/udf/python/python_server.h

// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you 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 <atomic>
#include <condition_variable>
#include <memory>
#include <mutex>
#include <thread>
#include <unordered_map>
#include <vector>

#include "common/status.h"
#include "runtime/memory/mem_tracker.h"
#include "udf/python/python_udf_meta.h"
#include "udf/python/python_udf_runtime.h"

namespace doris {
class PythonServerManager {
public:
    PythonServerManager() = default;

    ~PythonServerManager() { shutdown(); }

    static PythonServerManager& instance() {
        static PythonServerManager instance;
        return instance;
    }

    template <typename T>
    Status get_client(const PythonUDFMeta& func_meta, const PythonVersion& version,
                      std::shared_ptr<T>* client,
                      const std::shared_ptr<arrow::Schema>& data_schema = nullptr);

    Status fork(const PythonVersion& version, ProcessPtr* process);

    // Clear Python module cache for a specific UDF location across all processes
    Status clear_module_cache(const std::string& location);

    // Clear Python UDAF runtime state after DROP FUNCTION
    void clear_udaf_state_cache(int64_t function_id);

    void shutdown();

#ifdef BE_TEST
    // For unit testing only.
    void check_and_recreate_processes_for_test() { _check_and_recreate_processes(); }

    void set_process_pool_for_test(const PythonVersion& version, std::vector<ProcessPtr> processes,
                                   bool initialized = true);

    std::vector<ProcessPtr>& process_pool_for_test(const PythonVersion& version);

    Status broadcast_action_to_processes_for_test(const std::string& action_type,
                                                  const std::string& body,
                                                  const std::string& log_name) {
        return _broadcast_action_to_processes(action_type, body, log_name);
    }
#endif

private:
    struct VersionedProcessPool {
        std::mutex mutex;
        std::vector<ProcessPtr> processes;
        bool initialized = false;
    };

    /** 
     * Lazily initialize and return the process pool for specific Python version. 
     */
    Result<std::shared_ptr<VersionedProcessPool>> _ensure_pool_initialized(
            const PythonVersion& version);

    /**
     * Pick an available process from specific pool, recreating one on demand if needed.
     */
    Status _get_process(const PythonVersion& version,
                        const std::shared_ptr<VersionedProcessPool>& versioned_pool,
                        ProcessPtr* process);

    /**
     * Start health check background thread (called once by ensure_pool_initialized)
     * Thread periodically checks process health and refreshes memory stats
     */
    void _start_health_check_thread();

    /**
     * Check process health and recreate dead processes
     */
    void _check_and_recreate_processes();

    /**
     * Read resident set size (RSS) for a single process from /proc/{pid}/statm
     */
    Status _read_process_memory(pid_t pid, size_t* rss_bytes);

    /**
     * Refresh memory statistics for all Python processes
     */
    void _refresh_memory_stats();

    std::shared_ptr<VersionedProcessPool> _get_or_create_process_pool(const PythonVersion& version);
    std::vector<std::pair<PythonVersion, std::shared_ptr<VersionedProcessPool>>>
    _snapshot_process_pools();
    Status _broadcast_action_to_processes(const std::string& action_type, const std::string& body,
                                          const std::string& log_name);

    std::unordered_map<PythonVersion, std::shared_ptr<VersionedProcessPool>> _process_pools;
    // Protects the version -> pool handle map only. Per-version process operations are guarded
    // by VersionedProcessPool::mutex.
    std::mutex _pools_mutex;
    // Health check background thread
    std::unique_ptr<std::thread> _health_check_thread;
    std::atomic<bool> _shutdown_flag {false};
    std::condition_variable _health_check_cv;
    std::mutex _health_check_mutex;
    MemTracker _mem_tracker {"PythonUDFProcesses"};
};

} // namespace doris