[ft] Serialize access to the static FreeType library (#6225)

FreeType requires face creation and destruction on a shared
FT_Library to be serialized. Protect the lazily-created static library,
its reference count, and its internally-owned faces with a lazy mutex.

Keep caller-owned FT_Library instances outside the new lock, and add a
multithreaded regression test for blob-backed faces and font funcs.

Tests: meson test -C build (272/272 passed)

Fixes: https://github.com/harfbuzz/harfbuzz/issues/6224
Assisted-by: OpenAI Codex <codex@openai.com>
This commit is contained in:
Behdad Esfahbod authored and GitHub committed 2026-08-31 12:19:10 -06:00
1 parent 5c21cb4647
commit 46644f885d
2 files changed
+136 -13

No files matched your search

+90 -13
View File
@@ -88,12 +88,15 @@
using hb_ft_advance_cache_t = hb_cache_t<16, 24, 8, false>;
static void _hb_ft_face_destroy_static (void *data);
struct hb_ft_font_t
{
int load_flags;
bool symbol; /* Whether selected cmap is symbol cmap. */
bool unref; /* Whether to destroy ft_face when done. */
bool transform; /* Whether to apply FT_Face's transform. */
bool static_library; /* Whether ft_face uses static_ft_library. */
mutable hb_mutex_t lock; /* Protects members below. */
FT_Face ft_face;
@@ -102,7 +105,7 @@ struct hb_ft_font_t
};
static hb_ft_font_t *
_hb_ft_font_create (FT_Face ft_face, bool symbol, bool unref)
_hb_ft_font_create (FT_Face ft_face, bool symbol, bool unref, bool static_library)
{
hb_ft_font_t *ft_font = (hb_ft_font_t *) hb_calloc (1, sizeof (hb_ft_font_t));
if (unlikely (!ft_font)) return nullptr;
@@ -111,6 +114,7 @@ _hb_ft_font_create (FT_Face ft_face, bool symbol, bool unref)
ft_font->ft_face = ft_face;
ft_font->symbol = symbol;
ft_font->unref = unref;
ft_font->static_library = static_library;
ft_font->load_flags = FT_LOAD_DEFAULT | FT_LOAD_NO_HINTING;
@@ -132,7 +136,12 @@ _hb_ft_font_destroy (void *data)
hb_ft_font_t *ft_font = (hb_ft_font_t *) data;
if (ft_font->unref)
_hb_ft_face_destroy (ft_font->ft_face);
{
if (ft_font->static_library)
_hb_ft_face_destroy_static (ft_font->ft_face);
else
_hb_ft_face_destroy (ft_font->ft_face);
}
ft_font->lock.fini ();
@@ -1097,11 +1106,12 @@ _hb_ft_get_font_funcs ()
}
static void
_hb_ft_font_set_funcs (hb_font_t *font, FT_Face ft_face, bool unref)
_hb_ft_font_set_funcs (hb_font_t *font, FT_Face ft_face, bool unref,
bool static_library = false)
{
bool symbol = ft_face->charmap && ft_face->charmap->encoding == FT_ENCODING_MS_SYMBOL;
hb_ft_font_t *ft_font = _hb_ft_font_create (ft_face, symbol, unref);
hb_ft_font_t *ft_font = _hb_ft_font_create (ft_face, symbol, unref, static_library);
if (unlikely (!ft_font)) return;
hb_font_set_funcs (font,
@@ -1501,6 +1511,31 @@ static FT_MemoryRec_ m =
};
static inline void free_static_ft_library ();
static inline void free_static_ft_library_mutex ();
static struct hb_ft_library_mutex_lazy_loader_t : hb_lazy_loader_t<hb_mutex_t,
hb_ft_library_mutex_lazy_loader_t>
{
static hb_mutex_t *create ()
{
hb_mutex_t *lock = (hb_mutex_t *) hb_calloc (1, sizeof (hb_mutex_t));
if (unlikely (!lock))
return nullptr;
lock = new (lock) hb_mutex_t;
hb_atexit (free_static_ft_library_mutex);
return lock;
}
static void destroy (hb_mutex_t *lock)
{
lock->~hb_mutex_t ();
hb_free (lock);
}
static hb_mutex_t *get_null ()
{
return nullptr;
}
} static_ft_library_mutex;
static struct hb_ft_library_lazy_loader_t : hb_lazy_loader_t<hb_remove_pointer<FT_Library>,
hb_ft_library_lazy_loader_t>
@@ -1528,15 +1563,26 @@ static struct hb_ft_library_lazy_loader_t : hb_lazy_loader_t<hb_remove_pointer<F
}
} static_ft_library;
static inline
void free_static_ft_library_mutex ()
{
static_ft_library_mutex.free_instance ();
}
static inline
void free_static_ft_library ()
{
hb_lock_t lock (static_ft_library_mutex.get_unconst ());
static_ft_library.free_instance ();
}
static FT_Library
reference_ft_library ()
{
hb_mutex_t *mutex = static_ft_library_mutex.get_unconst ();
if (unlikely (!mutex))
return nullptr;
hb_lock_t lock (mutex);
FT_Library l = static_ft_library.get_unconst ();
if (unlikely (FT_Reference_Library (l)))
{
@@ -1548,6 +1594,34 @@ reference_ft_library ()
static hb_user_data_key_t ft_library_key = {0};
static void
_hb_ft_face_destroy_static (void *data)
{
hb_lock_t lock (static_ft_library_mutex.get_unconst ());
FT_Done_Face ((FT_Face) data);
}
static FT_Error
new_ft_face (FT_Library ft_library,
const char *file_name,
unsigned int index,
FT_Face *ft_face)
{
hb_lock_t lock (static_ft_library_mutex.get_unconst ());
return FT_New_Face (ft_library, file_name, index, ft_face);
}
static FT_Error
new_ft_memory_face (FT_Library ft_library,
const FT_Byte *blob_data,
unsigned int blob_size,
unsigned int index,
FT_Face *ft_face)
{
hb_lock_t lock (static_ft_library_mutex.get_unconst ());
return FT_New_Memory_Face (ft_library, blob_data, blob_size, index, ft_face);
}
static void
finalize_ft_library (void *arg)
{
@@ -1558,6 +1632,7 @@ finalize_ft_library (void *arg)
static void
destroy_ft_library (void *arg)
{
hb_lock_t lock (static_ft_library_mutex.get_unconst ());
FT_Done_Library ((FT_Library) arg);
}
@@ -1590,14 +1665,15 @@ hb_ft_face_create_from_file_or_fail (const char *file_name,
}
FT_Face ft_face;
if (unlikely (FT_New_Face (ft_library,
if (unlikely (new_ft_face (ft_library,
file_name,
index,
&ft_face)))
return nullptr;
hb_face_t *face = hb_ft_face_create_referenced (ft_face);
FT_Done_Face (ft_face);
FT_Reference_Face (ft_face);
hb_face_t *face = hb_ft_face_create (ft_face, _hb_ft_face_destroy_static);
_hb_ft_face_destroy_static (ft_face);
ft_face->generic.data = ft_library;
ft_face->generic.finalizer = finalize_ft_library;
@@ -1649,15 +1725,16 @@ hb_ft_face_create_from_blob_or_fail (hb_blob_t *blob,
const char *blob_data = hb_blob_get_data (blob, &blob_size);
FT_Face ft_face;
if (unlikely (FT_New_Memory_Face (ft_library,
if (unlikely (new_ft_memory_face (ft_library,
(const FT_Byte *) blob_data,
blob_size,
index,
&ft_face)))
return nullptr;
hb_face_t *face = hb_ft_face_create_referenced (ft_face);
FT_Done_Face (ft_face);
FT_Reference_Face (ft_face);
hb_face_t *face = hb_ft_face_create (ft_face, _hb_ft_face_destroy_static);
_hb_ft_face_destroy_static (ft_face);
ft_face->generic.data = ft_library;
ft_face->generic.finalizer = finalize_ft_library;
@@ -1740,7 +1817,7 @@ hb_ft_font_set_funcs (hb_font_t *font)
}
FT_Face ft_face = nullptr;
if (unlikely (FT_New_Memory_Face (ft_library,
if (unlikely (new_ft_memory_face (ft_library,
(const FT_Byte *) blob_data,
blob_length,
hb_face_get_index (font->face),
@@ -1762,11 +1839,11 @@ hb_ft_font_set_funcs (hb_font_t *font)
if (unlikely (!hb_blob_set_user_data (blob, &ft_library_key, ft_library, destroy_ft_library, true)))
{
DEBUG_MSG (FT, font, "hb_blob_set_user_data() failed");
FT_Done_Face (ft_face);
_hb_ft_face_destroy_static (ft_face);
return;
}
_hb_ft_font_set_funcs (font, ft_face, true);
_hb_ft_font_set_funcs (font, ft_face, true, true);
hb_ft_font_set_load_flags (font, load_flags);
_hb_ft_hb_font_changed (font, ft_face);
+46
View File
@@ -206,6 +206,51 @@ found:
cleanup_freetype ();
}
static gpointer
create_static_ft_faces (gpointer data)
{
hb_blob_t *blob = (hb_blob_t *) data;
for (unsigned int i = 0; i < 100; i++)
{
hb_face_t *face = hb_ft_face_create_from_blob_or_fail (blob, 0);
g_assert_nonnull (face);
hb_font_t *font = hb_font_create (face);
hb_ft_font_set_funcs (font);
hb_font_destroy (font);
hb_face_destroy (face);
}
return NULL;
}
static void
test_static_ft_library_multithreaded (void)
{
hb_blob_t *blob;
GThread *threads[8];
#if GLIB_CHECK_VERSION(2,37,2)
char *path = g_test_build_filename (G_TEST_DIST, "fonts/adwaita.ttf", NULL);
#else
char *path = g_strdup ("fonts/adwaita.ttf");
#endif
blob = hb_blob_create_from_file_or_fail (path);
g_assert_nonnull (blob);
g_free (path);
for (unsigned int i = 0; i < G_N_ELEMENTS (threads); i++)
threads[i] = g_thread_new (NULL, create_static_ft_faces, blob);
for (unsigned int i = 0; i < G_N_ELEMENTS (threads); i++)
g_thread_join (threads[i]);
hb_blob_destroy (blob);
}
int
main (int argc, char **argv)
{
@@ -214,6 +259,7 @@ main (int argc, char **argv)
hb_test_add (test_native_ft_basic);
hb_test_add (test_native_ft_set_funcs_preserves_load_flags);
hb_test_add (test_native_ft_glyph_name_zero_size_probe);
hb_test_add (test_static_ft_library_multithreaded);
return hb_test_run ();
}