Files
Behdad EsfahbodandClaude Opus 5.5 a86ba5f203 [cairo] Remove work-budget accounting (#6602)
hb-cairo hands the actual rendering to cairo, so the work done per
paint operation (clip, gradient, compositing) is cairo's, not ours.
Any count we keep is a guess.  The guesses we had were not good:
022a9e475 charged each paint
(1 + clip + path segments) x max(weight, segments), with a weight of
up to 8192, against HB_BUDGET_GLYPH.  Real fonts blow through that.
For example, hb-view renders the Spain flag in Noto-COLRv1 (U+1F1EA
U+1F1F8) as a blank image, and about ten glyphs in that font go over.

Remove the budget accounting from hb-cairo:

  - Revert 022a9e475 "[cairo] Charge compositing operations to the
    glyph budget", with its test font and generator.
  - Revert 8f3ab5ab8 "[cairo] Share work across nested glyph
    rendering": the per-scaled-font hb_cairo_budget_t, the segment
    charges in the draw callbacks, and the set/get budget callbacks
    on the cairo draw and paint funcs.

Keep paint_color_glyph declining (fd8c9209b), so COLR paints nested
glyphs inline under the decycler and nesting limits of the walk in
progress.  Going through cairo_show_glyphs() again would bring back
the PaintColrGlyph cycle crash, which test_hb_cairo_color_glyph_cycle
covers.  Only the code comment loses its mention of work limits.

Testing: meson test -C build: 299 OK, 1 skipped.  The Spain flag
renders again, and the PaintColrGlyph cycle glyphs in
test_glyphs-glyf_colr_1.ttf render without crashing.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-09 13:00:15 -06:00

212 lines
6.8 KiB
C

/*
* Copyright © 2026 Behdad Esfahbod
*
* This is part of HarfBuzz, a text shaping library.
*
* Permission is hereby granted, without written agreement and without
* license or royalty fees, to use, copy, modify, and distribute this
* software and its documentation for any purpose, provided that the
* above copyright notice and the following two paragraphs appear in
* all copies of this software.
*
* IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
* DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
* ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
* IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
* DAMAGE.
*
* THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
* BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
* ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
* PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
*/
#include "hb-test.h"
#include <hb-cairo.h>
#if defined(__has_feature)
#if __has_feature(thread_sanitizer)
#define HB_TEST_CAIRO_TSAN 1
#endif
#endif
#if defined(__SANITIZE_THREAD__)
#define HB_TEST_CAIRO_TSAN 1
#endif
static void
test_hb_cairo_color_glyph_cycle (void)
{
#ifdef HB_TEST_CAIRO_TSAN
g_test_skip ("Cairo user-font rendering has a pre-existing lock-order inversion under TSan");
return;
#endif
/* Two COLRv1 glyphs that paint each other with PaintColrGlyph. The
* color_glyph callback used to show the nested glyph through cairo,
* re-entering hb_font_paint_glyph() without the cycle and depth
* guards of the paint walk in progress. */
hb_face_t *face = hb_test_open_font_file ("fonts/test_glyphs-glyf_colr_1.ttf");
hb_font_t *font = hb_font_create (face);
cairo_font_face_t *cairo_face = hb_cairo_font_face_create_for_font (font);
cairo_surface_t *surface = cairo_image_surface_create (CAIRO_FORMAT_ARGB32, 64, 64);
cairo_t *cr = cairo_create (surface);
cairo_set_font_face (cr, cairo_face);
cairo_set_font_size (cr, 30);
/* paintcolrglyph_cycle_first, paintcolrglyph_cycle_second */
for (hb_codepoint_t u = 0xF1100; u <= 0xF1101; u++)
{
hb_codepoint_t gid;
g_assert_true (hb_font_get_nominal_glyph (font, u, &gid));
cairo_glyph_t glyph = {gid, 0, 30};
cairo_show_glyphs (cr, &glyph, 1);
}
g_assert_cmpint (cairo_status (cr), ==, CAIRO_STATUS_SUCCESS);
g_assert_cmpint (cairo_surface_status (surface), ==, CAIRO_STATUS_SUCCESS);
cairo_destroy (cr);
cairo_surface_destroy (surface);
cairo_font_face_destroy (cairo_face);
hb_font_destroy (font);
hb_face_destroy (face);
}
static void
face_destroyed (void *user_data)
{
*(hb_bool_t *) user_data = 1;
}
static void
test_hb_cairo_face_lifecycle (void)
{
#ifdef HB_TEST_CAIRO_TSAN
g_test_skip ("Cairo user-font rendering has a pre-existing lock-order inversion under TSan");
return;
#endif
static hb_user_data_key_t key;
hb_bool_t destroyed = 0;
hb_face_t *face = hb_test_open_font_file ("fonts/Roboto-Regular.abc.ttf");
hb_face_set_user_data (face, &key, &destroyed, face_destroyed, 1);
cairo_font_face_t *cairo_face = hb_cairo_font_face_create_for_face (face);
hb_face_destroy (face);
cairo_surface_t *surface = cairo_image_surface_create (CAIRO_FORMAT_ARGB32, 64, 64);
cairo_t *cr = cairo_create (surface);
cairo_set_font_face (cr, cairo_face);
cairo_set_font_size (cr, 30);
cairo_glyph_t glyph = {1, 0, 0};
cairo_show_glyphs (cr, &glyph, 1);
g_assert_cmpint (cairo_status (cr), ==, CAIRO_STATUS_SUCCESS);
cairo_destroy (cr);
cairo_surface_destroy (surface);
cairo_font_face_destroy (cairo_face);
/* Cairo keeps unreferenced scaled fonts cached; flush them so the
* hb_font_t created for the scaled font, and with it the face, go away. */
cairo_debug_reset_static_data ();
g_assert_true (destroyed);
}
static void
test_hb_cairo_glyphs_from_buffer_clusters (void)
{
/* Non-monotone clusters come out of hb_shape() for some inputs
* (HB_BUFFER_CLUSTER_LEVEL_CHARACTERS, shaping that fails midway,
* shaper bugs). Cairo can only represent monotone clusters; make
* sure such buffers map to one cluster instead of aborting. */
static const struct {
hb_direction_t direction;
unsigned clusters[4];
unsigned num_clusters;
} tests[] = {
{HB_DIRECTION_LTR, {0, 1, 1, 3}, 3},
{HB_DIRECTION_RTL, {3, 1, 1, 0}, 3},
/* Monotone clusters exceeding text/character length or wrapping sign. */
{HB_DIRECTION_LTR, {0, 4, 8, 12}, 4},
{HB_DIRECTION_RTL, {12, 8, 4, 0}, 4},
{HB_DIRECTION_LTR, {0, 1, 2, 0x80000000u}, 4},
/* Not monotone. */
{HB_DIRECTION_LTR, {0, 2, 0, 0}, 1},
{HB_DIRECTION_LTR, {3, 1, 1, 0}, 1},
{HB_DIRECTION_RTL, {0, 0, 2, 0}, 1},
{HB_DIRECTION_RTL, {0, 1, 1, 3}, 1},
};
static const char * const strings[] = {
"abcd",
"\xce\xb1\xce\xb2\xce\xb3\xce\xb4", /* 4 2-byte Greek characters */
"\xf0\x9f\x98\x80\xf0\x9f\x98\x81\xf0\x9f\x98\x82\xf0\x9f\x98\x83", /* 4 4-byte emoji */
};
for (unsigned s = 0; s < G_N_ELEMENTS (strings); s++)
{
const char *utf8 = strings[s];
unsigned utf8_len = strlen (utf8);
/* Exact-sized allocation so ASan catches any OOB read beyond utf8_len. */
char *exact_utf8 = (char *) malloc (utf8_len);
memcpy (exact_utf8, utf8, utf8_len);
for (unsigned t = 0; t < G_N_ELEMENTS (tests); t++)
for (unsigned utf8_clusters = 0; utf8_clusters < 2; utf8_clusters++)
{
hb_buffer_t *buffer = hb_buffer_create ();
hb_buffer_set_direction (buffer, tests[t].direction);
for (unsigned i = 0; i < 4; i++)
hb_buffer_add (buffer, i, tests[t].clusters[i]);
cairo_glyph_t *glyphs = NULL;
unsigned num_glyphs = 0;
cairo_text_cluster_t *clusters = NULL;
unsigned num_clusters = 0;
cairo_text_cluster_flags_t cluster_flags;
hb_cairo_glyphs_from_buffer (buffer, utf8_clusters,
1., 1., 0., 0.,
exact_utf8, (int) utf8_len,
&glyphs, &num_glyphs,
&clusters, &num_clusters,
&cluster_flags);
g_assert_cmpuint (num_glyphs, ==, 4);
g_assert_cmpuint (num_clusters, ==, tests[t].num_clusters);
int total_bytes = 0, total_glyphs = 0;
for (unsigned i = 0; i < num_clusters; i++)
{
g_assert_cmpint (clusters[i].num_bytes, >=, 0);
g_assert_cmpint (clusters[i].num_glyphs, >, 0);
total_bytes += clusters[i].num_bytes;
total_glyphs += clusters[i].num_glyphs;
}
g_assert_cmpint (total_bytes, ==, (int) utf8_len);
g_assert_cmpint (total_glyphs, ==, 4);
cairo_glyph_free (glyphs);
cairo_text_cluster_free (clusters);
hb_buffer_destroy (buffer);
}
free (exact_utf8);
}
}
int
main (int argc, char **argv)
{
hb_test_init (&argc, &argv);
hb_test_add (test_hb_cairo_color_glyph_cycle);
hb_test_add (test_hb_cairo_face_lifecycle);
hb_test_add (test_hb_cairo_glyphs_from_buffer_clusters);
return hb_test_run ();
}