Sebastian Dröge 0ee18781f9 gst: Add GstIdStr for holding structure names and field names
This is an efficient string storage for short strings without heap allocations,
and falling back to the heap for bigger allocations. Almost all structure fields
and structure names in use nowadays are short enough to not require a heap
allocation.

As structure names and fields are sometimes dynamically created, storing them in
a GQuark can create a memory leak and potentially a DoS attack by continously
triggering creating of new quarks.

Thanks to Tim for coming up with the name!

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/7432>
2024-09-26 19:21:29 +03:00

209 lines
7.1 KiB
C

/* GStreamer
*
* unit test for GstIdStr
*
* Copyright (C) 2024 Sebastian Dröge <sebastian@centricular.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* 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
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include <gst/gst.h>
#include <gst/check/gstcheck.h>
#include "gst/gstidstr-private.h"
#define GST_ID_STR_PRIVATE(s) ((GstIdStrPrivate *)s)
GST_START_TEST (test_init)
{
GstIdStr s = GST_ID_STR_INIT;
GstIdStr s2 = GST_ID_STR_INIT;
const gchar short_without_nul[] =
{ 'H', 'e', 'l', 'l', 'o', ',', ' ', 'W', 'o', 'r', 'l', 'd', '!' };
const gchar long_without_nul[] =
{ 'H', 'e', 'l', 'l', 'o', ',', ' ', 'W', 'o', 'r', 'l', 'd', '!', ' ',
'G', 'o', 'o', 'd', 'b', 'y', 'e', ',', ' ', 'W', 'o', 'r', 'l', 'd',
'!'
};
fail_unless_equals_string (gst_id_str_as_str (&s), "");
fail_unless_equals_int (gst_id_str_get_len (&s), 0);
// Should be stack allocated
gst_id_str_set (&s, "Hello, World!");
fail_unless_equals_int (GST_ID_STR_PRIVATE (&s)->s.string_type.t, 0);
fail_unless_equals_string (gst_id_str_as_str (&s), "Hello, World!");
fail_unless_equals_int (gst_id_str_get_len (&s), 13);
gst_id_str_set_with_len (&s2, short_without_nul, sizeof (short_without_nul));
fail_unless_equals_int (GST_ID_STR_PRIVATE (&s2)->s.string_type.t, 0);
fail_unless_equals_string (gst_id_str_as_str (&s2), "Hello, World!");
fail_unless (gst_id_str_is_equal (&s, &s2));
fail_unless_equals_int (gst_id_str_get_len (&s2), 13);
// Should become the empty string again
gst_id_str_clear (&s);
fail_unless_equals_string (gst_id_str_as_str (&s), "");
fail_unless_equals_int (gst_id_str_get_len (&s), 0);
// Should be heap allocated
gst_id_str_set (&s, "Hello, World! Goodbye, World!");
fail_unless_equals_int (GST_ID_STR_PRIVATE (&s)->s.string_type.t, 1);
fail_unless_equals_string (gst_id_str_as_str (&s),
"Hello, World! Goodbye, World!");
fail_unless_equals_int (gst_id_str_get_len (&s), 29);
gst_id_str_set_with_len (&s2, long_without_nul, sizeof (long_without_nul));
fail_unless_equals_int (GST_ID_STR_PRIVATE (&s2)->s.string_type.t, 1);
fail_unless_equals_string (gst_id_str_as_str (&s2),
"Hello, World! Goodbye, World!");
fail_unless (gst_id_str_is_equal (&s, &s2));
fail_unless_equals_int (gst_id_str_get_len (&s2), 29);
// Should become the empty string again
gst_id_str_clear (&s);
fail_unless_equals_string (gst_id_str_as_str (&s), "");
fail_unless_equals_int (gst_id_str_get_len (&s), 0);
gst_id_str_clear (&s2);
fail_unless_equals_string (gst_id_str_as_str (&s2), "");
fail_unless_equals_int (gst_id_str_get_len (&s2), 0);
}
GST_END_TEST;
GST_START_TEST (test_alloc)
{
GstIdStr *s = gst_id_str_new ();
GstIdStr *copy;
fail_unless_equals_string (gst_id_str_as_str (s), "");
// Should be stack allocated
gst_id_str_set (s, "Hello, World!");
fail_unless_equals_int (GST_ID_STR_PRIVATE (s)->s.string_type.t, 0);
fail_unless_equals_string (gst_id_str_as_str (s), "Hello, World!");
// Should be a full copy
copy = gst_id_str_copy (s);
fail_unless_equals_int (GST_ID_STR_PRIVATE (copy)->s.string_type.t, 0);
fail_unless_equals_string (gst_id_str_as_str (copy), "Hello, World!");
// Strings are the same, but pointers should be different because the strings should be inlined
fail_unless_equals_string (gst_id_str_as_str (s), gst_id_str_as_str (copy));
fail_unless (gst_id_str_as_str (s) != gst_id_str_as_str (copy));
gst_id_str_free (copy);
// Should become the empty string again
gst_id_str_clear (s);
fail_unless_equals_string (gst_id_str_as_str (s), "");
// Should be heap allocated
gst_id_str_set (s, "Hello, World! Goodbye, World!");
fail_unless_equals_int (GST_ID_STR_PRIVATE (s)->s.string_type.t, 1);
fail_unless_equals_string (gst_id_str_as_str (s),
"Hello, World! Goodbye, World!");
// Should be a full copy
copy = gst_id_str_copy (s);
fail_unless_equals_int (GST_ID_STR_PRIVATE (copy)->s.string_type.t, 1);
fail_unless_equals_string (gst_id_str_as_str (copy),
"Hello, World! Goodbye, World!");
gst_id_str_free (copy);
// Should be stored by pointer but not heap allocated
gst_id_str_set_static_str (s, "Hello, World! Goodbye, World!");
fail_unless_equals_int (GST_ID_STR_PRIVATE (s)->s.string_type.t, 2);
fail_unless_equals_string (gst_id_str_as_str (s),
"Hello, World! Goodbye, World!");
// Should be a shallow copy because it's a static string
copy = gst_id_str_copy (s);
fail_unless_equals_int (GST_ID_STR_PRIVATE (copy)->s.string_type.t, 2);
fail_unless_equals_string (gst_id_str_as_str (copy),
"Hello, World! Goodbye, World!");
fail_unless_equals_pointer (GST_ID_STR_PRIVATE (copy)->s.pointer_string.s,
GST_ID_STR_PRIVATE (s)->s.pointer_string.s);
gst_id_str_free (copy);
// Should become the empty string again
gst_id_str_clear (s);
fail_unless_equals_string (gst_id_str_as_str (s), "");
gst_id_str_free (s);
}
GST_END_TEST;
GST_START_TEST (test_compare)
{
GstIdStr s1 = GST_ID_STR_INIT;
GstIdStr s2 = GST_ID_STR_INIT;
fail_unless (gst_id_str_is_equal (&s1, &s2));
fail_unless (gst_id_str_is_equal (&s1, &s1));
fail_unless (gst_id_str_is_equal_to_str (&s1, ""));
fail_if (gst_id_str_is_equal_to_str (&s1, "Hello, World!"));
// Should be stack allocated
gst_id_str_set (&s1, "Hello, World!");
fail_if (gst_id_str_is_equal (&s1, &s2));
fail_unless (gst_id_str_is_equal (&s1, &s1));
fail_unless (gst_id_str_is_equal_to_str (&s1, "Hello, World!"));
fail_if (gst_id_str_is_equal_to_str (&s1, "Hello, World?"));
fail_if (gst_id_str_is_equal_to_str (&s1, ""));
// Should be heap allocated
gst_id_str_set (&s1, "Hello, World! Goodbye, World!");
fail_if (gst_id_str_is_equal (&s1, &s2));
fail_unless (gst_id_str_is_equal (&s1, &s1));
fail_unless (gst_id_str_is_equal_to_str (&s1,
"Hello, World! Goodbye, World!"));
fail_if (gst_id_str_is_equal_to_str (&s1, ""));
fail_if (gst_id_str_is_equal_to_str (&s1, "Hello, World? Goodbye, World!"));
gst_id_str_set (&s2, "Hello, World!");
fail_if (gst_id_str_is_equal (&s1, &s2));
gst_id_str_set (&s1, "Hello, World!");
fail_unless (gst_id_str_is_equal (&s1, &s2));
gst_id_str_clear (&s1);
gst_id_str_clear (&s2);
}
GST_END_TEST;
static Suite *
gst_id_str_suite (void)
{
Suite *s = suite_create ("GstIdStr");
TCase *tc_chain = tcase_create ("general");
suite_add_tcase (s, tc_chain);
tcase_add_test (tc_chain, test_init);
tcase_add_test (tc_chain, test_alloc);
tcase_add_test (tc_chain, test_compare);
return s;
}
GST_CHECK_MAIN (gst_id_str);