ClickHouse/dbms/src/Processors/Executors/PipelineExecutor.cpp

#include <Processors/Executors/PipelineExecutor.h>
#include <unordered_map>
#include <queue>
#include <IO/WriteBufferFromString.h>
#include <Processors/printPipeline.h>
#include <Common/EventCounter.h>
#include <ext/scope_guard.h>
#include <Common/CurrentThread.h>

#include <boost/lockfree/queue.hpp>
#include <Common/Stopwatch.h>

namespace DB
{

namespace ErrorCodes
{
    extern const int TOO_MANY_ROWS_OR_BYTES;
    extern const int QUOTA_EXPIRED;
    extern const int QUERY_WAS_CANCELLED;
}

static bool checkCanAddAdditionalInfoToException(const DB::Exception & exception)
{
    /// Don't add additional info to limits and quota exceptions, and in case of kill query (to pass tests).
    return exception.code() != ErrorCodes::TOO_MANY_ROWS_OR_BYTES
           && exception.code() != ErrorCodes::QUOTA_EXPIRED
           && exception.code() != ErrorCodes::QUERY_WAS_CANCELLED;
}

PipelineExecutor::PipelineExecutor(Processors processors)
    : processors(std::move(processors)), num_waited_tasks(0), num_tasks_to_wait(0), cancelled(false), finished(false), main_executor_flag(false), num_waiting_threads(0)
{
    buildGraph();
}

bool PipelineExecutor::addEdges(UInt64 node)
{
    auto throwUnknownProcessor = [](const IProcessor * proc, const IProcessor * parent, bool from_input_port)
    {
        String msg = "Processor " + proc->getName() + " was found as " + (from_input_port ? "input" : "output")
                     + " for processor " + parent->getName() + ", but not found in list of processors.";

        throw Exception(msg, ErrorCodes::LOGICAL_ERROR);
    };

    const IProcessor * cur = graph[node].processor;

    auto add_edge = [&](auto & from_port, const IProcessor * to_proc, Edges & edges)
    {
        auto it = processors_map.find(to_proc);
        if (it == processors_map.end())
            throwUnknownProcessor(to_proc, cur, true);

        UInt64 proc_num = it->second;
        Edge * edge_ptr = nullptr;

        for (auto & edge : edges)
            if (edge.to == proc_num)
                edge_ptr = &edge;

        if (!edge_ptr)
        {
            edge_ptr = &edges.emplace_back();
            edge_ptr->to = proc_num;
        }

        from_port.setVersion(&edge_ptr->version);
    };

    bool was_edge_added = false;

    auto & inputs = processors[node]->getInputs();
    auto from_input = graph[node].backEdges.size();

    if (from_input < inputs.size())
    {
        was_edge_added = true;

        for (auto it = std::next(inputs.begin(), from_input); it != inputs.end(); ++it)
        {
            const IProcessor * proc = &it->getOutputPort().getProcessor();
            add_edge(*it, proc, graph[node].backEdges);
        }
    }

    auto & outputs = processors[node]->getOutputs();
    auto from_output = graph[node].directEdges.size();

    if (from_output < outputs.size())
    {
        was_edge_added = true;

        for (auto it = std::next(outputs.begin(), from_output); it != outputs.end(); ++it)
        {
            const IProcessor * proc = &it->getInputPort().getProcessor();
            add_edge(*it, proc, graph[node].directEdges);
        }
    }

    return was_edge_added;
}

void PipelineExecutor::buildGraph()
{
    UInt64 num_processors = processors.size();

    graph.reserve(num_processors);
    for (UInt64 node = 0; node < num_processors; ++node)
    {
        IProcessor * proc = processors[node].get();
        processors_map[proc] = node;
        graph.emplace_back(proc, node);
    }

    for (UInt64 node = 0; node < num_processors; ++node)
        addEdges(node);
}

void PipelineExecutor::addChildlessProcessorsToQueue(Stack & stack)
{
    UInt64 num_processors = processors.size();
    for (UInt64 proc = 0; proc < num_processors; ++proc)
    {
        if (graph[proc].directEdges.empty())
        {
            stack.push(proc);
            graph[proc].status = ExecStatus::Preparing;
        }
    }
}

static void executeJob(IProcessor * processor)
{
    try
    {
        processor->work();
    }
    catch (Exception & exception)
    {
        if (checkCanAddAdditionalInfoToException(exception))
            exception.addMessage("While executing " + processor->getName() + " ("
                                 + toString(reinterpret_cast<std::uintptr_t>(processor)) + ") ");
        throw;
    }
}

//bool PipelineExecutor::tryAssignJob(ExecutionState * state)
//{
//    auto current_stream = state->current_stream;
//    for (auto & executor_context : executor_contexts)
//    {
//        if (executor_context->current_stream == current_stream)
//        {
//            ExecutionState * expected = nullptr;
//            if (executor_context->next_task_to_execute.compare_exchange_strong(expected, state))
//            {
//                ++num_tasks_to_wait;
//                return true;
//            }
//        }
//    }
//
//    return false;
//}

void PipelineExecutor::addJob(ExecutionState * execution_state)
{
///    if (!threads.empty())
    {
        auto job = [execution_state]()
        {
            // SCOPE_EXIT(
                    /// while (!finished_execution_queue.push(pid));
                    /// event_counter.notify()
            // );

            try
            {
                Stopwatch watch;
                executeJob(execution_state->processor);
                execution_state->execution_time_ns += watch.elapsed();

                ++execution_state->num_executed_jobs;
            }
            catch (...)
            {
                /// Note: It's important to save exception before pushing pid to finished_execution_queue
                execution_state->exception = std::current_exception();
            }
        };

        execution_state->job = std::move(job);
        /// auto * state = graph[pid].execution_state.get();

//        bool is_stream_updated = false;
//        if (state->need_update_stream)
//        {
//            is_stream_updated = true;
//            state->current_stream = next_stream;
//            ++next_stream;
//        }

        /// Try assign job to executor right now.
//        if (is_stream_updated || !tryAssignJob(state))
//            execution_states_queue.emplace_back(state);

        /// while (!task_queue.push(graph[pid].execution_state.get()))
        ///    sleep(0);
    }
//    else
//    {
//        /// Execute task in main thread.
//        executeJob(graph[pid].processor);
//        while (!finished_execution_queue.push(pid));
//    }
}

void PipelineExecutor::addAsyncJob(UInt64 pid)
{
    graph[pid].processor->schedule(event_counter);
    graph[pid].status = ExecStatus::Async;
    ++num_tasks_to_wait;
}

void PipelineExecutor::expandPipeline(Stack & stack, UInt64 pid)
{
    auto & cur_node = graph[pid];
    auto new_processors = cur_node.processor->expandPipeline();

    for (const auto & processor : new_processors)
    {
        if (processors_map.count(processor.get()))
            throw Exception("Processor " + processor->getName() + " was already added to pipeline.",
                    ErrorCodes::LOGICAL_ERROR);

        processors_map[processor.get()] = graph.size();
        graph.emplace_back(processor.get(), graph.size());
    }

    processors.insert(processors.end(), new_processors.begin(), new_processors.end());
    UInt64 num_processors = processors.size();

    for (UInt64 node = 0; node < num_processors; ++node)
    {
        if (addEdges(node))
        {
            if (graph[node].status == ExecStatus::Idle || graph[node].status == ExecStatus::New)
            {
                graph[node].status = ExecStatus::Preparing;
                stack.push(node);
            }
        }
    }
}

bool PipelineExecutor::addProcessorToPrepareQueueIfUpdated(Edge & edge, Stack & stack)
{
    /// In this method we have ownership on edge, but node can be concurrently accessed.

    auto & node = graph[edge.to];

    ExecStatus status = node.status.load();

    /// Don't add processor if nothing was read from port.
    if (status != ExecStatus::New && edge.version == edge.prev_version)
        return false;

    if (status == ExecStatus::Finished)
        return false;

    /// Signal that node need to be prepared.
    node.need_to_be_prepared = true;
    edge.prev_version = edge.version;

    /// Try to get ownership for node.

    /// Assume that current status is New or Idle. Otherwise, can't prepare node.
    if (status != ExecStatus::New)
        status = ExecStatus::Idle;

    /// Statuses but New and Idle are not interesting because they own node.
    /// Prepare will be called in owning thread before changing status.
    while (!node.status.compare_exchange_weak(status, ExecStatus::Preparing))
        if (!(status == ExecStatus::New || status == ExecStatus::Idle) || !node.need_to_be_prepared)
            return false;

    stack.push(edge.to);
    return true;

}

bool PipelineExecutor::prepareProcessor(UInt64 pid, Stack & stack, bool async)
{
    /// In this method we have ownership on node.
    auto & node = graph[pid];

    {
        /// Stopwatch watch;

        /// Disable flag before prepare call. Otherwise, we can skip prepare request.
        /// Prepare can be called more times than needed, but it's ok.
        node.need_to_be_prepared = false;

        auto status = node.processor->prepare();

        /// node.execution_state->preparation_time_ns += watch.elapsed();
        node.last_processor_status = status;
    }

    auto add_neighbours_to_prepare_queue = [&, this] ()
    {
        for (auto & edge : node.backEdges)
            addProcessorToPrepareQueueIfUpdated(edge, stack);

        for (auto & edge : node.directEdges)
            addProcessorToPrepareQueueIfUpdated(edge, stack);
    };

    auto try_release_ownership = [&] ()
    {
        ExecStatus expected = ExecStatus::Idle;
        node.status = ExecStatus::Idle;

        if (node.need_to_be_prepared)
        {
            while (!node.status.compare_exchange_weak(expected, ExecStatus::Preparing))
                if (!(expected == ExecStatus::Idle) || !node.need_to_be_prepared)
                    return;

            stack.push(pid);
        }
    };

    switch (node.last_processor_status)
    {
        case IProcessor::Status::NeedData:
        {
            add_neighbours_to_prepare_queue();
            try_release_ownership();

            break;
        }
        case IProcessor::Status::PortFull:
        {
            add_neighbours_to_prepare_queue();
            try_release_ownership();

            break;
        }
        case IProcessor::Status::Finished:
        {
            add_neighbours_to_prepare_queue();
            node.status = ExecStatus::Finished;
            break;
        }
        case IProcessor::Status::Ready:
        {
            node.status = ExecStatus::Executing;
            return true;
        }
        case IProcessor::Status::Async:
        {
            throw Exception("Async is temporary not supported.", ErrorCodes::LOGICAL_ERROR);

//            node.status = ExecStatus::Executing;
//            addAsyncJob(pid);
//            break;
        }
        case IProcessor::Status::Wait:
        {
            if (!async)
                throw Exception("Processor returned status Wait before Async.", ErrorCodes::LOGICAL_ERROR);
            break;
        }
        case IProcessor::Status::ExpandPipeline:
        {

            ExecutionState * desired = node.execution_state.get();
            ExecutionState * expected = nullptr;

            while (!node_to_expand.compare_exchange_strong(expected, desired))
            {
                expected = nullptr;
                doExpandPipeline(stack);
            }

            doExpandPipeline(stack);

            node.need_to_be_prepared = true;
            try_release_ownership();
            break;
        }
    }

    return false;
}

void PipelineExecutor::doExpandPipeline(Stack & stack)
{
    std::unique_lock lock(mutex_to_expand_pipeline);
    ++num_waiting_threads_to_expand_pipeline;

    condvar_to_expand_pipeline.wait(lock, [&]()
    {
        return num_waiting_threads_to_expand_pipeline == num_preparing_threads || node_to_expand == nullptr;
    });

    --num_waiting_threads_to_expand_pipeline;

    if (node_to_expand)
    {
        expandPipeline(stack, node_to_expand.load()->processors_id);
        node_to_expand = nullptr;
        lock.unlock();
        condvar_to_expand_pipeline.notify_all();
    }
}

//void PipelineExecutor::assignJobs()
//{
//    for (auto * state : execution_states_queue)
//    {
//        if (!tryAssignJob(state))
//        {
//            while (!task_queue.push(state))
//                sleep(0);
//
//            task_condvar.notify_one();
//            ++num_tasks_to_wait;
//        }
//    }
//
//    execution_states_queue.clear();
//}

//void PipelineExecutor::processPrepareQueue()
//{
//    while (!prepare_stack.empty())
//    {
//        UInt64 proc = prepare_stack.top();
//        prepare_stack.pop();
//
//        prepareProcessor(proc, false);
//    }
//
//    assignJobs();
//}
//
//void PipelineExecutor::processAsyncQueue()
//{
//    UInt64 num_processors = processors.size();
//    for (UInt64 node = 0; node < num_processors; ++node)
//        if (graph[node].status == ExecStatus::Async)
//            prepareProcessor(node, true);
//
//    assignJobs();
//}

void PipelineExecutor::cancel()
{
    finished = true;
    finish_condvar.notify_one();

    for (auto & context : executor_contexts)
        context->condvar.notify_one();
}

void PipelineExecutor::execute(size_t num_threads)
{
    try
    {
        /// Wait for all tasks to finish in case of exception.
        SCOPE_EXIT(
                finished = true;

                task_condvar.notify_all();

                for (auto & thread : threads)
                    thread.join();
        );

        executeImpl(num_threads);
    }
    catch (Exception & exception)
    {
        if (checkCanAddAdditionalInfoToException(exception))
            exception.addMessage("\nCurrent state:\n" + dumpPipeline());

        throw;
    }

    if (cancelled)
        return;

    bool all_processors_finished = true;
    for (auto & node : graph)
        if (node.status != ExecStatus::Finished)
            all_processors_finished = false;

    if (!all_processors_finished)
        throw Exception("Pipeline stuck. Current state:\n" + dumpPipeline(), ErrorCodes::LOGICAL_ERROR);
}

void PipelineExecutor::executeSingleThread(size_t thread_num, size_t num_threads)
{
    UInt64 total_time_ns = 0;
    UInt64 execution_time_ns = 0;
    UInt64 processing_time_ns = 0;
    UInt64 wait_time_ns = 0;

    Stopwatch total_time_watch;

    std::mutex mutex;

    ExecutionState * state = nullptr;

    auto prepare_processor = [&](UInt64 pid, Stack & stack)
    {
        try
        {
            return prepareProcessor(pid, stack, false);
        }
        catch (...)
        {
            graph[pid].execution_state->exception = std::current_exception();
            cancel();
        }

        return false;
    };

    while (!finished)
    {

        /// First, find any processor to execute.
        /// Just travers graph and prepare any processor.
        while (!finished)
        {

            while (num_waited_tasks < num_tasks_to_wait)
            {
                if (task_queue.pop(state))
                {
                    ++num_waited_tasks;
                    break;
                }
                else
                    state = nullptr;
            }

            if (state)
                break;

            std::unique_lock lock(mutex);

            ++num_waiting_threads;

            if (num_waiting_threads == num_threads && num_waited_tasks == num_tasks_to_wait)
                cancel();

            executor_contexts[thread_num]->is_waiting = true;
            executor_contexts[thread_num]->condvar.wait(lock, [&]() { return finished || num_waited_tasks < num_tasks_to_wait; });
            executor_contexts[thread_num]->is_waiting = false;

            --num_waiting_threads;
        }

        if (finished)
            break;

        while (state)
        {
            if (finished)
                break;

            Stopwatch processing_time_watch;

            /// Try to execute neighbour processor.
            {
                /// std::unique_lock lock(main_executor_mutex);

                Stack stack;

                ++num_preparing_threads;
                if (node_to_expand)
                    doExpandPipeline(stack);

                /// Execute again if can.
                if (!prepare_processor(state->processors_id, stack))
                    state = nullptr;

                /// Process all neighbours. Children will be on the top of stack, then parents.
                while (!stack.empty() && !finished)
                {
                    while (!state && !stack.empty() && !finished)
                    {
                        auto current_processor = stack.top();
                        stack.pop();

                        if (prepare_processor(current_processor, stack))
                            state = graph[current_processor].execution_state.get();
                    }

                    bool wake_up_threads = !stack.empty();

                    while (!stack.empty() && !finished)
                    {
                        auto cur_state = graph[stack.top()].execution_state.get();
                        stack.pop();

                        ++num_tasks_to_wait;
                        while (!task_queue.push(cur_state));
                    }

                    if (wake_up_threads)
                    {
                        for (auto & context : executor_contexts)
                            if (context->is_waiting)
                                context->condvar.notify_one();
                    }

                    if (node_to_expand)
                        doExpandPipeline(stack);
                }
                --num_preparing_threads;
            }


            /// Let another thread to continue.
            /// main_executor_condvar.notify_all();

            processing_time_ns += processing_time_watch.elapsed();


            if (!state)
                continue;

            addJob(state);

            {
                Stopwatch execution_time_watch;
                state->job();
                execution_time_ns += execution_time_watch.elapsed();
            }

            if (state->exception)
                cancel();

            if (finished)
                break;
        }
    }

    total_time_ns = total_time_watch.elapsed();
    wait_time_ns = total_time_ns - execution_time_ns - processing_time_ns;

    LOG_TRACE(log, "Thread finished."
                     << " Total time: " << (total_time_ns / 1e9) << " sec."
                     << " Execution time: " << (execution_time_ns / 1e9) << " sec."
                     << " Processing time: " << (processing_time_ns / 1e9) << " sec."
                     << " Wait time: " << (wait_time_ns / 1e9) << "sec.");
}

void PipelineExecutor::executeImpl(size_t num_threads)
{
    /// No need to make task_queue longer than num_threads.
    /// Therefore, finished_execution_queue can't be longer than num_threads too.
    task_queue.reserve_unsafe(8192);

    Stack stack;

    addChildlessProcessorsToQueue(stack);

    while (!stack.empty())
    {
        UInt64 proc = stack.top();
        stack.pop();

        auto cur_state = graph[proc].execution_state.get();
        ++num_tasks_to_wait;
        while (!task_queue.push(cur_state));
    }

    /// background_executor_flag = false;
    num_preparing_threads = 0;
    node_to_expand = nullptr;

    threads.reserve(num_threads);
    executor_contexts.reserve(num_threads);

    auto thread_group = CurrentThread::getGroup();

    for (size_t i = 0; i < num_threads; ++i)
    {
        executor_contexts.emplace_back(std::make_unique<ExecutorContext>());
        auto * executor_context = executor_contexts.back().get();
        executor_context->is_waiting = false;

//        executor_context->executor_number = i;
//        executor_context->next_task_to_execute = nullptr;

        threads.emplace_back([this, thread_group, thread_num = i, num_threads]
        {
            ThreadStatus thread_status;

            if (thread_group)
                CurrentThread::attachTo(thread_group);

            SCOPE_EXIT(
                    if (thread_group)
                        CurrentThread::detachQueryIfNotDetached();
            );

            executeSingleThread(thread_num, num_threads);
        });
    }

    {
        std::mutex finish_mutex;
        std::unique_lock lock(finish_mutex);
        finish_condvar.wait(lock, [&]() -> bool { return finished; });
    }

    {
        std::lock_guard lock(main_executor_mutex);

        for (auto & node : graph)
            if (node.execution_state->exception)
                std::rethrow_exception(node.execution_state->exception);
    }
}

String PipelineExecutor::dumpPipeline() const
{
    for (auto & node : graph)
    {
        if (node.execution_state)
            node.processor->setDescription(
                    "(" + std::to_string(node.execution_state->num_executed_jobs) + " jobs, execution time: "
                    + std::to_string(node.execution_state->execution_time_ns / 1e9) + " sec., preparation time: "
                    + std::to_string(node.execution_state->preparation_time_ns / 1e9) + " sec.)");
    }

    std::vector<IProcessor::Status> statuses;
    std::vector<IProcessor *> proc_list;
    statuses.reserve(graph.size());
    proc_list.reserve(graph.size());

    for (auto & proc : graph)
    {
        proc_list.emplace_back(proc.processor);
        statuses.emplace_back(proc.last_processor_status);
    }

    WriteBufferFromOwnString out;
    printPipeline(processors, statuses, out);
    out.finish();

    return out.str();
}

}