forked from continuwuation/rocksdb
befa6b8050
Summary: ... caused by public headers depending on build parameters (macro definitions). This change also adds a check under 'make check-headers' (already in CI) looking for potential future violations. I've audited the uses of '#if' in public headers and either * Eliminated them * Systematically excluded them because they are intentional or similar (details in comments in check-public-header.sh * Manually excluded them as being ODR-SAFE In the case of ROCKSDB_USING_THREAD_STATUS, there was no good reason for this to appear in public headers so I've replaced it with a static bool ThreadStatus::kEnabled. I considered getting rid of the ability to disable this code but some relatively recent PRs have been submitted for fixing that case. I've added a release note and updated one of the CI jobs to use this build configuration. (I didn't want to combine with some jobs like no_compression and status_checked because the interaction might limit what is checked. Pull Request resolved: https://github.com/facebook/rocksdb/pull/14096 Test Plan: manual 'make check-headers' + manual cmake as in new CI config + CI Reviewed By: jaykorean Differential Revision: D86241864 Pulled By: pdillinger fbshipit-source-id: d16addc9e3480706b174a006720a4def0740bf2e
31 lines
1.1 KiB
Bash
Executable file
31 lines
1.1 KiB
Bash
Executable file
#!/usr/bin/env bash
|
|
# Copyright (c) Meta Platforms, Inc. and affiliates. All Rights Reserved.
|
|
#
|
|
# Check for some simple mistakes in public headers (on the command line)
|
|
# that should prevent commit or push
|
|
|
|
BAD=""
|
|
|
|
# Look for potential for ODR violations caused by public headers depending on
|
|
# build parameters that could vary between RocksDB build and application build.
|
|
# * Cases like LUA, ROCKSDB_NAMESPACE, and ROCKSDB_ASSERT_STATUS_CHECKED are
|
|
# intentional, hard to avoid. (We expect definitions to change and the user
|
|
# should also.)
|
|
# * Cases like _WIN32, OS_WIN, and __cplusplus are essentially ODR-safe.
|
|
# * Cases like
|
|
# #ifdef BLAH // ODR-SAFE
|
|
# #undef BLAH
|
|
# #endif
|
|
# that should not cause ODR violations can be exempted with the ODR-SAFE
|
|
# marker recognized here.
|
|
|
|
grep -nHE '^#if' -- "$@" | grep -vE 'ROCKSDB_NAMESPACE|ROCKSDB_ASSERT_STATUS_CHECKED|LUA|_WIN32|OS_WIN|ODR-SAFE|__cplusplus|ROCKSDB_DLL|ROCKSDB_LIBRARY_EXPORTS'
|
|
if [ "$?" != "1" ]; then
|
|
echo "^^^^^ #if in public API could cause an ODR violation."
|
|
echo " Add // ODR-SAFE if verified safe."
|
|
BAD=1
|
|
fi
|
|
|
|
if [ "$BAD" ]; then
|
|
exit 1
|
|
fi
|