be/src/io/cache/remote_scan_cache_write_limiter.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 <gen_cpp/Types_types.h>

#include <atomic>
#include <cstdint>
#include <mutex>

namespace doris::io {

class RemoteScanCacheWriteLimiter {
public:
    RemoteScanCacheWriteLimiter(TUniqueId query_id, int64_t threshold_bytes);

    bool enabled() const { return _threshold_bytes >= 0; }
    bool remote_only_on_miss() const;
    bool try_admit_cache_write(int64_t bytes);

    int64_t admitted_data_bytes() const;
    int64_t threshold_bytes() const { return _threshold_bytes; }

private:
    const TUniqueId _query_id;
    const int64_t _threshold_bytes;
    mutable std::mutex _mutex;
    std::atomic<bool> _remote_only_on_miss {false};
    int64_t _admitted_data_bytes {0};
};

} // namespace doris::io