mirror/taglib
1
0
Fork 0
mirror of https://github.com/taglib/taglib.git synced 2026-08-14 06:17:00 -04:00
Code Issues Packages Projects Releases Wiki Activity

Fix data races in lazily initialized shared caches (#1400)

Browse Source 
Also added thread safety test.
This commit is contained in:
Frederik Seiffert
2026-08-07 14:48:50 +02:00
committed by GitHub
parent e547578ae8
commit 819bfce872
6 changed files with 239 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files
taglib/asf/asftag.cpp
+5 -4
View File
@@ -341,12 +341,13 @@ void ASF::Tag::removeUnsupportedProperties(const StringList &props)
PropertyMap ASF::Tag::setProperties(const PropertyMap &props)
{
static Map<String, String> reverseKeyMap;
if(reverseKeyMap.isEmpty()) {
static const Map<String, String> reverseKeyMap = [] {
Map<String, String> map;
for(const auto &[k, t] : keyTranslation) {
reverseKeyMap[t] = k;
map[t] = k;
}
}
return map;
}();
const PropertyMap origProps = properties();
for(const auto &[prop, _] : origProps) {
taglib/mpeg/id3v2/frames/textidentificationframe.cpp
+5 -4
View File
@@ -160,11 +160,12 @@ namespace
const KeyConversionMap &TextIdentificationFrame::involvedPeopleMap() // static
{
static KeyConversionMap m;
if(m.isEmpty()) {
static const KeyConversionMap m = [] {
KeyConversionMap map;
for(const auto &[o, t] : involvedPeople)
m.insert(t, o);
}
map.insert(t, o);
return map;
}();
return m;
}
taglib/mpeg/id3v2/id3v2framefactory.cpp
+5 -4
View File
@@ -370,12 +370,13 @@ void FrameFactory::rebuildAggregateFrames(ID3v2::Tag *tag) const
if(auto tipl =
dynamic_cast<TextIdentificationFrame *>(tag->frameList("TIPL").front())) {
if(StringList tiplValues = tipl->toStringList(); tiplValues.size() % 2 == 0) {
static StringList tiplKeys;
if(tiplKeys.isEmpty()) {
static const StringList tiplKeys = [] {
StringList keys;
for(const auto &kv : TextIdentificationFrame::involvedPeopleMap()) {
tiplKeys.append(kv.second);
keys.append(kv.second);
}
}
return keys;
}();
StringList tmclValues;
for(auto it = tiplValues.begin(); it != tiplValues.end();) {
const String involvement = *it;
taglib/riff/wav/infotag.cpp
+5 -4
View File
@@ -218,12 +218,13 @@ void RIFF::Info::Tag::removeUnsupportedProperties(const StringList &props)
PropertyMap RIFF::Info::Tag::setProperties(const PropertyMap &props)
{
static Map<String, ByteVector> idForPropertyKey;
if(idForPropertyKey.isEmpty()) {
static const Map<String, ByteVector> idForPropertyKey = [] {
Map<String, ByteVector> map;
for(const auto &[id, key] : propertyKeyForId) {
idForPropertyKey[key] = id;
map[key] = id;
}
}
return map;
}();
const PropertyMap origProps = properties();
for(const auto &[key, _] : origProps) {
tests/CMakeLists.txt
+11 -1
View File
@@ -179,5 +179,15 @@ IF(BUILD_BINDINGS)
ENDIF()
ADD_TEST(test_runner test_runner)
# Thread safety tests cover state which is lazily initialized once per process,
# so they have to run before anything else has touched it
ADD_EXECUTABLE(test_threadsafety main.cpp test_threadsafety.cpp)
TARGET_LINK_LIBRARIES(test_threadsafety tag ${CPPUNIT_LIBRARIES})
FIND_PACKAGE(Threads REQUIRED)
TARGET_LINK_LIBRARIES(test_threadsafety Threads::Threads)
ADD_TEST(test_threadsafety test_threadsafety)
ADD_CUSTOM_TARGET(check COMMAND ${CMAKE_CTEST_COMMAND} -V
DEPENDS test_runner)
DEPENDS test_runner test_threadsafety)
tests/test_threadsafety.cpp
+208
View File
@@ -0,0 +1,208 @@
/***************************************************************************
copyright : (C) 2026 by Frederik Seiffert
email : frederik@algoriddim.com
***************************************************************************/
/***************************************************************************
* This library is free software; you can redistribute it and/or modify *
* it under the terms of the GNU Lesser General Public License version *
* 2.1 as published by the Free Software Foundation. *
* *
* This library is distributed in the hope that it will be useful, but *
* WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
* Lesser General Public License for more details. *
* *
* You should have received a copy of the GNU Lesser General Public *
* License along with this library; if not, write to the Free Software *
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA *
* 02110-1301 USA *
* *
* Alternatively, this file is available under the Mozilla Public *
* License Version 1.1. You may obtain a copy of the License at *
* http://www.mozilla.org/MPL/ *
***************************************************************************/
#include <atomic>
#include <functional>
#include <stdexcept>
#include <thread>
#include <vector>
#include <cppunit/TestFixture.h>
#include <cppunit/extensions/HelperMacros.h>
#include "taglib_config.h"
#include "id3v2framefactory.h"
#include "id3v2synchdata.h"
#include "id3v2tag.h"
#include "mpegfile.h"
#include "tbytevector.h"
#include "tbytevectorstream.h"
#include "tstringlist.h"
#include "textidentificationframe.h"
#include "tpropertymap.h"
#ifdef TAGLIB_WITH_ASF
#include "asftag.h"
#endif
#ifdef TAGLIB_WITH_MP4
#include "mp4file.h"
#include "mp4tag.h"
#endif
#ifdef TAGLIB_WITH_RIFF
#include "infotag.h"
#endif
#include "plainfile.h"
#include "utils.h"
using namespace std;
using namespace TagLib;
class TestThreadSafety : public CppUnit::TestFixture
{
CPPUNIT_TEST_SUITE(TestThreadSafety);
CPPUNIT_TEST(testConcurrentLazyInitialization);
CPPUNIT_TEST_SUITE_END();
public:
static constexpr int threadCount = 8;
static int runConcurrently(const std::function<void()> &work)
{
constexpr int iterations = 25;
std::atomic<int> ready { 0 };
std::atomic<bool> go { false };
std::atomic<int> succeeded { 0 };
std::vector<std::thread> threads;
threads.reserve(threadCount);
for(int i = 0; i < threadCount; ++i) {
threads.emplace_back([&] {
++ready;
while(!go.load(std::memory_order_acquire)) {
std::this_thread::yield();
}
try {
for(int j = 0; j < iterations; ++j) {
work();
}
++succeeded;
}
catch(const std::exception &) {
// Counted as a failure by the caller.
}
});
}
while(ready.load() < threadCount) {
std::this_thread::yield();
}
go.store(true, std::memory_order_release);
for(auto &thread : threads) {
thread.join();
}
return succeeded.load();
}
static ByteVector id3v23TagWithIpls()
{
// Involvement/involvee pairs. "Producer" and "Engineer" are supported by
// the TIPL property map, "Guitar" and "Drums" are not, so
// rebuildAggregateFrames() moves the latter pairs into a new TMCL frame.
// Assembled rather than written as one escaped literal: in "\x00Artist",
// the escape would swallow the 'A' as a third hex digit.
const StringList involvements {
"Guitar", "Artist 1",
"Drums", "Artist 2",
"Producer", "Artist 3",
"Engineer", "Artist 4"
};
ByteVector fields(1, '\0'); // Latin-1 text encoding
for(unsigned int i = 0; i < involvements.size(); ++i) {
if(i > 0) {
fields.append('\0'); // NUL separated, no trailing NUL
}
fields.append(involvements[i].data(String::Latin1));
}
const ByteVector frame = ByteVector("IPLS")
+ ByteVector::fromUInt(fields.size())
+ ByteVector(2, '\0') // frame flags
+ fields;
return ByteVector("ID3") + ByteVector(1, '\x03') + ByteVector(2, '\0')
+ ID3v2::SynchData::fromUInt(frame.size())
+ frame;
}
void testConcurrentLazyInitialization()
{
const ByteVector id3v23Data = id3v23TagWithIpls();
CPPUNIT_ASSERT_EQUAL(threadCount, runConcurrently([] {
if(ID3v2::TextIdentificationFrame::involvedPeopleMap().size() != 5) {
throw std::runtime_error("unexpected involvedPeopleMap() contents");
}
}));
CPPUNIT_ASSERT_EQUAL(threadCount, runConcurrently([&id3v23Data] {
ByteVectorStream stream(id3v23Data);
MPEG::File file(&stream, false);
if(!file.hasID3v2Tag() || file.ID3v2Tag()->frameList("TMCL").size() != 1) {
throw std::runtime_error("IPLS was not migrated to TMCL");
}
}));
#ifdef TAGLIB_WITH_MP4
const ByteVector mp4Data = PlainFile(TEST_FILE_PATH_C("has-tags.m4a")).readAll();
CPPUNIT_ASSERT(!mp4Data.isEmpty());
CPPUNIT_ASSERT_EQUAL(threadCount, runConcurrently([&mp4Data] {
ByteVectorStream stream(mp4Data);
MP4::File file(&stream);
if(!file.isValid() || file.tag()->properties().isEmpty()) {
throw std::runtime_error("MP4 properties were not read");
}
}));
#endif
#ifdef TAGLIB_WITH_RIFF
CPPUNIT_ASSERT_EQUAL(threadCount, runConcurrently([] {
PropertyMap properties;
properties["TITLE"] = StringList("Title");
properties["ARTIST"] = StringList("Artist");
RIFF::Info::Tag tag;
if(!tag.setProperties(properties).isEmpty()) {
throw std::runtime_error("unexpected unsupported RIFF Info properties");
}
}));
#endif
#ifdef TAGLIB_WITH_ASF
CPPUNIT_ASSERT_EQUAL(threadCount, runConcurrently([] {
PropertyMap properties;
properties["TITLE"] = StringList("Title");
properties["ARTIST"] = StringList("Artist");
ASF::Tag tag;
if(!tag.setProperties(properties).isEmpty()) {
throw std::runtime_error("unexpected unsupported ASF properties");
}
}));
#endif
ByteVectorStream stream(id3v23Data);
MPEG::File file(&stream, false);
CPPUNIT_ASSERT(file.hasID3v2Tag());
CPPUNIT_ASSERT_EQUAL(1u, file.ID3v2Tag()->frameList("TMCL").size());
}
};
CPPUNIT_TEST_SUITE_REGISTRATION(TestThreadSafety);