apache / apache/doris

[Bug] TSAN build fails with undefined symbol: BlockFileCache::get_cell<std::lock_guard<std::mutex>>

Open
#64,227 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Java
Stars
15.9k
Forks
3.9k
Avg merge
2d 23h
Merged PRs (30d)
520

Description

### Search before asking

- [X] I had searched in the [issues](https://github.com/apache/doris/issues?q=is%3Aissue) and found no similar issues.

### Version

master

### What's Wrong?

When building BE UT with TSAN, the linker reports an undefined symbol error:

```
ld.lld: error: undefined symbol: doris::io::FileBlockCell* doris::io::BlockFileCache::get_cell>(doris::io::UInt128Wrapper const&, unsigned long, T&)
>>> referenced by block_file_cache_test.cpp:2976 (./be/ut_build_TSAN/./be/test/io/cache/block_file_cache_test.cpp:2976)
>>> test/CMakeFiles/doris_be_test.dir/io/cache/block_file_cache_test.cpp.o:(doris::io::BlockFileCacheTest_late_holder_remove_skips_replaced_cache_cell_Test::TestBody())
>>> referenced by block_file_cache_test.cpp:2989 (./be/ut_build_TSAN/./be/test/io/cache/block_file_cache_test.cpp:2989)
>>> test/CMakeFiles/doris_be_test.dir/io/cache/block_file_cache_test.cpp.o:(doris::io::BlockFileCacheTest_late_holder_remove_skips_replaced_cache_cell_Test::TestBody())
clang++: error: linker command failed with exit code 1 (use -v to see invocation)
ninja: build stopped: subcommand failed.
```

### What You Expected?

BE UT should build and link successfully with TSAN enabled.

### How to Reproduce?

1. Build BE UT with TSAN: `bash build.sh --be --ut --tsan`
2. Linker fails with undefined symbol for `BlockFileCache::get_cell>`

### Root Cause

`BlockFileCache::get_cell` is a template function with `requires IsXLock` constraint, defined in `block_file_cache.cpp`. It lacks explicit template instantiation for `std::lock_guard`. In non-TSAN builds, the compiler may inline the template, masking the issue. TSAN builds disable inlining (instrumentation requires intercepting each function call), exposing the missing symbol.

The same pattern already exists for the `remove` template function at `block_file_cache.cpp:2515`:
```cpp
template void BlockFileCache::remove(FileBlockSPtr file_block,
std::lock_guard& cache_lock,
std::lock_guard& block_lock, bool sync);
```

And for `LRUQueue` templates in `file_cache_common.cpp:149-150`:
```cpp
template size_t LRUQueue::get_capacity(std::lock_guard& cache_lock) const;
template void LRUQueue::remove(Iterator queue_it, std::lock_guard& cache_lock);
```

`get_cell` is simply missing the same explicit instantiation.

### Are you willing to submit PR?

- [X] Yes I am willing to submit a PR!

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.