be/src/runtime/workload_management/cpu_context.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 "common/factory_creator.h"
#include "runtime/workload_group/workload_group.h"
#include "util/runtime_profile.h"

namespace doris {
#include "common/compile_check_begin.h"

class ResourceContext;

class CPUContext : public std::enable_shared_from_this<CPUContext> {
    ENABLE_FACTORY_CREATOR(CPUContext);

public:
    /*
    * 1. operate them thread-safe.
    * 2. all tasks are unified.
    * 3. should not be operated frequently, use local variables to update Counter.
    */
    struct Stats {
        RuntimeProfile::Counter* cpu_cost_ms_counter_;

        RuntimeProfile* profile() { return profile_.get(); }
        void init_profile() {
            profile_ = std::make_unique<RuntimeProfile>("MemoryContext");
            cpu_cost_ms_counter_ = ADD_COUNTER(profile_, "RevokeWaitTimeMs", TUnit::TIME_MS);
        }
        std::string debug_string() { return profile_->pretty_print(); }

    private:
        std::unique_ptr<RuntimeProfile> profile_;
    };

    CPUContext() { stats_.init_profile(); }
    virtual ~CPUContext() = default;

    RuntimeProfile* stats_profile() { return stats_.profile(); }

    int64_t cpu_cost_ms() const { return stats_.cpu_cost_ms_counter_->value(); }

    void update_cpu_cost_ms(int64_t delta) const;

    // Bind current thread to cgroup, only some load thread should do this.
    void bind_workload_group() {
        // TODO: Call workload group method to bind current thread to cgroup
    }

protected:
    friend class ResourceContext;

    void set_resource_ctx(ResourceContext* resource_ctx) { resource_ctx_ = resource_ctx; }

    Stats stats_;
    ResourceContext* resource_ctx_ {nullptr};
};

#include "common/compile_check_end.h"
} // namespace doris