fccache.c

   1 /*
   2  * Copyright © 2000 Keith Packard
   3  * Copyright © 2005 Patrick Lam
   4  *
   5  * Permission to use, copy, modify, distribute, and sell this software and its
   6  * documentation for any purpose is hereby granted without fee, provided that
   7  * the above copyright notice appear in all copies and that both that
   8  * copyright notice and this permission notice appear in supporting
   9  * documentation, and that the name of the author(s) not be used in
  10  * advertising or publicity pertaining to distribution of the software without
  11  * specific, written prior permission.  The authors make no
  12  * representations about the suitability of this software for any purpose.  It
  13  * is provided "as is" without express or implied warranty.
  14  *
  15  * THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  16  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
  17  * EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  18  * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
  19  * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  20  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  21  * PERFORMANCE OF THIS SOFTWARE.
  22  */
  23
  24 #include "fcint.h"
  25 #include "fcarch.h"
  26 #include <stdio.h>
  27 #include <fcntl.h>
  28 #include <dirent.h>
  29 #include <string.h>
  30 #include <sys/types.h>
  31 #include <assert.h>
  32 #if defined(HAVE_MMAP) || defined(__CYGWIN__)
  33 #  include <unistd.h>
  34 #  include <sys/mman.h>
  35 #elif defined(_WIN32)
  36 #  define _WIN32_WINNT 0x0500
  37 #  include <windows.h>
  38 #endif
  39
  40 #ifndef O_BINARY
  41 #define O_BINARY 0
  42 #endif
  43
  44
  45 struct MD5Context {
  46         FcChar32 buf[4];
  47         FcChar32 bits[2];
  48         unsigned char in[64];
  49 };
  50
  51 static void MD5Init(struct MD5Context *ctx);
  52 static void MD5Update(struct MD5Context *ctx, const unsigned char *buf, unsigned len);
  53 static void MD5Final(unsigned char digest[16], struct MD5Context *ctx);
  54 static void MD5Transform(FcChar32 buf[4], FcChar32 in[16]);
  55
  56 #define CACHEBASE_LEN (1 + 32 + 1 + sizeof (FC_ARCHITECTURE) + sizeof (FC_CACHE_SUFFIX))
  57
  58 #ifdef _WIN32
  59
  60 #include <windows.h>
  61
  62 #ifdef __GNUC__
  63 typedef long long INT64;
  64 #define EPOCH_OFFSET 11644473600ll
  65 #else
  66 #define EPOCH_OFFSET 11644473600i64
  67 typedef __int64 INT64;
  68 #endif
  69
  70 /* Workaround for problems in the stat() in the Microsoft C library:
  71  *
  72  * 1) stat() uses FindFirstFile() to get the file
  73  * attributes. Unfortunately this API doesn't return correct values
  74  * for modification time of a directory until some time after a file
  75  * or subdirectory has been added to the directory. (This causes
  76  * run-test.sh to fail, for instance.) GetFileAttributesEx() is
  77  * better, it returns the updated timestamp right away.
  78  *
  79  * 2) stat() does some strange things related to backward
  80  * compatibility with the local time timestamps on FAT volumes and
  81  * daylight saving time. This causes problems after the switches
  82  * to/from daylight saving time. See
  83  * http://bugzilla.gnome.org/show_bug.cgi?id=154968 , especially
  84  * comment #30, and http://www.codeproject.com/datetime/dstbugs.asp .
  85  * We don't need any of that, FAT and Win9x are as good as dead. So
  86  * just use the UTC timestamps from NTFS, converted to the Unix epoch.
  87  */
  88
  89 int
  90 FcStat (const char *file, struct stat *statb)
  91 {
  92     WIN32_FILE_ATTRIBUTE_DATA wfad;
  93     char full_path_name[MAX_PATH];
  94     char *basename;
  95     DWORD rc;
  96
  97     if (!GetFileAttributesEx (file, GetFileExInfoStandard, &wfad))
  98         return -1;
  99
 100     statb->st_dev = 0;
 101
 102     /* Calculate a pseudo inode number as a hash of the full path name.
 103      * Call GetLongPathName() to get the spelling of the path name as it
 104      * is on disk.
 105      */
 106     rc = GetFullPathName (file, sizeof (full_path_name), full_path_name, &basename);
 107     if (rc == 0 || rc > sizeof (full_path_name))
 108         return -1;
 109
 110     rc = GetLongPathName (full_path_name, full_path_name, sizeof (full_path_name));
 111     statb->st_ino = FcStringHash (full_path_name);
 112
 113     statb->st_mode = _S_IREAD | _S_IWRITE;
 114     statb->st_mode |= (statb->st_mode >> 3) | (statb->st_mode >> 6);
 115
 116     if (wfad.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)
 117         statb->st_mode |= _S_IFDIR;
 118     else
 119         statb->st_mode |= _S_IFREG;
 120
 121     statb->st_nlink = 1;
 122     statb->st_uid = statb->st_gid = 0;
 123     statb->st_rdev = 0;
 124
 125     if (wfad.nFileSizeHigh > 0)
 126         return -1;
 127     statb->st_size = wfad.nFileSizeLow;
 128
 129     statb->st_atime = (*(INT64 *)&wfad.ftLastAccessTime)/10000000 - EPOCH_OFFSET;
 130     statb->st_mtime = (*(INT64 *)&wfad.ftLastWriteTime)/10000000 - EPOCH_OFFSET;
 131     statb->st_ctime = statb->st_mtime;
 132
 133     return 0;
 134 }
 135
 136 #else
 137
 138 int
 139 FcStat (const char *file, struct stat *statb)
 140 {
 141   return stat ((char *) file, statb);
 142 }
 143
 144 #endif
 145
 146 static const char bin2hex[] = { '0', '1', '2', '3',
 147                                 '4', '5', '6', '7',
 148                                 '8', '9', 'a', 'b',
 149                                 'c', 'd', 'e', 'f' };
 150
 151 static FcChar8 *
 152 FcDirCacheBasename (const FcChar8 * dir, FcChar8 cache_base[CACHEBASE_LEN])
 153 {
 154     unsigned char       hash[16];
 155     FcChar8             *hex_hash;
 156     int                 cnt;
 157     struct MD5Context   ctx;
 158
 159     MD5Init (&ctx);
 160     MD5Update (&ctx, (const unsigned char *)dir, strlen ((const char *) dir));
 161
 162     MD5Final (hash, &ctx);
 163
 164     cache_base[0] = '/';
 165     hex_hash = cache_base + 1;
 166     for (cnt = 0; cnt < 16; ++cnt)
 167     {
 168         hex_hash[2*cnt  ] = bin2hex[hash[cnt] >> 4];
 169         hex_hash[2*cnt+1] = bin2hex[hash[cnt] & 0xf];
 170     }
 171     hex_hash[2*cnt] = 0;
 172     strcat ((char *) cache_base, "-" FC_ARCHITECTURE FC_CACHE_SUFFIX);
 173
 174     return cache_base;
 175 }
 176
 177 FcBool
 178 FcDirCacheUnlink (const FcChar8 *dir, FcConfig *config)
 179 {
 180     FcChar8     *cache_hashed = NULL;
 181     FcChar8     cache_base[CACHEBASE_LEN];
 182     FcStrList   *list;
 183     FcChar8     *cache_dir;
 184
 185     FcDirCacheBasename (dir, cache_base);
 186
 187     list = FcStrListCreate (config->cacheDirs);
 188     if (!list)
 189         return FcFalse;
 190
 191     while ((cache_dir = FcStrListNext (list)))
 192     {
 193         cache_hashed = FcStrPlus (cache_dir, cache_base);
 194         if (!cache_hashed)
 195             break;
 196         (void) unlink ((char *) cache_hashed);
 197         FcStrFree (cache_hashed);
 198     }
 199     FcStrListDone (list);
 200     /* return FcFalse if something went wrong */
 201     if (cache_dir)
 202         return FcFalse;
 203     return FcTrue;
 204 }
 205
 206 static int
 207 FcDirCacheOpenFile (const FcChar8 *cache_file, struct stat *file_stat)
 208 {
 209     int fd;
 210
 211 #ifdef _WIN32
 212     if (FcStat (cache_file, file_stat) < 0)
 213         return -1;
 214 #endif
 215     fd = open((char *) cache_file, O_RDONLY | O_BINARY);
 216     if (fd < 0)
 217         return fd;
 218 #ifndef _WIN32
 219     if (fstat (fd, file_stat) < 0)
 220     {
 221         close (fd);
 222         return -1;
 223     }
 224 #endif
 225     return fd;
 226 }
 227
 228 /*
 229  * Look for a cache file for the specified dir. Attempt
 230  * to use each one we find, stopping when the callback
 231  * indicates success
 232  */
 233 static FcBool
 234 FcDirCacheProcess (FcConfig *config, const FcChar8 *dir,
 235                    FcBool (*callback) (int fd, struct stat *fd_stat,
 236                                        struct stat *dir_stat, void *closure),
 237                    void *closure, FcChar8 **cache_file_ret)
 238 {
 239     int         fd = -1;
 240     FcChar8     cache_base[CACHEBASE_LEN];
 241     FcStrList   *list;
 242     FcChar8     *cache_dir;
 243     struct stat file_stat, dir_stat;
 244     FcBool      ret = FcFalse;
 245
 246     if (FcStat (dir, &dir_stat) < 0)
 247         return FcFalse;
 248
 249     FcDirCacheBasename (dir, cache_base);
 250
 251     list = FcStrListCreate (config->cacheDirs);
 252     if (!list)
 253         return FcFalse;
 254
 255     while ((cache_dir = FcStrListNext (list)))
 256     {
 257         FcChar8 *cache_hashed = FcStrPlus (cache_dir, cache_base);
 258         if (!cache_hashed)
 259             break;
 260         fd = FcDirCacheOpenFile (cache_hashed, &file_stat);
 261         if (fd >= 0) {
 262             ret = (*callback) (fd, &file_stat, &dir_stat, closure);
 263             close (fd);
 264             if (ret)
 265             {
 266                 if (cache_file_ret)
 267                     *cache_file_ret = cache_hashed;
 268                 else
 269                     FcStrFree (cache_hashed);
 270                 break;
 271             }
 272         }
 273         FcStrFree (cache_hashed);
 274     }
 275     FcStrListDone (list);
 276
 277     return ret;
 278 }
 279
 280 #define FC_CACHE_MIN_MMAP   1024
 281
 282 /*
 283  * Skip list element, make sure the 'next' pointer is the last thing
 284  * in the structure, it will be allocated large enough to hold all
 285  * of the necessary pointers
 286  */
 287
 288 typedef struct _FcCacheSkip FcCacheSkip;
 289
 290 struct _FcCacheSkip {
 291     FcCache         *cache;
 292     int             ref;
 293     intptr_t        size;
 294     dev_t           cache_dev;
 295     ino_t           cache_ino;
 296     time_t          cache_mtime;
 297     FcCacheSkip     *next[1];
 298 };
 299
 300 /*
 301  * The head of the skip list; pointers for every possible level
 302  * in the skip list, plus the largest level in the list
 303  */
 304
 305 #define FC_CACHE_MAX_LEVEL  16
 306
 307 static FcCacheSkip      *fcCacheChains[FC_CACHE_MAX_LEVEL];
 308 static int              fcCacheMaxLevel;
 309
 310 #if HAVE_RANDOM
 311 # define FcRandom()  random()
 312 #else
 313 # if HAVE_LRAND48
 314 #  define FcRandom()  lrand48()
 315 # else
 316 #  if HAVE_RAND
 317 #   define FcRandom()  rand()
 318 #  endif
 319 # endif
 320 #endif
 321 /*
 322  * Generate a random level number, distributed
 323  * so that each level is 1/4 as likely as the one before
 324  *
 325  * Note that level numbers run 1 <= level <= MAX_LEVEL
 326  */
 327 static int
 328 random_level (void)
 329 {
 330     /* tricky bit -- each bit is '1' 75% of the time */
 331     long int    bits = FcRandom () | FcRandom ();
 332     int level = 0;
 333
 334     while (++level < FC_CACHE_MAX_LEVEL)
 335     {
 336         if (bits & 1)
 337             break;
 338         bits >>= 1;
 339     }
 340     return level;
 341 }
 342
 343 /*
 344  * Insert cache into the list
 345  */
 346 static FcBool
 347 FcCacheInsert (FcCache *cache, struct stat *cache_stat)
 348 {
 349     FcCacheSkip    **update[FC_CACHE_MAX_LEVEL];
 350     FcCacheSkip    *s, **next;
 351     int             i, level;
 352
 353     /*
 354      * Find links along each chain
 355      */
 356     next = fcCacheChains;
 357     for (i = fcCacheMaxLevel; --i >= 0; )
 358     {
 359         for (; (s = next[i]); next = s->next)
 360             if (s->cache > cache)
 361                 break;
 362         update[i] = &next[i];
 363     }
 364
 365     /*
 366      * Create new list element
 367      */
 368     level = random_level ();
 369     if (level > fcCacheMaxLevel)
 370     {
 371         level = fcCacheMaxLevel + 1;
 372         update[fcCacheMaxLevel] = &fcCacheChains[fcCacheMaxLevel];
 373         fcCacheMaxLevel = level;
 374     }
 375
 376     s = malloc (sizeof (FcCacheSkip) + (level - 1) * sizeof (FcCacheSkip *));
 377     if (!s)
 378         return FcFalse;
 379
 380     s->cache = cache;
 381     s->size = cache->size;
 382     s->ref = 1;
 383     if (cache_stat)
 384     {
 385         s->cache_dev = cache_stat->st_dev;
 386         s->cache_ino = cache_stat->st_ino;
 387         s->cache_mtime = cache_stat->st_mtime;
 388     }
 389     else
 390     {
 391         s->cache_dev = 0;
 392         s->cache_ino = 0;
 393         s->cache_mtime = 0;
 394     }
 395
 396     /*
 397      * Insert into all fcCacheChains
 398      */
 399     for (i = 0; i < level; i++)
 400     {
 401         s->next[i] = *update[i];
 402         *update[i] = s;
 403     }
 404     return FcTrue;
 405 }
 406
 407 static FcCacheSkip *
 408 FcCacheFindByAddr (void *object)
 409 {
 410     int     i;
 411     FcCacheSkip    **next = fcCacheChains;
 412     FcCacheSkip    *s;
 413
 414     /*
 415      * Walk chain pointers one level at a time
 416      */
 417     for (i = fcCacheMaxLevel; --i >= 0;)
 418         while (next[i] && (char *) object >= ((char *) next[i]->cache + next[i]->size))
 419             next = next[i]->next;
 420     /*
 421      * Here we are
 422      */
 423     s = next[0];
 424     if (s && (char *) object < ((char *) s->cache + s->size))
 425         return s;
 426     return NULL;
 427 }
 428
 429 static void
 430 FcCacheRemove (FcCache *cache)
 431 {
 432     FcCacheSkip     **update[FC_CACHE_MAX_LEVEL];
 433     FcCacheSkip     *s, **next;
 434     int             i;
 435
 436     /*
 437      * Find links along each chain
 438      */
 439     next = fcCacheChains;
 440     for (i = fcCacheMaxLevel; --i >= 0; )
 441     {
 442         for (; (s = next[i]); next = s->next)
 443             if (s->cache >= cache)
 444                 break;
 445         update[i] = &next[i];
 446     }
 447     s = next[0];
 448     for (i = 0; i < fcCacheMaxLevel && *update[i] == s; i++)
 449         *update[i] = s->next[i];
 450     while (fcCacheMaxLevel > 0 && fcCacheChains[fcCacheMaxLevel - 1] == NULL)
 451         fcCacheMaxLevel--;
 452     free (s);
 453 }
 454
 455 static FcCache *
 456 FcCacheFindByStat (struct stat *cache_stat)
 457 {
 458     FcCacheSkip     *s;
 459
 460     for (s = fcCacheChains[0]; s; s = s->next[0])
 461         if (s->cache_dev == cache_stat->st_dev &&
 462             s->cache_ino == cache_stat->st_ino &&
 463             s->cache_mtime == cache_stat->st_mtime)
 464         {
 465             s->ref++;
 466             return s->cache;
 467         }
 468     return NULL;
 469 }
 470
 471 static void
 472 FcDirCacheDispose (FcCache *cache)
 473 {
 474     switch (cache->magic) {
 475     case FC_CACHE_MAGIC_ALLOC:
 476         free (cache);
 477         break;
 478     case FC_CACHE_MAGIC_MMAP:
 479 #if defined(HAVE_MMAP) || defined(__CYGWIN__)
 480         munmap (cache, cache->size);
 481 #elif defined(_WIN32)
 482         UnmapViewOfFile (cache);
 483 #endif
 484         break;
 485     }
 486     FcCacheRemove (cache);
 487 }
 488
 489 void
 490 FcCacheObjectReference (void *object)
 491 {
 492     FcCacheSkip *skip = FcCacheFindByAddr (object);
 493
 494     if (skip)
 495         skip->ref++;
 496 }
 497
 498 void
 499 FcCacheObjectDereference (void *object)
 500 {
 501     FcCacheSkip *skip = FcCacheFindByAddr (object);
 502
 503     if (skip)
 504     {
 505         skip->ref--;
 506         if (skip->ref <= 0)
 507             FcDirCacheDispose (skip->cache);
 508     }
 509 }
 510
 511 void
 512 FcCacheFini (void)
 513 {
 514     int             i;
 515
 516     for (i = 0; i < FC_CACHE_MAX_LEVEL; i++)
 517         assert (fcCacheChains[i] == NULL);
 518     assert (fcCacheMaxLevel == 0);
 519 }
 520
 521 static FcBool
 522 FcCacheTimeValid (FcCache *cache, struct stat *dir_stat)
 523 {
 524     struct stat dir_static;
 525
 526     if (!dir_stat)
 527     {
 528         if (FcStat (FcCacheDir (cache), &dir_static) < 0)
 529             return FcFalse;
 530         dir_stat = &dir_static;
 531     }
 532     if (FcDebug () & FC_DBG_CACHE)
 533         printf ("FcCacheTimeValid dir \"%s\" cache time %d dir time %d\n",
 534                 FcCacheDir (cache), cache->mtime, (int) dir_stat->st_mtime);
 535     return cache->mtime == (int) dir_stat->st_mtime;
 536 }
 537
 538 /*
 539  * Map a cache file into memory
 540  */
 541 static FcCache *
 542 FcDirCacheMapFd (int fd, struct stat *fd_stat, struct stat *dir_stat)
 543 {
 544     FcCache     *cache;
 545     FcBool      allocated = FcFalse;
 546
 547     if (fd_stat->st_size < sizeof (FcCache))
 548         return NULL;
 549     cache = FcCacheFindByStat (fd_stat);
 550     if (cache)
 551     {
 552         if (FcCacheTimeValid (cache, dir_stat))
 553             return cache;
 554         FcDirCacheUnload (cache);
 555         cache = NULL;
 556     }
 557
 558     /*
 559      * Lage cache files are mmap'ed, smaller cache files are read. This
 560      * balances the system cost of mmap against per-process memory usage.
 561      */
 562     if (fd_stat->st_size >= FC_CACHE_MIN_MMAP)
 563     {
 564 #if defined(HAVE_MMAP) || defined(__CYGWIN__)
 565         cache = mmap (0, fd_stat->st_size, PROT_READ, MAP_SHARED, fd, 0);
 566         if (cache == MAP_FAILED)
 567             cache = NULL;
 568 #elif defined(_WIN32)
 569         {
 570             HANDLE hFileMap;
 571
 572             cache = NULL;
 573             hFileMap = CreateFileMapping((HANDLE) _get_osfhandle(fd), NULL,
 574                                          PAGE_READONLY, 0, 0, NULL);
 575             if (hFileMap != NULL)
 576             {
 577                 cache = MapViewOfFile (hFileMap, FILE_MAP_READ, 0, 0,
 578                                        fd_stat->st_size);
 579                 CloseHandle (hFileMap);
 580             }
 581         }
 582 #endif
 583     }
 584     if (!cache)
 585     {
 586         cache = malloc (fd_stat->st_size);
 587         if (!cache)
 588             return NULL;
 589
 590         if (read (fd, cache, fd_stat->st_size) != fd_stat->st_size)
 591         {
 592             free (cache);
 593             return NULL;
 594         }
 595         allocated = FcTrue;
 596     }
 597     if (cache->magic != FC_CACHE_MAGIC_MMAP ||
 598         cache->version < FC_CACHE_CONTENT_VERSION ||
 599         cache->size != fd_stat->st_size ||
 600         !FcCacheTimeValid (cache, dir_stat) ||
 601         !FcCacheInsert (cache, fd_stat))
 602     {
 603         if (allocated)
 604             free (cache);
 605         else
 606         {
 607 #if defined(HAVE_MMAP) || defined(__CYGWIN__)
 608             munmap (cache, fd_stat->st_size);
 609 #elif defined(_WIN32)
 610             UnmapViewOfFile (cache);
 611 #endif
 612         }
 613         return NULL;
 614     }
 615
 616     /* Mark allocated caches so they're freed rather than unmapped */
 617     if (allocated)
 618         cache->magic = FC_CACHE_MAGIC_ALLOC;
 619
 620     return cache;
 621 }
 622
 623 void
 624 FcDirCacheReference (FcCache *cache, int nref)
 625 {
 626     FcCacheSkip *skip = FcCacheFindByAddr (cache);
 627
 628     if (skip)
 629         skip->ref += nref;
 630 }
 631
 632 void
 633 FcDirCacheUnload (FcCache *cache)
 634 {
 635     FcCacheObjectDereference (cache);
 636 }
 637
 638 static FcBool
 639 FcDirCacheMapHelper (int fd, struct stat *fd_stat, struct stat *dir_stat, void *closure)
 640 {
 641     FcCache *cache = FcDirCacheMapFd (fd, fd_stat, dir_stat);
 642
 643     if (!cache)
 644         return FcFalse;
 645     *((FcCache **) closure) = cache;
 646     return FcTrue;
 647 }
 648
 649 FcCache *
 650 FcDirCacheLoad (const FcChar8 *dir, FcConfig *config, FcChar8 **cache_file)
 651 {
 652     FcCache *cache = NULL;
 653
 654     if (!FcDirCacheProcess (config, dir,
 655                             FcDirCacheMapHelper,
 656                             &cache, cache_file))
 657         return NULL;
 658     return cache;
 659 }
 660
 661 FcCache *
 662 FcDirCacheLoadFile (const FcChar8 *cache_file, struct stat *file_stat)
 663 {
 664     int fd;
 665     FcCache *cache;
 666     struct stat my_file_stat;
 667
 668     if (!file_stat)
 669         file_stat = &my_file_stat;
 670     fd = FcDirCacheOpenFile (cache_file, file_stat);
 671     if (fd < 0)
 672         return NULL;
 673     cache = FcDirCacheMapFd (fd, file_stat, NULL);
 674     close (fd);
 675     return cache;
 676 }
 677
 678 /*
 679  * Validate a cache file by reading the header and checking
 680  * the magic number and the size field
 681  */
 682 static FcBool
 683 FcDirCacheValidateHelper (int fd, struct stat *fd_stat, struct stat *dir_stat, void *closure)
 684 {
 685     FcBool  ret = FcTrue;
 686     FcCache     c;
 687
 688     if (read (fd, &c, sizeof (FcCache)) != sizeof (FcCache))
 689         ret = FcFalse;
 690     else if (c.magic != FC_CACHE_MAGIC_MMAP)
 691         ret = FcFalse;
 692     else if (c.version < FC_CACHE_CONTENT_VERSION)
 693         ret = FcFalse;
 694     else if (fd_stat->st_size != c.size)
 695         ret = FcFalse;
 696     else if (c.mtime != (int) dir_stat->st_mtime)
 697         ret = FcFalse;
 698     return ret;
 699 }
 700
 701 static FcBool
 702 FcDirCacheValidConfig (const FcChar8 *dir, FcConfig *config)
 703 {
 704     return FcDirCacheProcess (config, dir,
 705                               FcDirCacheValidateHelper,
 706                               NULL, NULL);
 707 }
 708
 709 FcBool
 710 FcDirCacheValid (const FcChar8 *dir)
 711 {
 712     FcConfig    *config;
 713
 714     config = FcConfigGetCurrent ();
 715     if (!config)
 716         return FcFalse;
 717
 718     return FcDirCacheValidConfig (dir, config);
 719 }
 720
 721 /*
 722  * Build a cache structure from the given contents
 723  */
 724 FcCache *
 725 FcDirCacheBuild (FcFontSet *set, const FcChar8 *dir, struct stat *dir_stat, FcStrSet *dirs)
 726 {
 727     FcSerialize *serialize = FcSerializeCreate ();
 728     FcCache *cache;
 729     int i;
 730     intptr_t    cache_offset;
 731     intptr_t    dirs_offset;
 732     FcChar8     *dir_serialize;
 733     intptr_t    *dirs_serialize;
 734     FcFontSet   *set_serialize;
 735
 736     if (!serialize)
 737         return NULL;
 738     /*
 739      * Space for cache structure
 740      */
 741     cache_offset = FcSerializeReserve (serialize, sizeof (FcCache));
 742     /*
 743      * Directory name
 744      */
 745     if (!FcStrSerializeAlloc (serialize, dir))
 746         goto bail1;
 747     /*
 748      * Subdirs
 749      */
 750     dirs_offset = FcSerializeAlloc (serialize, dirs, dirs->num * sizeof (FcChar8 *));
 751     for (i = 0; i < dirs->num; i++)
 752         if (!FcStrSerializeAlloc (serialize, dirs->strs[i]))
 753             goto bail1;
 754
 755     /*
 756      * Patterns
 757      */
 758     if (!FcFontSetSerializeAlloc (serialize, set))
 759         goto bail1;
 760
 761     /* Serialize layout complete. Now allocate space and fill it */
 762     cache = malloc (serialize->size);
 763     if (!cache)
 764         goto bail1;
 765     /* shut up valgrind */
 766     memset (cache, 0, serialize->size);
 767
 768     serialize->linear = cache;
 769
 770     cache->magic = FC_CACHE_MAGIC_ALLOC;
 771     cache->version = FC_CACHE_CONTENT_VERSION;
 772     cache->size = serialize->size;
 773     cache->mtime = (int) dir_stat->st_mtime;
 774
 775     /*
 776      * Serialize directory name
 777      */
 778     dir_serialize = FcStrSerialize (serialize, dir);
 779     if (!dir_serialize)
 780         goto bail2;
 781     cache->dir = FcPtrToOffset (cache, dir_serialize);
 782
 783     /*
 784      * Serialize sub dirs
 785      */
 786     dirs_serialize = FcSerializePtr (serialize, dirs);
 787     if (!dirs_serialize)
 788         goto bail2;
 789     cache->dirs = FcPtrToOffset (cache, dirs_serialize);
 790     cache->dirs_count = dirs->num;
 791     for (i = 0; i < dirs->num; i++)
 792     {
 793         FcChar8 *d_serialize = FcStrSerialize (serialize, dirs->strs[i]);
 794         if (!d_serialize)
 795             goto bail2;
 796         dirs_serialize[i] = FcPtrToOffset (dirs_serialize, d_serialize);
 797     }
 798
 799     /*
 800      * Serialize font set
 801      */
 802     set_serialize = FcFontSetSerialize (serialize, set);
 803     if (!set_serialize)
 804         goto bail2;
 805     cache->set = FcPtrToOffset (cache, set_serialize);
 806
 807     FcSerializeDestroy (serialize);
 808
 809     FcCacheInsert (cache, NULL);
 810
 811     return cache;
 812
 813 bail2:
 814     free (cache);
 815 bail1:
 816     FcSerializeDestroy (serialize);
 817     return NULL;
 818 }
 819
 820
 821 #ifdef _WIN32
 822 #define mkdir(path,mode) _mkdir(path)
 823 #endif
 824
 825 static FcBool
 826 FcMakeDirectory (const FcChar8 *dir)
 827 {
 828     FcChar8 *parent;
 829     FcBool  ret;
 830
 831     if (strlen ((char *) dir) == 0)
 832         return FcFalse;
 833
 834     parent = FcStrDirname (dir);
 835     if (!parent)
 836         return FcFalse;
 837     if (access ((char *) parent, F_OK) == 0)
 838         ret = mkdir ((char *) dir, 0755) == 0 && chmod ((char *) dir, 0755) == 0;
 839     else if (access ((char *) parent, F_OK) == -1)
 840         ret = FcMakeDirectory (parent) && (mkdir ((char *) dir, 0755) == 0) && chmod ((char *) dir, 0755) == 0;
 841     else
 842         ret = FcFalse;
 843     FcStrFree (parent);
 844     return ret;
 845 }
 846
 847 /* write serialized state to the cache file */
 848 FcBool
 849 FcDirCacheWrite (FcCache *cache, FcConfig *config)
 850 {
 851     FcChar8         *dir = FcCacheDir (cache);
 852     FcChar8         cache_base[CACHEBASE_LEN];
 853     FcChar8         *cache_hashed;
 854     int             fd;
 855     FcAtomic        *atomic;
 856     FcStrList       *list;
 857     FcChar8         *cache_dir = NULL;
 858     FcChar8         *test_dir;
 859     FcCacheSkip     *skip;
 860     struct stat     cache_stat;
 861     int             magic;
 862     int             written;
 863
 864     /*
 865      * Write it to the first directory in the list which is writable
 866      */
 867
 868     list = FcStrListCreate (config->cacheDirs);
 869     if (!list)
 870         return FcFalse;
 871     while ((test_dir = FcStrListNext (list))) {
 872         if (access ((char *) test_dir, W_OK|X_OK) == 0)
 873         {
 874             cache_dir = test_dir;
 875             break;
 876         }
 877         else
 878         {
 879             /*
 880              * If the directory doesn't exist, try to create it
 881              */
 882             if (access ((char *) test_dir, F_OK) == -1) {
 883                 if (FcMakeDirectory (test_dir))
 884                 {
 885                     cache_dir = test_dir;
 886                     break;
 887                 }
 888             }
 889             /*
 890              * Otherwise, try making it writable
 891              */
 892             else if (chmod ((char *) test_dir, 0755) == 0)
 893             {
 894                 cache_dir = test_dir;
 895                 break;
 896             }
 897         }
 898     }
 899     FcStrListDone (list);
 900     if (!cache_dir)
 901         return FcFalse;
 902
 903     FcDirCacheBasename (dir, cache_base);
 904     cache_hashed = FcStrPlus (cache_dir, cache_base);
 905     if (!cache_hashed)
 906         return FcFalse;
 907
 908     if (FcDebug () & FC_DBG_CACHE)
 909         printf ("FcDirCacheWriteDir dir \"%s\" file \"%s\"\n",
 910                 dir, cache_hashed);
 911
 912     atomic = FcAtomicCreate ((FcChar8 *)cache_hashed);
 913     if (!atomic)
 914         goto bail1;
 915
 916     if (!FcAtomicLock (atomic))
 917         goto bail3;
 918
 919     fd = open((char *)FcAtomicNewFile (atomic), O_RDWR | O_CREAT | O_BINARY, 0666);
 920     if (fd == -1)
 921         goto bail4;
 922
 923     /* Temporarily switch magic to MMAP while writing to file */
 924     magic = cache->magic;
 925     if (magic != FC_CACHE_MAGIC_MMAP)
 926         cache->magic = FC_CACHE_MAGIC_MMAP;
 927
 928     /*
 929      * Write cache contents to file
 930      */
 931     written = write (fd, cache, cache->size);
 932
 933     /* Switch magic back */
 934     if (magic != FC_CACHE_MAGIC_MMAP)
 935         cache->magic = magic;
 936
 937     if (written != cache->size)
 938     {
 939         perror ("write cache");
 940         goto bail5;
 941     }
 942
 943     close(fd);
 944     if (!FcAtomicReplaceOrig(atomic))
 945         goto bail4;
 946
 947     /* If the file is small, update the cache chain entry such that the
 948      * new cache file is not read again.  If it's large, we don't do that
 949      * such that we reload it, using mmap, which is shared across processes.
 950      */
 951     if (cache->size < FC_CACHE_MIN_MMAP &&
 952         (skip = FcCacheFindByAddr (cache)) &&
 953         FcStat (cache_hashed, &cache_stat))
 954     {
 955         skip->cache_dev = cache_stat.st_dev;
 956         skip->cache_ino = cache_stat.st_ino;
 957         skip->cache_mtime = cache_stat.st_mtime;
 958     }
 959
 960     FcStrFree (cache_hashed);
 961     FcAtomicUnlock (atomic);
 962     FcAtomicDestroy (atomic);
 963     return FcTrue;
 964
 965  bail5:
 966     close (fd);
 967  bail4:
 968     FcAtomicUnlock (atomic);
 969  bail3:
 970     FcAtomicDestroy (atomic);
 971  bail1:
 972     FcStrFree (cache_hashed);
 973     return FcFalse;
 974 }
 975
 976 /*
 977  * Hokey little macro trick to permit the definitions of C functions
 978  * with the same name as CPP macros
 979  */
 980 #define args1(x)            (x)
 981 #define args2(x,y)          (x,y)
 982
 983 const FcChar8 *
 984 FcCacheDir args1(const FcCache *c)
 985 {
 986     return FcCacheDir (c);
 987 }
 988
 989 FcFontSet *
 990 FcCacheCopySet args1(const FcCache *c)
 991 {
 992     FcFontSet   *old = FcCacheSet (c);
 993     FcFontSet   *new = FcFontSetCreate ();
 994     int         i;
 995
 996     if (!new)
 997         return NULL;
 998     for (i = 0; i < old->nfont; i++)
 999     {
1000         FcPattern   *font = FcFontSetFont (old, i);
1001
1002         FcPatternReference (font);
1003         if (!FcFontSetAdd (new, font))
1004         {
1005             FcFontSetDestroy (new);
1006             return NULL;
1007         }
1008     }
1009     return new;
1010 }
1011
1012 const FcChar8 *
1013 FcCacheSubdir args2(const FcCache *c, int i)
1014 {
1015     return FcCacheSubdir (c, i);
1016 }
1017
1018 int
1019 FcCacheNumSubdir args1(const FcCache *c)
1020 {
1021     return c->dirs_count;
1022 }
1023
1024 int
1025 FcCacheNumFont args1(const FcCache *c)
1026 {
1027     return FcCacheSet(c)->nfont;
1028 }
1029
1030 /*
1031  * This code implements the MD5 message-digest algorithm.
1032  * The algorithm is due to Ron Rivest.  This code was
1033  * written by Colin Plumb in 1993, no copyright is claimed.
1034  * This code is in the public domain; do with it what you wish.
1035  *
1036  * Equivalent code is available from RSA Data Security, Inc.
1037  * This code has been tested against that, and is equivalent,
1038  * except that you don't need to include two pages of legalese
1039  * with every copy.
1040  *
1041  * To compute the message digest of a chunk of bytes, declare an
1042  * MD5Context structure, pass it to MD5Init, call MD5Update as
1043  * needed on buffers full of bytes, and then call MD5Final, which
1044  * will fill a supplied 16-byte array with the digest.
1045  */
1046
1047 #ifndef HIGHFIRST
1048 #define byteReverse(buf, len)   /* Nothing */
1049 #else
1050 /*
1051  * Note: this code is harmless on little-endian machines.
1052  */
1053 void byteReverse(unsigned char *buf, unsigned longs)
1054 {
1055     FcChar32 t;
1056     do {
1057         t = (FcChar32) ((unsigned) buf[3] << 8 | buf[2]) << 16 |
1058             ((unsigned) buf[1] << 8 | buf[0]);
1059         *(FcChar32 *) buf = t;
1060         buf += 4;
1061     } while (--longs);
1062 }
1063 #endif
1064
1065 /*
1066  * Start MD5 accumulation.  Set bit count to 0 and buffer to mysterious
1067  * initialization constants.
1068  */
1069 static void MD5Init(struct MD5Context *ctx)
1070 {
1071     ctx->buf[0] = 0x67452301;
1072     ctx->buf[1] = 0xefcdab89;
1073     ctx->buf[2] = 0x98badcfe;
1074     ctx->buf[3] = 0x10325476;
1075
1076     ctx->bits[0] = 0;
1077     ctx->bits[1] = 0;
1078 }
1079
1080 /*
1081  * Update context to reflect the concatenation of another buffer full
1082  * of bytes.
1083  */
1084 static void MD5Update(struct MD5Context *ctx, const unsigned char *buf, unsigned len)
1085 {
1086     FcChar32 t;
1087
1088     /* Update bitcount */
1089
1090     t = ctx->bits[0];
1091     if ((ctx->bits[0] = t + ((FcChar32) len << 3)) < t)
1092         ctx->bits[1]++;         /* Carry from low to high */
1093     ctx->bits[1] += len >> 29;
1094
1095     t = (t >> 3) & 0x3f;        /* Bytes already in shsInfo->data */
1096
1097     /* Handle any leading odd-sized chunks */
1098
1099     if (t) {
1100         unsigned char *p = (unsigned char *) ctx->in + t;
1101
1102         t = 64 - t;
1103         if (len < t) {
1104             memcpy(p, buf, len);
1105             return;
1106         }
1107         memcpy(p, buf, t);
1108         byteReverse(ctx->in, 16);
1109         MD5Transform(ctx->buf, (FcChar32 *) ctx->in);
1110         buf += t;
1111         len -= t;
1112     }
1113     /* Process data in 64-byte chunks */
1114
1115     while (len >= 64) {
1116         memcpy(ctx->in, buf, 64);
1117         byteReverse(ctx->in, 16);
1118         MD5Transform(ctx->buf, (FcChar32 *) ctx->in);
1119         buf += 64;
1120         len -= 64;
1121     }
1122
1123     /* Handle any remaining bytes of data. */
1124
1125     memcpy(ctx->in, buf, len);
1126 }
1127
1128 /*
1129  * Final wrapup - pad to 64-byte boundary with the bit pattern
1130  * 1 0* (64-bit count of bits processed, MSB-first)
1131  */
1132 static void MD5Final(unsigned char digest[16], struct MD5Context *ctx)
1133 {
1134     unsigned count;
1135     unsigned char *p;
1136
1137     /* Compute number of bytes mod 64 */
1138     count = (ctx->bits[0] >> 3) & 0x3F;
1139
1140     /* Set the first char of padding to 0x80.  This is safe since there is
1141        always at least one byte free */
1142     p = ctx->in + count;
1143     *p++ = 0x80;
1144
1145     /* Bytes of padding needed to make 64 bytes */
1146     count = 64 - 1 - count;
1147
1148     /* Pad out to 56 mod 64 */
1149     if (count < 8) {
1150         /* Two lots of padding:  Pad the first block to 64 bytes */
1151         memset(p, 0, count);
1152         byteReverse(ctx->in, 16);
1153         MD5Transform(ctx->buf, (FcChar32 *) ctx->in);
1154
1155         /* Now fill the next block with 56 bytes */
1156         memset(ctx->in, 0, 56);
1157     } else {
1158         /* Pad block to 56 bytes */
1159         memset(p, 0, count - 8);
1160     }
1161     byteReverse(ctx->in, 14);
1162
1163     /* Append length in bits and transform */
1164     ((FcChar32 *) ctx->in)[14] = ctx->bits[0];
1165     ((FcChar32 *) ctx->in)[15] = ctx->bits[1];
1166
1167     MD5Transform(ctx->buf, (FcChar32 *) ctx->in);
1168     byteReverse((unsigned char *) ctx->buf, 4);
1169     memcpy(digest, ctx->buf, 16);
1170     memset(ctx, 0, sizeof(*ctx));        /* In case it's sensitive */
1171 }
1172
1173
1174 /* The four core functions - F1 is optimized somewhat */
1175
1176 /* #define F1(x, y, z) (x & y | ~x & z) */
1177 #define F1(x, y, z) (z ^ (x & (y ^ z)))
1178 #define F2(x, y, z) F1(z, x, y)
1179 #define F3(x, y, z) (x ^ y ^ z)
1180 #define F4(x, y, z) (y ^ (x | ~z))
1181
1182 /* This is the central step in the MD5 algorithm. */
1183 #define MD5STEP(f, w, x, y, z, data, s) \
1184         ( w += f(x, y, z) + data,  w = w<<s | w>>(32-s),  w += x )
1185
1186 /*
1187  * The core of the MD5 algorithm, this alters an existing MD5 hash to
1188  * reflect the addition of 16 longwords of new data.  MD5Update blocks
1189  * the data and converts bytes into longwords for this routine.
1190  */
1191 static void MD5Transform(FcChar32 buf[4], FcChar32 in[16])
1192 {
1193     register FcChar32 a, b, c, d;
1194
1195     a = buf[0];
1196     b = buf[1];
1197     c = buf[2];
1198     d = buf[3];
1199
1200     MD5STEP(F1, a, b, c, d, in[0] + 0xd76aa478, 7);
1201     MD5STEP(F1, d, a, b, c, in[1] + 0xe8c7b756, 12);
1202     MD5STEP(F1, c, d, a, b, in[2] + 0x242070db, 17);
1203     MD5STEP(F1, b, c, d, a, in[3] + 0xc1bdceee, 22);
1204     MD5STEP(F1, a, b, c, d, in[4] + 0xf57c0faf, 7);
1205     MD5STEP(F1, d, a, b, c, in[5] + 0x4787c62a, 12);
1206     MD5STEP(F1, c, d, a, b, in[6] + 0xa8304613, 17);
1207     MD5STEP(F1, b, c, d, a, in[7] + 0xfd469501, 22);
1208     MD5STEP(F1, a, b, c, d, in[8] + 0x698098d8, 7);
1209     MD5STEP(F1, d, a, b, c, in[9] + 0x8b44f7af, 12);
1210     MD5STEP(F1, c, d, a, b, in[10] + 0xffff5bb1, 17);
1211     MD5STEP(F1, b, c, d, a, in[11] + 0x895cd7be, 22);
1212     MD5STEP(F1, a, b, c, d, in[12] + 0x6b901122, 7);
1213     MD5STEP(F1, d, a, b, c, in[13] + 0xfd987193, 12);
1214     MD5STEP(F1, c, d, a, b, in[14] + 0xa679438e, 17);
1215     MD5STEP(F1, b, c, d, a, in[15] + 0x49b40821, 22);
1216
1217     MD5STEP(F2, a, b, c, d, in[1] + 0xf61e2562, 5);
1218     MD5STEP(F2, d, a, b, c, in[6] + 0xc040b340, 9);
1219     MD5STEP(F2, c, d, a, b, in[11] + 0x265e5a51, 14);
1220     MD5STEP(F2, b, c, d, a, in[0] + 0xe9b6c7aa, 20);
1221     MD5STEP(F2, a, b, c, d, in[5] + 0xd62f105d, 5);
1222     MD5STEP(F2, d, a, b, c, in[10] + 0x02441453, 9);
1223     MD5STEP(F2, c, d, a, b, in[15] + 0xd8a1e681, 14);
1224     MD5STEP(F2, b, c, d, a, in[4] + 0xe7d3fbc8, 20);
1225     MD5STEP(F2, a, b, c, d, in[9] + 0x21e1cde6, 5);
1226     MD5STEP(F2, d, a, b, c, in[14] + 0xc33707d6, 9);
1227     MD5STEP(F2, c, d, a, b, in[3] + 0xf4d50d87, 14);
1228     MD5STEP(F2, b, c, d, a, in[8] + 0x455a14ed, 20);
1229     MD5STEP(F2, a, b, c, d, in[13] + 0xa9e3e905, 5);
1230     MD5STEP(F2, d, a, b, c, in[2] + 0xfcefa3f8, 9);
1231     MD5STEP(F2, c, d, a, b, in[7] + 0x676f02d9, 14);
1232     MD5STEP(F2, b, c, d, a, in[12] + 0x8d2a4c8a, 20);
1233
1234     MD5STEP(F3, a, b, c, d, in[5] + 0xfffa3942, 4);
1235     MD5STEP(F3, d, a, b, c, in[8] + 0x8771f681, 11);
1236     MD5STEP(F3, c, d, a, b, in[11] + 0x6d9d6122, 16);
1237     MD5STEP(F3, b, c, d, a, in[14] + 0xfde5380c, 23);
1238     MD5STEP(F3, a, b, c, d, in[1] + 0xa4beea44, 4);
1239     MD5STEP(F3, d, a, b, c, in[4] + 0x4bdecfa9, 11);
1240     MD5STEP(F3, c, d, a, b, in[7] + 0xf6bb4b60, 16);
1241     MD5STEP(F3, b, c, d, a, in[10] + 0xbebfbc70, 23);
1242     MD5STEP(F3, a, b, c, d, in[13] + 0x289b7ec6, 4);
1243     MD5STEP(F3, d, a, b, c, in[0] + 0xeaa127fa, 11);
1244     MD5STEP(F3, c, d, a, b, in[3] + 0xd4ef3085, 16);
1245     MD5STEP(F3, b, c, d, a, in[6] + 0x04881d05, 23);
1246     MD5STEP(F3, a, b, c, d, in[9] + 0xd9d4d039, 4);
1247     MD5STEP(F3, d, a, b, c, in[12] + 0xe6db99e5, 11);
1248     MD5STEP(F3, c, d, a, b, in[15] + 0x1fa27cf8, 16);
1249     MD5STEP(F3, b, c, d, a, in[2] + 0xc4ac5665, 23);
1250
1251     MD5STEP(F4, a, b, c, d, in[0] + 0xf4292244, 6);
1252     MD5STEP(F4, d, a, b, c, in[7] + 0x432aff97, 10);
1253     MD5STEP(F4, c, d, a, b, in[14] + 0xab9423a7, 15);
1254     MD5STEP(F4, b, c, d, a, in[5] + 0xfc93a039, 21);
1255     MD5STEP(F4, a, b, c, d, in[12] + 0x655b59c3, 6);
1256     MD5STEP(F4, d, a, b, c, in[3] + 0x8f0ccc92, 10);
1257     MD5STEP(F4, c, d, a, b, in[10] + 0xffeff47d, 15);
1258     MD5STEP(F4, b, c, d, a, in[1] + 0x85845dd1, 21);
1259     MD5STEP(F4, a, b, c, d, in[8] + 0x6fa87e4f, 6);
1260     MD5STEP(F4, d, a, b, c, in[15] + 0xfe2ce6e0, 10);
1261     MD5STEP(F4, c, d, a, b, in[6] + 0xa3014314, 15);
1262     MD5STEP(F4, b, c, d, a, in[13] + 0x4e0811a1, 21);
1263     MD5STEP(F4, a, b, c, d, in[4] + 0xf7537e82, 6);
1264     MD5STEP(F4, d, a, b, c, in[11] + 0xbd3af235, 10);
1265     MD5STEP(F4, c, d, a, b, in[2] + 0x2ad7d2bb, 15);
1266     MD5STEP(F4, b, c, d, a, in[9] + 0xeb86d391, 21);
1267
1268     buf[0] += a;
1269     buf[1] += b;
1270     buf[2] += c;
1271     buf[3] += d;
1272 }
1273 #define __fccache__
1274 #include "fcaliastail.h"
1275 #undef __fccache__