test/test-blob.c

   1 /*
   2  * Copyright © 2011  Google, Inc.
   3  *
   4  *  This is part of HarfBuzz, a text shaping library.
   5  *
   6  * Permission is hereby granted, without written agreement and without
   7  * license or royalty fees, to use, copy, modify, and distribute this
   8  * software and its documentation for any purpose, provided that the
   9  * above copyright notice and the following two paragraphs appear in
  10  * all copies of this software.
  11  *
  12  * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
  13  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  14  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
  15  * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
  16  * DAMAGE.
  17  *
  18  * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
  19  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  20  * FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  21  * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
  22  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  23  *
  24  * Google Author(s): Behdad Esfahbod
  25  */
  26
  27 #include "hb-test.h"
  28
  29 /* Unit tests for hb-blob.h */
  30
  31 #if defined(HAVE_SYS_MMAN_H) && defined(HAVE_MPROTECT)
  32
  33 # define TEST_MMAP 1
  34
  35 #ifdef HAVE_SYS_MMAN_H
  36 #ifdef HAVE_UNISTD_H
  37 #include <unistd.h>
  38 #endif /* HAVE_UNISTD_H */
  39 #include <sys/mman.h>
  40 #endif /* HAVE_SYS_MMAN_H */
  41
  42 #endif
  43
  44
  45 static void
  46 test_blob_empty (void)
  47 {
  48   hb_blob_t *blob;
  49   unsigned int len;
  50   const char *data;
  51   char *data_writable;
  52
  53   g_assert (hb_blob_is_immutable (hb_blob_get_empty ()));
  54   g_assert (hb_blob_get_empty () != NULL);
  55   g_assert (hb_blob_get_empty () == hb_blob_create (NULL, 0, HB_MEMORY_MODE_READONLY, NULL, NULL));
  56
  57   blob = hb_blob_get_empty ();
  58   g_assert (blob == hb_blob_get_empty ());
  59
  60   len = hb_blob_get_length (blob);
  61   g_assert_cmpint (len, ==, 0);
  62
  63   data = hb_blob_get_data (blob, NULL);
  64   g_assert (data == NULL);
  65
  66   data = hb_blob_get_data (blob, &len);
  67   g_assert (data == NULL);
  68   g_assert_cmpint (len, ==, 0);
  69
  70   data_writable = hb_blob_get_data_writable (blob, NULL);
  71   g_assert (data == NULL);
  72
  73   data_writable = hb_blob_get_data_writable (blob, &len);
  74   g_assert (data_writable == NULL);
  75   g_assert_cmpint (len, ==, 0);
  76 }
  77
  78 static const char test_data[] = "test\0data";
  79
  80 static const char *blob_names[] = {
  81   "duplicate",
  82   "readonly",
  83   "writable"
  84 #ifdef TEST_MMAP
  85    , "readonly-may-make-writable"
  86 #endif
  87 };
  88
  89 typedef struct
  90 {
  91   hb_blob_t *blob;
  92   int freed;
  93   char *data;
  94   unsigned int len;
  95 } fixture_t;
  96
  97 static void
  98 free_up (fixture_t *fixture)
  99 {
 100   g_assert_cmpint (fixture->freed, ==, 0);
 101   fixture->freed++;
 102 }
 103
 104 static void
 105 free_up_free (fixture_t *fixture)
 106 {
 107   free_up (fixture);
 108   free (fixture->data);
 109 }
 110
 111
 112 static uintptr_t
 113 get_pagesize (void)
 114 {
 115   uintptr_t pagesize = -1;
 116
 117 #if defined(HAVE_SYSCONF) && defined(_SC_PAGE_SIZE)
 118   pagesize = (uintptr_t) sysconf (_SC_PAGE_SIZE);
 119 #elif defined(HAVE_SYSCONF) && defined(_SC_PAGESIZE)
 120   pagesize = (uintptr_t) sysconf (_SC_PAGESIZE);
 121 #elif defined(HAVE_GETPAGESIZE)
 122   pagesize = (uintptr_t) getpagesize ();
 123 #endif
 124
 125   g_assert (pagesize != (uintptr_t) -1);
 126
 127   return pagesize;
 128 }
 129
 130 static void
 131 free_up_munmap (fixture_t *fixture)
 132 {
 133   free_up (fixture);
 134   munmap (fixture->data, get_pagesize ());
 135 }
 136
 137 #include <errno.h>
 138 static void
 139 fixture_init (fixture_t *fixture, gconstpointer user_data)
 140 {
 141   hb_memory_mode_t mm = (hb_memory_mode_t) GPOINTER_TO_INT (user_data);
 142   unsigned int len;
 143   const char *data;
 144   hb_destroy_func_t free_func;
 145
 146   switch (GPOINTER_TO_INT (user_data))
 147   {
 148     case HB_MEMORY_MODE_DUPLICATE:
 149       data = test_data;
 150       len = sizeof (test_data);
 151       free_func = (hb_destroy_func_t) free_up;
 152       break;
 153
 154     case HB_MEMORY_MODE_READONLY:
 155       data = test_data;
 156       len = sizeof (test_data);
 157       free_func = (hb_destroy_func_t) free_up;
 158       break;
 159
 160     case HB_MEMORY_MODE_WRITABLE:
 161       data = malloc (sizeof (test_data));
 162       memcpy ((char *) data, test_data, sizeof (test_data));
 163       len = sizeof (test_data);
 164       free_func = (hb_destroy_func_t) free_up_free;
 165       break;
 166
 167 #if TEST_MMAP
 168     case HB_MEMORY_MODE_READONLY_MAY_MAKE_WRITABLE:
 169     {
 170       uintptr_t pagesize = get_pagesize ();
 171
 172       data = mmap (NULL, pagesize, PROT_READ | PROT_WRITE, MAP_PRIVATE | MAP_ANON, -1, 0);
 173       g_assert (data != (char *) -1);
 174       memcpy ((char *) data, test_data, sizeof (test_data));
 175       mprotect ((char *) data, pagesize, PROT_READ);
 176       len = sizeof (test_data);
 177       free_func = (hb_destroy_func_t) free_up_munmap;
 178       break;
 179     }
 180 #endif
 181
 182     default:
 183       g_assert_not_reached ();
 184   }
 185
 186   fixture->freed = 0;
 187   fixture->data = (char *) data;
 188   fixture->len = len;
 189   fixture->blob = hb_blob_create (data, len, mm, fixture, free_func);
 190 }
 191
 192 static void
 193 fixture_finish (fixture_t *fixture, gconstpointer user_data)
 194 {
 195   hb_blob_destroy (fixture->blob);
 196   g_assert_cmpint (fixture->freed, ==, 1);
 197 }
 198
 199
 200 static void
 201 test_blob (fixture_t *fixture, gconstpointer user_data)
 202 {
 203   hb_blob_t *b = fixture->blob;
 204   hb_memory_mode_t mm = GPOINTER_TO_INT (user_data);
 205   unsigned int len;
 206   const char *data;
 207   char *data_writable;
 208   unsigned int i;
 209
 210   g_assert (b);
 211
 212   len = hb_blob_get_length (b);
 213   g_assert_cmpint (len, ==, fixture->len);
 214
 215   data = hb_blob_get_data (b, &len);
 216   g_assert_cmpint (len, ==, fixture->len);
 217   if (mm == HB_MEMORY_MODE_DUPLICATE) {
 218     g_assert (data != fixture->data);
 219     g_assert_cmpint (fixture->freed, ==, 1);
 220     mm = HB_MEMORY_MODE_WRITABLE;
 221   } else {
 222     g_assert (data == fixture->data);
 223     g_assert_cmpint (fixture->freed, ==, 0);
 224   }
 225
 226   data_writable = hb_blob_get_data_writable (b, &len);
 227   g_assert_cmpint (len, ==, fixture->len);
 228   g_assert (data_writable);
 229   g_assert (0 == memcmp (data_writable, fixture->data, fixture->len));
 230   if (mm == HB_MEMORY_MODE_READONLY) {
 231     g_assert (data_writable != data);
 232     g_assert_cmpint (fixture->freed, ==, 1);
 233   } else {
 234     g_assert (data_writable == data);
 235   }
 236
 237   data = hb_blob_get_data (b, &len);
 238   g_assert_cmpint (len, ==, fixture->len);
 239   g_assert (data == data_writable);
 240
 241   memset (data_writable, 0, fixture->len);
 242
 243   /* Now, make it immutable and watch get_data_writable() fail */
 244
 245   g_assert (!hb_blob_is_immutable (b));
 246   hb_blob_make_immutable (b);
 247   g_assert (hb_blob_is_immutable (b));
 248
 249   data_writable = hb_blob_get_data_writable (b, &len);
 250   g_assert (!data_writable);
 251   g_assert_cmpint (len, ==, 0);
 252
 253   data = hb_blob_get_data (b, &len);
 254   g_assert_cmpint (len, ==, fixture->len);
 255   for (i = 0; i < len; i++)
 256     g_assert ('\0' == data[i]);
 257 }
 258
 259 static void
 260 test_blob_subblob (fixture_t *fixture, gconstpointer user_data)
 261 {
 262   hb_blob_t *b = fixture->blob;
 263
 264   fixture->len -= 2;
 265   fixture->data++;
 266   fixture->blob = hb_blob_create_sub_blob (b, 1, fixture->len);
 267   hb_blob_destroy (b);
 268
 269   test_blob (fixture, user_data);
 270
 271   fixture->data--;
 272   fixture->len += 2;
 273 }
 274
 275
 276 int
 277 main (int argc, char **argv)
 278 {
 279   unsigned int i;
 280
 281   hb_test_init (&argc, &argv);
 282
 283   hb_test_add (test_blob_empty);
 284
 285   for (i = 0; i < G_N_ELEMENTS (blob_names); i++)
 286   {
 287     const void *blob_type = GINT_TO_POINTER (i);
 288     const char *blob_name = blob_names[i];
 289
 290     hb_test_add_fixture_flavor (fixture, blob_type, blob_name, test_blob);
 291     hb_test_add_fixture_flavor (fixture, blob_type, blob_name, test_blob_subblob);
 292   }
 293
 294   /*
 295    * create_sub_blob
 296    */
 297
 298   return hb_test_run ();
 299 }