yiguolei commented on code in PR #69635: URL: https://github.com/apache/doris/pull/69635#discussion_r4534585574
########## be/src/exec/spill/remote_spill_data_dir.h: ########## @@ -0,0 +1,104 @@ +// 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 <mutex> +#include <string> + +#include "exec/spill/spill_data_dir.h" + +namespace doris { +namespace io { +class RemoteFileSystem; +} // namespace io + +/// Spill store on the object storage of a cloud storage vault (spill_storage_type=s3). +/// +/// Object layout, relative to the vault prefix: +/// spill/{ip}_{port}/{query_id}/{spill file}/{part} +/// {ip}_{port} is the address this BE advertises (BackendOptions::get_localhost(), normally its +/// IP) and its heartbeat_service_port, the pair FE identifies a BE by, so several BEs on one +/// host get different directories and a key tells which BE wrote it and which query it belongs +/// to. The objects of a spill file are deleted when its SpillFile is destroyed, which happens +/// when the query is done with it; a deletion that failed is retried by the GC thread. Nothing +/// else deletes spill objects: what a BE that crashed left behind stays until an object +/// lifecycle rule of the bucket (expiring keys under <vault prefix>/spill/ and aborting +/// incomplete multipart uploads) removes it. +/// +/// The file system is resolved lazily by ensure_ready(): the storage vault may not be known +/// yet when BE starts. See select_vault_fs() for which vault is used. Every SpillFile keeps the +/// file system it was created on, so its objects are read and deleted on that vault even when +/// a later file is created on another one. +class RemoteSpillDataDir final : public SpillDataDir { +public: + /// @param vault_id storage vault ID, empty selects one automatically (see select_vault_fs()). + explicit RemoteSpillDataDir(std::string vault_id); + + /// The file system spill writes new files to: + /// 1. `vault_id` (spill_s3_storage_vault_id) when it is set; + /// 2. otherwise `latest_fs`, which only an instance without storage vaults has; + /// 3. otherwise the S3 storage vault with the largest ID (the newest one), so that + /// changing the default vault does not move spill. + /// nullptr when no such vault is known. + static std::shared_ptr<io::RemoteFileSystem> select_vault_fs( + const std::string& vault_id, const std::shared_ptr<io::RemoteFileSystem>& latest_fs); + + Status init() override; + + bool is_remote() const override { return true; } + + bool ready() const override { return _ready.load(std::memory_order_acquire); } + + /// Resolve the vault for a new file and return an immutable filesystem snapshot. Without + /// spill_s3_storage_vault_id every call selects again; existing files retain their FS. + Status ensure_ready(io::FileSystemSPtr* file_fs); + + /// Bind a file system directly for tests without a cloud storage engine. + void init_remote_fs(io::FileSystemSPtr fs, std::string endpoint); Review Comment: 或者问问大模型，这种ut 类的方法有没有更好的手段，比如在ut 里mock 一个类？ -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
