src/hb-blob.c

   1 /*
   2  * Copyright (C) 2009  Red Hat, 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  * Red Hat Author(s): Behdad Esfahbod
  25  */
  26
  27 #include "hb-private.h"
  28
  29 #include "hb-blob-private.h"
  30
  31 #ifdef HAVE_SYS_MMAN_H
  32 #ifdef HAVE_UNISTD_H
  33 #include <unistd.h>
  34 #endif /* HAVE_UNISTD_H */
  35 #include <sys/mman.h>
  36 #endif /* HAVE_SYS_MMAN_H */
  37
  38 #ifndef HB_DEBUG_BLOB
  39 #define HB_DEBUG_BLOB HB_DEBUG+0
  40 #endif
  41
  42 #include <stdio.h>
  43 #include <errno.h>
  44
  45 hb_blob_t _hb_blob_nil = {
  46   HB_REFERENCE_COUNT_INVALID, /* ref_count */
  47
  48   0, /* length */
  49
  50   HB_MUTEX_INIT, /* lock */
  51
  52   0, /* lock_count */
  53   HB_MEMORY_MODE_READONLY, /* mode */
  54
  55   NULL, /* data */
  56
  57   NULL, /* destroy */
  58   NULL /* user_data */
  59 };
  60
  61 static void
  62 _hb_blob_destroy_user_data (hb_blob_t *blob)
  63 {
  64   if (blob->destroy) {
  65     blob->destroy (blob->user_data);
  66     blob->destroy = NULL;
  67     blob->user_data = NULL;
  68   }
  69 }
  70
  71 static void
  72 _hb_blob_unlock_and_destroy (hb_blob_t *blob)
  73 {
  74   hb_blob_unlock (blob);
  75   hb_blob_destroy (blob);
  76 }
  77
  78 hb_blob_t *
  79 hb_blob_create (const char        *data,
  80                 unsigned int       length,
  81                 hb_memory_mode_t   mode,
  82                 hb_destroy_func_t  destroy,
  83                 void              *user_data)
  84 {
  85   hb_blob_t *blob;
  86
  87   if (!length || !HB_OBJECT_DO_CREATE (hb_blob_t, blob)) {
  88     if (destroy)
  89       destroy (user_data);
  90     return &_hb_blob_nil;
  91   }
  92
  93   hb_mutex_init (blob->lock);
  94   blob->lock_count = 0;
  95
  96   blob->data = data;
  97   blob->length = length;
  98   blob->mode = mode;
  99
 100   blob->destroy = destroy;
 101   blob->user_data = user_data;
 102
 103   if (blob->mode == HB_MEMORY_MODE_DUPLICATE) {
 104     blob->mode = HB_MEMORY_MODE_READONLY;
 105     if (!hb_blob_try_writable (blob)) {
 106       hb_blob_destroy (blob);
 107       return &_hb_blob_nil;
 108     }
 109   }
 110
 111   return blob;
 112 }
 113
 114 hb_blob_t *
 115 hb_blob_create_sub_blob (hb_blob_t    *parent,
 116                          unsigned int  offset,
 117                          unsigned int  length)
 118 {
 119   hb_blob_t *blob;
 120   const char *pdata;
 121
 122   if (!length || offset >= parent->length || !HB_OBJECT_DO_CREATE (hb_blob_t, blob))
 123     return &_hb_blob_nil;
 124
 125   pdata = hb_blob_lock (parent);
 126
 127   blob->data = pdata + offset;
 128   blob->length = MIN (length, parent->length - offset);
 129
 130   hb_mutex_lock (parent->lock);
 131   blob->mode = parent->mode;
 132   hb_mutex_unlock (parent->lock);
 133
 134   blob->destroy = (hb_destroy_func_t) _hb_blob_unlock_and_destroy;
 135   blob->user_data = hb_blob_reference (parent);
 136
 137   return blob;
 138 }
 139
 140 hb_blob_t *
 141 hb_blob_create_empty (void)
 142 {
 143   return &_hb_blob_nil;
 144 }
 145
 146 hb_blob_t *
 147 hb_blob_reference (hb_blob_t *blob)
 148 {
 149   HB_OBJECT_DO_REFERENCE (blob);
 150 }
 151
 152 unsigned int
 153 hb_blob_get_reference_count (hb_blob_t *blob)
 154 {
 155   HB_OBJECT_DO_GET_REFERENCE_COUNT (blob);
 156 }
 157
 158 void
 159 hb_blob_destroy (hb_blob_t *blob)
 160 {
 161   HB_OBJECT_DO_DESTROY (blob);
 162
 163   _hb_blob_destroy_user_data (blob);
 164
 165   free (blob);
 166 }
 167
 168 unsigned int
 169 hb_blob_get_length (hb_blob_t *blob)
 170 {
 171   return blob->length;
 172 }
 173
 174 const char *
 175 hb_blob_lock (hb_blob_t *blob)
 176 {
 177   if (HB_OBJECT_IS_INERT (blob))
 178     return NULL;
 179
 180   hb_mutex_lock (blob->lock);
 181
 182   if (HB_DEBUG_BLOB)
 183     fprintf (stderr, "%p %s (%d) -> %p\n", blob, __FUNCTION__,
 184              blob->lock_count, blob->data);
 185
 186   blob->lock_count++;
 187
 188   hb_mutex_unlock (blob->lock);
 189
 190   return blob->data;
 191 }
 192
 193 void
 194 hb_blob_unlock (hb_blob_t *blob)
 195 {
 196   if (HB_OBJECT_IS_INERT (blob))
 197     return;
 198
 199   hb_mutex_lock (blob->lock);
 200
 201   if (HB_DEBUG_BLOB)
 202     fprintf (stderr, "%p %s (%d) -> %p\n", blob, __FUNCTION__,
 203              blob->lock_count, blob->data);
 204
 205   assert (blob->lock_count > 0);
 206   blob->lock_count--;
 207
 208   hb_mutex_unlock (blob->lock);
 209 }
 210
 211 hb_bool_t
 212 hb_blob_is_writable (hb_blob_t *blob)
 213 {
 214   hb_memory_mode_t mode;
 215
 216   if (HB_OBJECT_IS_INERT (blob))
 217     return FALSE;
 218
 219   hb_mutex_lock (blob->lock);
 220
 221   mode = blob->mode;
 222
 223   hb_mutex_unlock (blob->lock);
 224
 225   return mode == HB_MEMORY_MODE_WRITABLE;
 226 }
 227
 228
 229 static hb_bool_t
 230 _try_make_writable_inplace_unix_locked (hb_blob_t *blob)
 231 {
 232 #if defined(HAVE_SYS_MMAN_H) && defined(HAVE_MPROTECT)
 233   uintptr_t pagesize = -1, mask, length;
 234   const char *addr;
 235
 236 #if defined(HAVE_SYSCONF) && defined(_SC_PAGE_SIZE)
 237   pagesize = (uintptr_t) sysconf (_SC_PAGE_SIZE);
 238 #elif defined(HAVE_SYSCONF) && defined(_SC_PAGESIZE)
 239   pagesize = (uintptr_t) sysconf (_SC_PAGESIZE);
 240 #elif defined(HAVE_GETPAGESIZE)
 241   pagesize = (uintptr_t) getpagesize ();
 242 #endif
 243
 244   if ((uintptr_t) -1L == pagesize) {
 245     if (HB_DEBUG_BLOB)
 246       fprintf (stderr, "%p %s: failed to get pagesize: %s\n", blob, __FUNCTION__, strerror (errno));
 247     return FALSE;
 248   }
 249   if (HB_DEBUG_BLOB)
 250     fprintf (stderr, "%p %s: pagesize is %u\n", blob, __FUNCTION__, pagesize);
 251
 252   mask = ~(pagesize-1);
 253   addr = (const char *) (((uintptr_t) blob->data) & mask);
 254   length = (const char *) (((uintptr_t) blob->data + blob->length + pagesize-1) & mask)  - addr;
 255   if (HB_DEBUG_BLOB)
 256     fprintf (stderr, "%p %s: calling mprotect on [%p..%p] (%d bytes)\n",
 257              blob, __FUNCTION__,
 258              addr, addr+length, length);
 259   if (-1 == mprotect ((void *) addr, length, PROT_READ | PROT_WRITE)) {
 260     if (HB_DEBUG_BLOB)
 261       fprintf (stderr, "%p %s: %s\n", blob, __FUNCTION__, strerror (errno));
 262     return FALSE;
 263   }
 264
 265   if (HB_DEBUG_BLOB)
 266     fprintf (stderr, "%p %s: successfully made [%p..%p] (%d bytes) writable\n",
 267              blob, __FUNCTION__,
 268              addr, addr+length, length);
 269   return TRUE;
 270 #else
 271   return FALSE;
 272 #endif
 273 }
 274
 275 static void
 276 _try_writable_inplace_locked (hb_blob_t *blob)
 277 {
 278   if (HB_DEBUG_BLOB)
 279     fprintf (stderr, "%p %s: making writable\n", blob, __FUNCTION__);
 280
 281   if (_try_make_writable_inplace_unix_locked (blob)) {
 282     if (HB_DEBUG_BLOB)
 283       fprintf (stderr, "%p %s: making writable -> succeeded\n", blob, __FUNCTION__);
 284     blob->mode = HB_MEMORY_MODE_WRITABLE;
 285   } else {
 286     if (HB_DEBUG_BLOB)
 287       fprintf (stderr, "%p %s: making writable -> FAILED\n", blob, __FUNCTION__);
 288     /* Failed to make writable inplace, mark that */
 289     blob->mode = HB_MEMORY_MODE_READONLY;
 290   }
 291 }
 292
 293 hb_bool_t
 294 hb_blob_try_writable_inplace (hb_blob_t *blob)
 295 {
 296   hb_memory_mode_t mode;
 297
 298   if (HB_OBJECT_IS_INERT (blob))
 299     return FALSE;
 300
 301   hb_mutex_lock (blob->lock);
 302
 303   if (blob->mode == HB_MEMORY_MODE_READONLY_MAY_MAKE_WRITABLE)
 304     _try_writable_inplace_locked (blob);
 305
 306   mode = blob->mode;
 307
 308   hb_mutex_unlock (blob->lock);
 309
 310   return mode == HB_MEMORY_MODE_WRITABLE;
 311 }
 312
 313 hb_bool_t
 314 hb_blob_try_writable (hb_blob_t *blob)
 315 {
 316   hb_memory_mode_t mode;
 317
 318   if (HB_OBJECT_IS_INERT (blob))
 319     return FALSE;
 320
 321   hb_mutex_lock (blob->lock);
 322
 323   if (blob->mode == HB_MEMORY_MODE_READONLY_MAY_MAKE_WRITABLE)
 324     _try_writable_inplace_locked (blob);
 325
 326   if (blob->mode == HB_MEMORY_MODE_READONLY)
 327   {
 328     char *new_data;
 329
 330     if (HB_DEBUG_BLOB)
 331       fprintf (stderr, "%p %s (%d) -> %p\n", blob, __FUNCTION__,
 332                blob->lock_count, blob->data);
 333
 334     if (blob->lock_count)
 335       goto done;
 336
 337     new_data = malloc (blob->length);
 338     if (new_data) {
 339       if (HB_DEBUG_BLOB)
 340         fprintf (stderr, "%p %s: dupped successfully -> %p\n", blob, __FUNCTION__, blob->data);
 341       memcpy (new_data, blob->data, blob->length);
 342       _hb_blob_destroy_user_data (blob);
 343       blob->mode = HB_MEMORY_MODE_WRITABLE;
 344       blob->data = new_data;
 345       blob->destroy = free;
 346       blob->user_data = new_data;
 347     }
 348   }
 349
 350 done:
 351   mode = blob->mode;
 352
 353   hb_mutex_unlock (blob->lock);
 354
 355   return mode == HB_MEMORY_MODE_WRITABLE;
 356 }