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-02 10:37

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	11.1k	std::ostream& operator<<(std::ostream& os, const FileBlock::State& value) {
35	11.1k	os << FileBlock::state_to_string(value);
36	11.1k	return os;
37	11.1k	}
38
39		FileBlock::FileBlock(const FileCacheKey& key, size_t size, BlockFileCache* mgr,
40		State download_state)
41	147k	: _block_range(key.offset, key.offset + size - 1),
42	147k	_download_state(download_state),
43	147k	_mgr(mgr),
44	147k	_key(key) {
45		/// On creation, file block state can be EMPTY, DOWNLOADED, SKIP_CACHE.
46	147k	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	147k	default: {
52	147k	break;
53	0	}
54	147k	}
55	147k	}
56
57	1.96M	FileBlock::State FileBlock::state() const {
58	1.96M	std::lock_guard block_lock(_mutex);
59	1.96M	return _download_state;
60	1.96M	}
61
62	894k	FileBlock::State FileBlock::state_unsafe() const {
63	894k	return _download_state;
64	894k	}
65
66	1.14M	uint64_t FileBlock::get_caller_id() {
67	1.14M	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.14M	id = static_cast<uint64_t>(pthread_self());
73	1.14M	#endif
74	1.14M	DCHECK(id != 0);
75	1.14M	return id;
76	1.14M	}
77
78	121k	uint64_t FileBlock::get_or_set_downloader() {
79	121k	std::lock_guard block_lock(_mutex);
80
81	121k	if (_downloader_id == 0 && _download_state != State::DOWNLOADED) {
82	120k	DCHECK(_download_state != State::DOWNLOADING);
83	120k	_downloader_id = get_caller_id();
84	120k	_download_state = State::DOWNLOADING;
85	120k	} 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	121k	return _downloader_id;
91	121k	}
92
93	24	void FileBlock::reset_downloader(std::lock_guard<std::mutex>& block_lock) {
94	24	DCHECK(_downloader_id != 0) << "There is no downloader";
95
96	24	DCHECK(get_caller_id() == _downloader_id) << "Downloader can be reset only by downloader";
97
98	24	reset_downloader_impl(block_lock);
99	24	}
100
101	24	void FileBlock::reset_downloader_impl(std::lock_guard<std::mutex>& block_lock) {
102	24	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	22	} else {
108	22	_downloaded_size = 0;
109	22	_download_state = State::EMPTY;
110	22	_downloader_id = 0;
111	22	}
112	24	}
113
114	120k	Status FileBlock::set_downloaded(std::lock_guard<std::mutex>& /* block_lock */) {
115	120k	DCHECK(_download_state != State::DOWNLOADED);
116	120k	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	120k	Status status = _mgr->_storage->finalize(_key, this->_block_range.size());
123	120k	if (status.ok()) [[likely]] {
124	120k	_download_state = State::DOWNLOADED;
125	120k	} else {
126	583	_download_state = State::EMPTY;
127	583	_downloaded_size = 0;
128	583	}
129	120k	_downloader_id = 0;
130	120k	return status;
131	120k	}
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	115k	bool FileBlock::is_downloader() const {
139	115k	std::lock_guard block_lock(_mutex);
140	115k	return get_caller_id() == _downloader_id;
141	115k	}
142
143	894k	bool FileBlock::is_downloader_impl(std::lock_guard<std::mutex>& /* block_lock */) const {
144	894k	return get_caller_id() == _downloader_id;
145	894k	}
146
147	120k	Status FileBlock::append(Slice data) {
148	120k	DCHECK(data.size != 0) << "Writing zero size is not allowed";
149	120k	RETURN_IF_ERROR(_mgr->_storage->append(_key, data));
150	120k	_downloaded_size += data.size;
151	120k	return Status::OK();
152	120k	}
153
154	120k	Status FileBlock::finalize() {
155	120k	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	120k	if (_downloaded_size != _block_range.size()) {
164	5.63k	SCOPED_CACHE_LOCK(_mgr->_mutex, _mgr);
165	5.63k	size_t old_size = _block_range.size();
166	5.63k	size_t new_size = _downloaded_size;
167	5.63k	DCHECK(new_size < old_size);
168	5.63k	_mgr->reset_range(_key.hash, _block_range.left, old_size, new_size, cache_lock);
169	5.63k	}
170	120k	std::lock_guard block_lock(_mutex);
171	120k	Status st = set_downloaded(block_lock);
172	120k	_cv.notify_all();
173	120k	return st;
174	120k	}
175
176	3.68M	Status FileBlock::read(Slice buffer, size_t read_offset) {
177	3.68M	return _mgr->_storage->read(_key, read_offset, buffer);
178	3.68M	}
179
180	43	Status FileBlock::change_cache_type(FileCacheType new_type) {
181	43	SCOPED_CACHE_LOCK(_mgr->_mutex, _mgr);
182	43	return change_cache_type_lock(new_type, cache_lock);
183	43	}
184
185		Status FileBlock::change_cache_type_lock(FileCacheType new_type,
186	44	std::lock_guard<std::mutex>& cache_lock) {
187	44	std::lock_guard block_lock(_mutex);
188
189	44	if (new_type == _key.meta.type) {
190	1	return Status::OK();
191	1	}
192	43	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	43	_mgr->change_cache_type(_key.hash, _block_range.left, new_type, cache_lock);
198	43	_key.meta.type = new_type;
199	43	return Status::OK();
200	43	}
201
202	4.54k	FileBlock::State FileBlock::wait() {
203	4.54k	std::unique_lock block_lock(_mutex);
204
205	4.54k	if (_downloader_id == 0) {
206	1	return _download_state;
207	1	}
208
209	4.53k	if (_download_state == State::DOWNLOADING) {
210	4.53k	DCHECK(_downloader_id != 0 && _downloader_id != get_caller_id());
211	4.53k	_cv.wait_for(block_lock, std::chrono::milliseconds(config::block_cache_wait_timeout_ms));
212	4.53k	}
213
214	4.53k	return _download_state;
215	4.54k	}
216
217	894k	void FileBlock::complete_unlocked(std::lock_guard<std::mutex>& block_lock) {
218	894k	if (is_downloader_impl(block_lock)) {
219	24	reset_downloader(block_lock);
220	24	_cv.notify_all();
221	24	}
222	894k	}
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	867k	FileBlock::State FileBlock::state_unlock(std::lock_guard<std::mutex>&) const {
241	867k	return _download_state;
242	867k	}
243
244	11.1k	std::string FileBlock::state_to_string(FileBlock::State state) {
245	11.1k	switch (state) {
246	11.1k	case FileBlock::State::DOWNLOADED:
247	11.1k	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	11.1k	}
258	11.1k	}
259
260	1	std::string FileBlock::get_cache_file() const {
261	1	return _mgr->_storage->get_local_file(this->_key);
262	1	}
263
264	873k	FileBlocksHolder::~FileBlocksHolder() {
265	1.76M	for (auto file_block_it = file_blocks.begin(); file_block_it != file_blocks.end();) {
266	894k	auto current_file_block_it = file_block_it;
267	894k	auto& file_block = *current_file_block_it;
268	894k	BlockFileCache* _mgr = file_block->_mgr;
269	894k	{
270	894k	bool should_remove = false;
271	894k	{
272	894k	std::lock_guard block_lock(file_block->_mutex);
273	894k	file_block->complete_unlocked(block_lock);
274	894k	if (file_block.use_count() == 2 &&
275	894k	(file_block->is_deleting() \|\|
276	663k	file_block->state_unlock(block_lock) == FileBlock::State::EMPTY)) {
277	24.1k	should_remove = true;
278	24.1k	}
279	894k	}
280	894k	if (should_remove) {
281	24.1k	SCOPED_CACHE_LOCK(_mgr->_mutex, _mgr);
282	24.1k	std::lock_guard block_lock(file_block->_mutex);
283	24.1k	if (file_block.use_count() == 2) {
284	24.1k	DCHECK(file_block->state_unlock(block_lock) != FileBlock::State::DOWNLOADING);
285		// one in cache, one in here
286	24.1k	if (file_block->is_deleting() \|\|
287	24.1k	file_block->state_unlock(block_lock) == FileBlock::State::EMPTY) {
288	24.1k	_mgr->remove(file_block, cache_lock, block_lock, false);
289	24.1k	}
290	24.1k	}
291	24.1k	}
292	894k	}
293	894k	file_block_it = file_blocks.erase(current_file_block_it);
294	894k	}
295	873k	}
296
297		} // namespace io
298		} // namespace doris