be/src/io/cache/file_block.cpp

Source
// 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.

#include "io/cache/file_block.h"

#include <glog/logging.h>
// IWYU pragma: no_include <bits/chrono.h>
#include <chrono> // IWYU pragma: keep
#include <sstream>
#include <string>
#include <thread>

#include "common/status.h"
#include "cpp/sync_point.h"
#include "io/cache/block_file_cache.h"

namespace doris {
namespace io {

std::ostream& operator<<(std::ostream& os, const FileBlock::State& value) {
    os << FileBlock::state_to_string(value);
    return os;
}

FileBlock::FileBlock(const FileCacheKey& key, size_t size, BlockFileCache* mgr,
                     State download_state)
        : _block_range(key.offset, key.offset + size - 1),
          _download_state(download_state),
          _mgr(mgr),
          _key(key) {
    /// On creation, file block state can be EMPTY, DOWNLOADED, SKIP_CACHE.
    switch (_download_state) {
    case State::DOWNLOADING: {
        DCHECK(false) << "Can create cell with either EMPTY, DOWNLOADED, SKIP_CACHE ";
        break;
    }
    default: {
        break;
    }
    }
}

FileBlock::State FileBlock::state() const {
    std::lock_guard block_lock(_mutex);
    return _download_state;
}

FileBlock::State FileBlock::state_unsafe() const {
    return _download_state;
}

uint64_t FileBlock::get_caller_id() {
    uint64_t id;
#if defined(__APPLE__)
    // On macOS, use pthread_threadid_np to get the thread ID
    pthread_threadid_np(nullptr, &id);
#else
    id = static_cast<uint64_t>(pthread_self());
#endif
    DCHECK(id != 0);
    return id;
}

uint64_t FileBlock::get_or_set_downloader() {
    std::lock_guard block_lock(_mutex);

    if (_downloader_id == 0 && _download_state != State::DOWNLOADED) {
        DCHECK(_download_state != State::DOWNLOADING);
        _downloader_id = get_caller_id();
        _download_state = State::DOWNLOADING;
    } else if (_downloader_id == get_caller_id()) {
        LOG(INFO) << "Attempt to set the same downloader for block " << range().to_string()
                  << " for the second time";
    }

    return _downloader_id;
}

void FileBlock::reset_downloader(std::lock_guard<std::mutex>& block_lock) {
    DCHECK(_downloader_id != 0) << "There is no downloader";

    DCHECK(get_caller_id() == _downloader_id) << "Downloader can be reset only by downloader";

    reset_downloader_impl(block_lock);
}

void FileBlock::reset_downloader_impl(std::lock_guard<std::mutex>& block_lock) {
    if (_downloaded_size == range().size()) {
        Status st = set_downloaded(block_lock);
        if (!st.ok()) {
            LOG(WARNING) << "reset downloader error" << st;
        }
    } else {
        _downloaded_size = 0;
        _download_state = State::EMPTY;
        _downloader_id = 0;
    }
}

Status FileBlock::set_downloaded(std::lock_guard<std::mutex>& /* block_lock */) {
    DCHECK(_download_state != State::DOWNLOADED);
    if (_downloaded_size == 0) {
        _download_state = State::EMPTY;
        _downloader_id = 0;
        return Status::InternalError("Try to set empty block {} as downloaded",
                                     _block_range.to_string());
    }
    Status status = _mgr->_storage->finalize(_key, this->_block_range.size());
    if (status.ok()) [[likely]] {
        _download_state = State::DOWNLOADED;
    } else {
        _download_state = State::EMPTY;
        _downloaded_size = 0;
    }
    _downloader_id = 0;
    return status;
}

uint64_t FileBlock::get_downloader() const {
    std::lock_guard block_lock(_mutex);
    return _downloader_id;
}

bool FileBlock::is_downloader() const {
    std::lock_guard block_lock(_mutex);
    return get_caller_id() == _downloader_id;
}

bool FileBlock::is_downloader_impl(std::lock_guard<std::mutex>& /* block_lock */) const {
    return get_caller_id() == _downloader_id;
}

Status FileBlock::append(Slice data) {
    DCHECK(data.size != 0) << "Writing zero size is not allowed";
    RETURN_IF_ERROR(_mgr->_storage->append(_key, data));
    _downloaded_size += data.size;
    return Status::OK();
}

Status FileBlock::finalize() {
    if (_downloaded_size == 0) {
        std::lock_guard block_lock(_mutex);
        _download_state = State::EMPTY;
        _downloader_id = 0;
        _cv.notify_all();
        return Status::InternalError("Try to finalize an empty file block {}",
                                     _block_range.to_string());
    }
    if (_downloaded_size != _block_range.size()) {
        SCOPED_CACHE_LOCK(_mgr->_mutex, _mgr);
        size_t old_size = _block_range.size();
        size_t new_size = _downloaded_size;
        DCHECK(new_size < old_size);
        _mgr->reset_range(_key.hash, _block_range.left, old_size, new_size, cache_lock);
    }
    std::lock_guard block_lock(_mutex);
    Status st = set_downloaded(block_lock);
    _cv.notify_all();
    return st;
}

Status FileBlock::read(Slice buffer, size_t read_offset) {
    return _mgr->_storage->read(_key, read_offset, buffer);
}

Status FileBlock::change_cache_type(FileCacheType new_type) {
    SCOPED_CACHE_LOCK(_mgr->_mutex, _mgr);
    return change_cache_type_lock(new_type, cache_lock);
}

Status FileBlock::change_cache_type_lock(FileCacheType new_type,
                                         std::lock_guard<std::mutex>& cache_lock) {
    std::lock_guard block_lock(_mutex);

    if (new_type == _key.meta.type) {
        return Status::OK();
    }
    if (_download_state == State::DOWNLOADED) {
        Status st;
        TEST_SYNC_POINT_CALLBACK("FileBlock::change_cache_type", &st);
        RETURN_IF_ERROR(_mgr->_storage->change_key_meta_type(_key, new_type, _block_range.size()));
    }
    _mgr->change_cache_type(_key.hash, _block_range.left, new_type, cache_lock);
    _key.meta.type = new_type;
    return Status::OK();
}

FileBlock::State FileBlock::wait() {
    std::unique_lock block_lock(_mutex);

    if (_downloader_id == 0) {
        return _download_state;
    }

    if (_download_state == State::DOWNLOADING) {
        DCHECK(_downloader_id != 0 && _downloader_id != get_caller_id());
        _cv.wait_for(block_lock, std::chrono::milliseconds(config::block_cache_wait_timeout_ms));
    }

    return _download_state;
}

void FileBlock::complete_unlocked(std::lock_guard<std::mutex>& block_lock) {
    if (is_downloader_impl(block_lock)) {
        reset_downloader(block_lock);
        _cv.notify_all();
    }
}

std::string FileBlock::get_info_for_log() const {
    std::lock_guard block_lock(_mutex);
    return get_info_for_log_impl(block_lock);
}

std::string FileBlock::get_info_for_log_impl(std::lock_guard<std::mutex>& block_lock) const {
    std::stringstream info;
    info << "File block: " << range().to_string() << ", ";
    info << "state: " << state_to_string(_download_state) << ", ";
    info << "size: " << _block_range.size() << ", ";
    info << "downloader id: " << _downloader_id << ", ";
    info << "caller id: " << get_caller_id();

    return info.str();
}

FileBlock::State FileBlock::state_unlock(std::lock_guard<std::mutex>&) const {
    return _download_state;
}

std::string FileBlock::state_to_string(FileBlock::State state) {
    switch (state) {
    case FileBlock::State::DOWNLOADED:
        return "DOWNLOADED";
    case FileBlock::State::EMPTY:
        return "EMPTY";
    case FileBlock::State::DOWNLOADING:
        return "DOWNLOADING";
    case FileBlock::State::SKIP_CACHE:
        return "SKIP_CACHE";
    default:
        DCHECK(false);
        return "";
    }
}

std::string FileBlock::get_cache_file() const {
    return _mgr->_storage->get_local_file(this->_key);
}

FileBlocksHolder::~FileBlocksHolder() {
    for (auto file_block_it = file_blocks.begin(); file_block_it != file_blocks.end();) {
        auto current_file_block_it = file_block_it;
        auto& file_block = *current_file_block_it;
        BlockFileCache* _mgr = file_block->_mgr;
        {
            bool should_remove = false;
            {
                std::lock_guard block_lock(file_block->_mutex);
                file_block->complete_unlocked(block_lock);
                if (file_block.use_count() == 2 &&
                    (file_block->is_deleting() ||
                     file_block->state_unlock(block_lock) == FileBlock::State::EMPTY)) {
                    should_remove = true;
                }
            }
            if (should_remove) {
                SCOPED_CACHE_LOCK(_mgr->_mutex, _mgr);
                std::lock_guard block_lock(file_block->_mutex);
                if (file_block.use_count() == 2) {
                    DCHECK(file_block->state_unlock(block_lock) != FileBlock::State::DOWNLOADING);
                    // one in cache, one in here
                    if (file_block->is_deleting() ||
                        file_block->state_unlock(block_lock) == FileBlock::State::EMPTY) {
                        _mgr->remove(file_block, cache_lock, block_lock, false);
                    }
                }
            }
        }
        file_block_it = file_blocks.erase(current_file_block_it);
    }
}

} // namespace io
} // namespace doris

Coverage Report

Created: 2026-06-08 10:50

Line	Count	Source
1		// Licensed to the Apache Software Foundation (ASF) under one
2		// or more contributor license agreements. See the NOTICE file
3		// distributed with this work for additional information
4		// regarding copyright ownership. The ASF licenses this file
5		// to you under the Apache License, Version 2.0 (the
6		// "License"); you may not use this file except in compliance
7		// with the License. You may obtain a copy of the License at
8		//
9		// http://www.apache.org/licenses/LICENSE-2.0
10		//
11		// Unless required by applicable law or agreed to in writing,
12		// software distributed under the License is distributed on an
13		// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14		// KIND, either express or implied. See the License for the
15		// specific language governing permissions and limitations
16		// under the License.
17
18		#include "io/cache/file_block.h"
19
20		#include <glog/logging.h>
21		// IWYU pragma: no_include <bits/chrono.h>
22		#include <chrono> // IWYU pragma: keep
23		#include <sstream>
24		#include <string>
25		#include <thread>
26
27		#include "common/status.h"
28		#include "cpp/sync_point.h"
29		#include "io/cache/block_file_cache.h"
30
31		namespace doris {
32		namespace io {
33
34	105k	std::ostream& operator<<(std::ostream& os, const FileBlock::State& value) {
35	105k	os << FileBlock::state_to_string(value);
36	105k	return os;
37	105k	}
38
39		FileBlock::FileBlock(const FileCacheKey& key, size_t size, BlockFileCache* mgr,
40		State download_state)
41	189k	: _block_range(key.offset, key.offset + size - 1),
42	189k	_download_state(download_state),
43	189k	_mgr(mgr),
44	189k	_key(key) {
45		/// On creation, file block state can be EMPTY, DOWNLOADED, SKIP_CACHE.
46	189k	switch (_download_state) {
47	0	case State::DOWNLOADING: {
48	0	DCHECK(false) << "Can create cell with either EMPTY, DOWNLOADED, SKIP_CACHE ";
49	0	break;
50	0	}
51	189k	default: {
52	189k	break;
53	0	}
54	189k	}
55	189k	}
56
57	3.85M	FileBlock::State FileBlock::state() const {
58	3.85M	std::lock_guard block_lock(_mutex);
59	3.85M	return _download_state;
60	3.85M	}
61
62	1.03M	FileBlock::State FileBlock::state_unsafe() const {
63	1.03M	return _download_state;
64	1.03M	}
65
66	1.27M	uint64_t FileBlock::get_caller_id() {
67	1.27M	uint64_t id;
68		#if defined(__APPLE__)
69		// On macOS, use pthread_threadid_np to get the thread ID
70		pthread_threadid_np(nullptr, &id);
71		#else
72	1.27M	id = static_cast<uint64_t>(pthread_self());
73	1.27M	#endif
74	1.27M	DCHECK(id != 0);
75	1.27M	return id;
76	1.27M	}
77
78	114k	uint64_t FileBlock::get_or_set_downloader() {
79	114k	std::lock_guard block_lock(_mutex);
80
81	114k	if (_downloader_id == 0 && _download_state != State::DOWNLOADED) {
82	114k	DCHECK(_download_state != State::DOWNLOADING);
83	114k	_downloader_id = get_caller_id();
84	114k	_download_state = State::DOWNLOADING;
85	114k	} else if (_downloader_id == get_caller_id()) {
86	4	LOG(INFO) << "Attempt to set the same downloader for block " << range().to_string()
87	4	<< " for the second time";
88	4	}
89
90	114k	return _downloader_id;
91	114k	}
92
93	35	void FileBlock::reset_downloader(std::lock_guard<std::mutex>& block_lock) {
94	35	DCHECK(_downloader_id != 0) << "There is no downloader";
95
96	35	DCHECK(get_caller_id() == _downloader_id) << "Downloader can be reset only by downloader";
97
98	35	reset_downloader_impl(block_lock);
99	35	}
100
101	35	void FileBlock::reset_downloader_impl(std::lock_guard<std::mutex>& block_lock) {
102	35	if (_downloaded_size == range().size()) {
103	2	Status st = set_downloaded(block_lock);
104	2	if (!st.ok()) {
105	1	LOG(WARNING) << "reset downloader error" << st;
106	1	}
107	33	} else {
108	33	_downloaded_size = 0;
109	33	_download_state = State::EMPTY;
110	33	_downloader_id = 0;
111	33	}
112	35	}
113
114	114k	Status FileBlock::set_downloaded(std::lock_guard<std::mutex>& /* block_lock */) {
115	114k	DCHECK(_download_state != State::DOWNLOADED);
116	114k	if (_downloaded_size == 0) {
117	1	_download_state = State::EMPTY;
118	1	_downloader_id = 0;
119	1	return Status::InternalError("Try to set empty block {} as downloaded",
120	1	_block_range.to_string());
121	1	}
122	114k	Status status = _mgr->_storage->finalize(_key, this->_block_range.size());
123	114k	if (status.ok()) [[likely]] {
124	113k	_download_state = State::DOWNLOADED;
125	113k	} else {
126	1.25k	_download_state = State::EMPTY;
127	1.25k	_downloaded_size = 0;
128	1.25k	}
129	114k	_downloader_id = 0;
130	114k	return status;
131	114k	}
132
133	16	uint64_t FileBlock::get_downloader() const {
134	16	std::lock_guard block_lock(_mutex);
135	16	return _downloader_id;
136	16	}
137
138	109k	bool FileBlock::is_downloader() const {
139	109k	std::lock_guard block_lock(_mutex);
140	109k	return get_caller_id() == _downloader_id;
141	109k	}
142
143	1.03M	bool FileBlock::is_downloader_impl(std::lock_guard<std::mutex>& /* block_lock */) const {
144	1.03M	return get_caller_id() == _downloader_id;
145	1.03M	}
146
147	114k	Status FileBlock::append(Slice data) {
148	114k	DCHECK(data.size != 0) << "Writing zero size is not allowed";
149	114k	RETURN_IF_ERROR(_mgr->_storage->append(_key, data));
150	114k	_downloaded_size += data.size;
151	114k	return Status::OK();
152	114k	}
153
154	114k	Status FileBlock::finalize() {
155	114k	if (_downloaded_size == 0) {
156	1	std::lock_guard block_lock(_mutex);
157	1	_download_state = State::EMPTY;
158	1	_downloader_id = 0;
159	1	_cv.notify_all();
160	1	return Status::InternalError("Try to finalize an empty file block {}",
161	1	_block_range.to_string());
162	1	}
163	114k	if (_downloaded_size != _block_range.size()) {
164	5.52k	SCOPED_CACHE_LOCK(_mgr->_mutex, _mgr);
165	5.52k	size_t old_size = _block_range.size();
166	5.52k	size_t new_size = _downloaded_size;
167	5.52k	DCHECK(new_size < old_size);
168	5.52k	_mgr->reset_range(_key.hash, _block_range.left, old_size, new_size, cache_lock);
169	5.52k	}
170	114k	std::lock_guard block_lock(_mutex);
171	114k	Status st = set_downloaded(block_lock);
172	114k	_cv.notify_all();
173	114k	return st;
174	114k	}
175
176	23.6M	Status FileBlock::read(Slice buffer, size_t read_offset) {
177	23.6M	return _mgr->_storage->read(_key, read_offset, buffer);
178	23.6M	}
179
180	42	Status FileBlock::change_cache_type(FileCacheType new_type) {
181	42	SCOPED_CACHE_LOCK(_mgr->_mutex, _mgr);
182	42	return change_cache_type_lock(new_type, cache_lock);
183	42	}
184
185		Status FileBlock::change_cache_type_lock(FileCacheType new_type,
186	43	std::lock_guard<std::mutex>& cache_lock) {
187	43	std::lock_guard block_lock(_mutex);
188
189	43	if (new_type == _key.meta.type) {
190	1	return Status::OK();
191	1	}
192	42	if (_download_state == State::DOWNLOADED) {
193	6	Status st;
194	6	TEST_SYNC_POINT_CALLBACK("FileBlock::change_cache_type", &st);
195	6	RETURN_IF_ERROR(_mgr->_storage->change_key_meta_type(_key, new_type, _block_range.size()));
196	6	}
197	42	_mgr->change_cache_type(_key.hash, _block_range.left, new_type, cache_lock);
198	42	_key.meta.type = new_type;
199	42	return Status::OK();
200	42	}
201
202	6.01k	FileBlock::State FileBlock::wait() {
203	6.01k	std::unique_lock block_lock(_mutex);
204
205	6.01k	if (_downloader_id == 0) {
206	1	return _download_state;
207	1	}
208
209	6.01k	if (_download_state == State::DOWNLOADING) {
210	6.01k	DCHECK(_downloader_id != 0 && _downloader_id != get_caller_id());
211	6.01k	_cv.wait_for(block_lock, std::chrono::milliseconds(config::block_cache_wait_timeout_ms));
212	6.01k	}
213
214	6.01k	return _download_state;
215	6.01k	}
216
217	1.03M	void FileBlock::complete_unlocked(std::lock_guard<std::mutex>& block_lock) {
218	1.03M	if (is_downloader_impl(block_lock)) {
219	35	reset_downloader(block_lock);
220	35	_cv.notify_all();
221	35	}
222	1.03M	}
223
224	1	std::string FileBlock::get_info_for_log() const {
225	1	std::lock_guard block_lock(_mutex);
226	1	return get_info_for_log_impl(block_lock);
227	1	}
228
229	1	std::string FileBlock::get_info_for_log_impl(std::lock_guard<std::mutex>& block_lock) const {
230	1	std::stringstream info;
231	1	info << "File block: " << range().to_string() << ", ";
232	1	info << "state: " << state_to_string(_download_state) << ", ";
233	1	info << "size: " << _block_range.size() << ", ";
234	1	info << "downloader id: " << _downloader_id << ", ";
235	1	info << "caller id: " << get_caller_id();
236
237	1	return info.str();
238	1	}
239
240	837k	FileBlock::State FileBlock::state_unlock(std::lock_guard<std::mutex>&) const {
241	837k	return _download_state;
242	837k	}
243
244	105k	std::string FileBlock::state_to_string(FileBlock::State state) {
245	105k	switch (state) {
246	105k	case FileBlock::State::DOWNLOADED:
247	105k	return "DOWNLOADED";
248	2	case FileBlock::State::EMPTY:
249	2	return "EMPTY";
250	2	case FileBlock::State::DOWNLOADING:
251	2	return "DOWNLOADING";
252	1	case FileBlock::State::SKIP_CACHE:
253	1	return "SKIP_CACHE";
254	0	default:
255	0	DCHECK(false);
256	0	return "";
257	105k	}
258	105k	}
259
260	0	std::string FileBlock::get_cache_file() const {
261	0	return _mgr->_storage->get_local_file(this->_key);
262	0	}
263
264	1.01M	FileBlocksHolder::~FileBlocksHolder() {
265	2.04M	for (auto file_block_it = file_blocks.begin(); file_block_it != file_blocks.end();) {
266	1.03M	auto current_file_block_it = file_block_it;
267	1.03M	auto& file_block = *current_file_block_it;
268	1.03M	BlockFileCache* _mgr = file_block->_mgr;
269	1.03M	{
270	1.03M	bool should_remove = false;
271	1.03M	{
272	1.03M	std::lock_guard block_lock(file_block->_mutex);
273	1.03M	file_block->complete_unlocked(block_lock);
274	1.03M	if (file_block.use_count() == 2 &&
275	1.03M	(file_block->is_deleting() \|\|
276	640k	file_block->state_unlock(block_lock) == FileBlock::State::EMPTY)) {
277	23.6k	should_remove = true;
278	23.6k	}
279	1.03M	}
280	1.03M	if (should_remove) {
281	23.6k	SCOPED_CACHE_LOCK(_mgr->_mutex, _mgr);
282	23.6k	std::lock_guard block_lock(file_block->_mutex);
283	23.6k	if (file_block.use_count() == 2) {
284	23.6k	DCHECK(file_block->state_unlock(block_lock) != FileBlock::State::DOWNLOADING);
285		// one in cache, one in here
286	23.6k	if (file_block->is_deleting() \|\|
287	23.6k	file_block->state_unlock(block_lock) == FileBlock::State::EMPTY) {
288	23.6k	_mgr->remove(file_block, cache_lock, block_lock, false);
289	23.6k	}
290	23.6k	}
291	23.6k	}
292	1.03M	}
293	1.03M	file_block_it = file_blocks.erase(current_file_block_it);
294	1.03M	}
295	1.01M	}
296
297		} // namespace io
298		} // namespace doris