2 * $RCSId: xc/lib/fontconfig/src/fccache.c,v 1.12 2002/08/22 07:36:44 keithp Exp $
4 * Copyright © 2000 Keith Packard
5 * Copyright © 2005 Patrick Lam
7 * Permission to use, copy, modify, distribute, and sell this software and its
8 * documentation for any purpose is hereby granted without fee, provided that
9 * the above copyright notice appear in all copies and that both that
10 * copyright notice and this permission notice appear in supporting
11 * documentation, and that the name of Keith Packard not be used in
12 * advertising or publicity pertaining to distribution of the software without
13 * specific, written prior permission. Keith Packard makes no
14 * representations about the suitability of this software for any purpose. It
15 * is provided "as is" without express or implied warranty.
17 * KEITH PACKARD DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
18 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
19 * EVENT SHALL KEITH PACKARD BE LIABLE FOR ANY SPECIAL, INDIRECT OR
20 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
21 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
22 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
23 * PERFORMANCE OF THIS SOFTWARE.
29 #include <sys/utsname.h>
30 #include <sys/types.h>
34 #define ENDIAN_TEST 0x12345678
35 #define MACHINE_SIGNATURE_SIZE 9 + 5*19 + 1
38 FcCacheSkipToArch (int fd, const char * arch);
41 FcCacheCopyOld (int fd, int fd_orig, off_t start);
44 FcDirCacheProduce (FcFontSet *set, FcCache * metadata);
47 FcDirCacheConsume (int fd, FcFontSet *set);
50 FcDirCacheRead (FcFontSet * set, FcStrSet * dirs, const FcChar8 *dir);
53 FcCacheNextOffset(off_t w);
56 FcCacheMachineSignature (void);
59 FcCacheHaveBank (int bank);
61 #define FC_DBG_CACHE_REF 1024
64 FcCacheReadString (int fd, char *dest, int len)
77 while (read (fd, &c, 1) == 1)
104 FcCacheWriteString (int fd, const char *chars)
106 if (write (fd, chars, strlen(chars)+1) != strlen(chars)+1)
112 FcGlobalCacheDirDestroy (FcGlobalCacheDir *d)
114 FcMemFree (FC_MEM_STRING, strlen (d->name)+1);
116 FcMemFree (FC_MEM_CACHE, sizeof (FcGlobalCacheDir));
121 FcGlobalCacheCreate (void)
123 FcGlobalCache *cache;
125 cache = malloc (sizeof (FcGlobalCache));
128 FcMemAlloc (FC_MEM_CACHE, sizeof (FcGlobalCache));
130 cache->updated = FcFalse;
136 FcGlobalCacheDestroy (FcGlobalCache *cache)
138 FcGlobalCacheDir *d, *next;
140 for (d = cache->dirs; d; d = next)
143 FcGlobalCacheDirDestroy (d);
145 FcMemFree (FC_MEM_CACHE, sizeof (FcGlobalCache));
150 FcGlobalCacheLoad (FcGlobalCache *cache,
152 const FcChar8 *cache_file)
155 FcGlobalCacheDir *d, *next;
156 char * current_arch_machine_name;
157 char candidate_arch_machine_name[MACHINE_SIGNATURE_SIZE + 9];
158 off_t current_arch_start;
160 struct stat cache_stat, dir_stat;
162 if (stat ((char *) cache_file, &cache_stat) < 0)
165 cache->fd = open ((char *) cache_file, O_RDONLY);
169 cache->updated = FcFalse;
171 current_arch_machine_name = FcCacheMachineSignature ();
172 current_arch_start = FcCacheSkipToArch(cache->fd,
173 current_arch_machine_name);
174 if (current_arch_start < 0)
177 lseek (cache->fd, current_arch_start, SEEK_SET);
178 FcCacheReadString (cache->fd, candidate_arch_machine_name,
179 sizeof (candidate_arch_machine_name));
180 if (strlen(candidate_arch_machine_name) == 0)
187 FcCacheReadString (cache->fd, name_buf, sizeof (name_buf));
188 if (!strlen(name_buf))
191 if (stat ((char *) name_buf, &dir_stat) < 0 ||
192 dir_stat.st_mtime > cache_stat.st_mtime)
196 FcStrSetAdd (staleDirs, FcStrCopy ((FcChar8 *)name_buf));
197 read (cache->fd, &md, sizeof (FcCache));
198 lseek (cache->fd, FcCacheNextOffset (lseek(cache->fd, 0, SEEK_CUR)) + md.count, SEEK_SET);
202 d = malloc (sizeof (FcGlobalCacheDir));
206 d->next = cache->dirs;
209 d->name = (char *)FcStrCopy ((FcChar8 *)name_buf);
211 d->offset = lseek (cache->fd, 0, SEEK_CUR);
212 if (read (cache->fd, &d->metadata, sizeof (FcCache)) != sizeof (FcCache))
214 targ = FcCacheNextOffset (lseek(cache->fd, 0, SEEK_CUR)) + d->metadata.count;
215 if (lseek (cache->fd, targ, SEEK_SET) != targ)
221 for (d = cache->dirs; d; d = next)
234 FcGlobalCacheReadDir (FcFontSet *set, FcStrSet *dirs, FcGlobalCache * cache, const char *dir, FcConfig *config)
237 FcBool ret = FcFalse;
242 for (d = cache->dirs; d; d = d->next)
244 if (strncmp (d->name, dir, strlen(dir)) == 0)
246 lseek (cache->fd, d->offset, SEEK_SET);
247 if (!FcDirCacheConsume (cache->fd, set))
249 if (strcmp (d->name, dir) == 0)
258 FcGlobalCacheUpdate (FcGlobalCache *cache,
262 FcGlobalCacheDir * d;
267 for (d = cache->dirs; d; d = d->next)
269 if (strcmp(d->name, name) == 0)
275 d = malloc (sizeof (FcGlobalCacheDir));
278 d->next = cache->dirs;
282 cache->updated = FcTrue;
284 d->name = (char *)FcStrCopy ((FcChar8 *)name);
285 d->ent = FcDirCacheProduce (set, &d->metadata);
291 FcGlobalCacheSave (FcGlobalCache *cache,
292 const FcChar8 *cache_file)
295 FcGlobalCacheDir *dir;
297 off_t current_arch_start = 0, truncate_to;
298 char * current_arch_machine_name, * header;
303 #if defined (HAVE_GETUID) && defined (HAVE_GETEUID)
304 /* Set-UID programs can't safely update the cache */
305 if (getuid () != geteuid ())
309 atomic = FcAtomicCreate (cache_file);
313 if (!FcAtomicLock (atomic))
315 fd = open ((char *) FcAtomicNewFile(atomic), O_RDWR | O_CREAT,
320 fd_orig = open ((char *) FcAtomicOrigFile(atomic), O_RDONLY);
322 current_arch_machine_name = FcCacheMachineSignature ();
324 current_arch_start = 0;
326 current_arch_start = FcCacheSkipToArch (fd_orig,
327 current_arch_machine_name);
329 if (current_arch_start < 0)
330 current_arch_start = FcCacheNextOffset (lseek(fd_orig, 0, SEEK_END));
332 if (!FcCacheCopyOld(fd, fd_orig, current_arch_start))
338 current_arch_start = lseek(fd, 0, SEEK_CUR);
339 if (ftruncate (fd, current_arch_start) == -1)
342 header = malloc (10 + strlen (current_arch_machine_name));
346 truncate_to = current_arch_start + strlen(current_arch_machine_name) + 11;
347 for (dir = cache->dirs; dir; dir = dir->next)
349 truncate_to += strlen(dir->name) + 1;
350 truncate_to += sizeof (FcCache);
351 truncate_to = FcCacheNextOffset (current_arch_start + truncate_to);
352 truncate_to += dir->metadata.count;
354 truncate_to -= current_arch_start;
356 sprintf (header, "%8x ", (int)truncate_to);
357 strcat (header, current_arch_machine_name);
358 if (!FcCacheWriteString (fd, header))
361 for (dir = cache->dirs; dir; dir = dir->next)
365 FcCacheWriteString (fd, dir->name);
366 write (fd, &dir->metadata, sizeof(FcCache));
367 lseek (fd, FcCacheNextOffset (lseek(fd, 0, SEEK_CUR)), SEEK_SET);
368 write (fd, dir->ent, dir->metadata.count);
372 FcCacheWriteString (fd, "");
374 if (close (fd) == -1)
377 if (!FcAtomicReplaceOrig (atomic))
380 FcAtomicUnlock (atomic);
381 FcAtomicDestroy (atomic);
383 cache->updated = FcFalse;
394 FcAtomicDeleteNew (atomic);
396 FcAtomicUnlock (atomic);
398 FcAtomicDestroy (atomic);
402 #define PAGESIZE 8192
404 * Find the next presumably-mmapable offset after the supplied file
408 FcCacheNextOffset(off_t w)
410 if (w % PAGESIZE == 0)
413 return ((w / PAGESIZE)+1)*PAGESIZE;
416 /* return the address of the segment for the provided arch,
417 * or -1 if arch not found */
419 FcCacheSkipToArch (int fd, const char * arch)
421 char candidate_arch_machine_name_count[MACHINE_SIGNATURE_SIZE + 9];
422 char * candidate_arch;
423 off_t current_arch_start = 0;
425 /* skip arches that are not the current arch */
430 if (lseek (fd, current_arch_start, SEEK_SET) != current_arch_start)
433 if (FcCacheReadString (fd, candidate_arch_machine_name_count,
434 sizeof (candidate_arch_machine_name_count)) == 0)
436 if (!strlen(candidate_arch_machine_name_count))
438 bs = strtol(candidate_arch_machine_name_count, &candidate_arch, 16);
440 // count = 0 should probably be distinguished from the !bs condition
441 if (!bs || bs < strlen (candidate_arch_machine_name_count))
444 candidate_arch++; /* skip leading space */
446 if (strcmp (candidate_arch, arch)==0)
447 return current_arch_start;
448 current_arch_start += bs;
454 /* Cuts out the segment at the file pointer (moves everything else
455 * down to cover it), and leaves the file pointer at the end of the
458 FcCacheCopyOld (int fd, int fd_orig, off_t start)
460 char * buf = malloc (8192);
461 char candidate_arch_machine_name[MACHINE_SIGNATURE_SIZE + 9];
463 int c, bytes_skipped;
470 lseek (fd, 0, SEEK_SET); lseek (fd_orig, 0, SEEK_SET);
477 if ((c = read (fd_orig, buf, b)) <= 0)
479 if (write (fd, buf, c) < 0)
486 lseek (fd, start, SEEK_SET);
487 if (FcCacheReadString (fd, candidate_arch_machine_name,
488 sizeof (candidate_arch_machine_name)) == 0)
490 if (!strlen(candidate_arch_machine_name))
493 bs = strtol(candidate_arch_machine_name, 0, 16);
500 lseek (fd, start+bs+bytes_skipped, SEEK_SET);
501 if ((c = read (fd, buf, 8192)) <= 0)
503 lseek (fd, start+bytes_skipped, SEEK_SET);
504 if (write (fd, buf, c) < 0)
509 lseek (fd, start+bytes_skipped, SEEK_SET);
521 FcDirCacheValid (const FcChar8 *dir)
523 FcChar8 *cache_file = FcStrPlus (dir, (FcChar8 *) "/" FC_DIR_CACHE_FILE);
524 struct stat file_stat, dir_stat;
526 off_t current_arch_start;
527 char *current_arch_machine_name;
529 if (stat ((char *) dir, &dir_stat) < 0)
531 FcStrFree (cache_file);
534 if (stat ((char *) cache_file, &file_stat) < 0)
536 FcStrFree (cache_file);
540 current_arch_machine_name = FcCacheMachineSignature();
541 fd = open(cache_file, O_RDONLY);
545 current_arch_start = FcCacheSkipToArch(fd, current_arch_machine_name);
548 if (current_arch_start < 0)
551 FcStrFree (cache_file);
553 * If the directory has been modified more recently than
554 * the cache file, the cache is not valid
556 if (dir_stat.st_mtime - file_stat.st_mtime > 0)
562 FcCacheReadDirs (FcConfig * config, FcGlobalCache * cache,
563 FcStrList *list, FcFontSet * set)
567 FcChar8 *file, *base;
573 * Read in the results from 'list'.
575 while ((dir = FcStrListNext (list)))
578 file = (FcChar8 *) malloc (strlen ((char *) dir) + 1 + FC_MAX_FILE_LEN + 1);
582 strcpy ((char *) file, (char *) dir);
583 strcat ((char *) file, "/");
584 base = file + strlen ((char *) file);
586 subdirs = FcStrSetCreate ();
589 fprintf (stderr, "Can't create directory set\n");
595 if (access ((char *) dir, X_OK) < 0)
603 fprintf (stderr, "\"%s\": ", dir);
607 FcStrSetDestroy (subdirs);
611 if (stat ((char *) dir, &statb) == -1)
613 fprintf (stderr, "\"%s\": ", dir);
615 FcStrSetDestroy (subdirs);
620 if (!S_ISDIR (statb.st_mode))
622 fprintf (stderr, "\"%s\": not a directory, skipping\n", dir);
623 FcStrSetDestroy (subdirs);
627 if (!FcDirCacheValid (dir) || !FcDirCacheRead (set, subdirs, dir))
629 if (FcDebug () & FC_DBG_FONTSET)
630 printf ("cache scan dir %s\n", dir);
632 FcDirScanConfig (set, subdirs, cache,
633 config->blanks, dir, FcFalse, config);
635 sublist = FcStrListCreate (subdirs);
636 FcStrSetDestroy (subdirs);
639 fprintf (stderr, "Can't create subdir list in \"%s\"\n", dir);
644 ret += FcCacheReadDirs (config, cache, sublist, set);
647 FcStrListDone (list);
652 FcCacheRead (FcConfig *config, FcGlobalCache * cache)
654 FcFontSet * s = FcFontSetCreate();
658 if (FcCacheReadDirs (config, cache, FcConfigGetConfigDirs (config), s))
664 FcFontSetDestroy (s);
668 /* read serialized state from the cache file */
670 FcDirCacheRead (FcFontSet * set, FcStrSet * dirs, const FcChar8 *dir)
672 char *cache_file = (char *)FcStrPlus (dir, (FcChar8 *) "/" FC_DIR_CACHE_FILE);
674 char * current_arch_machine_name;
675 char candidate_arch_machine_name[9+MACHINE_SIGNATURE_SIZE];
676 off_t current_arch_start = 0;
677 char subdirName[FC_MAX_FILE_LEN + 1 + 12 + 1];
682 current_arch_machine_name = FcCacheMachineSignature();
683 fd = open(cache_file, O_RDONLY);
687 current_arch_start = FcCacheSkipToArch(fd, current_arch_machine_name);
688 if (current_arch_start < 0)
691 lseek (fd, current_arch_start, SEEK_SET);
692 if (FcCacheReadString (fd, candidate_arch_machine_name,
693 sizeof (candidate_arch_machine_name)) == 0)
696 while (strlen(FcCacheReadString (fd, subdirName, sizeof (subdirName))) > 0)
697 FcStrSetAdd (dirs, (FcChar8 *)subdirName);
699 if (!FcDirCacheConsume (fd, set))
714 FcDirCacheConsume (int fd, FcFontSet *set)
717 void * current_dir_block;
720 read(fd, &metadata, sizeof(FcCache));
721 if (metadata.magic != FC_CACHE_MAGIC)
727 pos = FcCacheNextOffset (lseek(fd, 0, SEEK_CUR));
728 current_dir_block = mmap (0, metadata.count,
729 PROT_READ, MAP_SHARED, fd, pos);
730 if (current_dir_block == MAP_FAILED)
733 if (!FcFontSetUnserialize (metadata, set, current_dir_block))
740 FcDirCacheProduce (FcFontSet *set, FcCache *metadata)
742 void * current_dir_block, * final_dir_block;
743 static unsigned int rand_state = 0;
747 rand_state = time(0L);
748 bank = rand_r(&rand_state);
750 while (FcCacheHaveBank(bank))
751 bank = rand_r(&rand_state);
753 memset (metadata, 0, sizeof(FcCache));
755 metadata->count = FcFontSetNeededBytes (set);
756 metadata->magic = FC_CACHE_MAGIC;
757 metadata->bank = bank;
759 if (!metadata->count) /* not a failure, no fonts to write */
762 current_dir_block = malloc (metadata->count);
763 if (!current_dir_block)
765 final_dir_block = FcFontSetDistributeBytes (metadata, current_dir_block);
767 if ((char *)current_dir_block + metadata->count != final_dir_block)
770 if (!FcFontSetSerialize (bank, set))
773 return current_dir_block;
776 free (current_dir_block);
780 /* write serialized state to the cache file */
782 FcDirCacheWrite (FcFontSet *set, FcStrSet *dirs, const FcChar8 *dir)
784 FcChar8 *cache_file = FcStrPlus (dir, (FcChar8 *) "/" FC_DIR_CACHE_FILE);
785 int fd, fd_orig, i, dirs_count;
788 off_t current_arch_start = 0, truncate_to;
790 char *current_arch_machine_name, * header;
791 void *current_dir_block;
796 current_dir_block = FcDirCacheProduce (set, &metadata);
798 if (metadata.count && !current_dir_block)
801 if (FcDebug () & FC_DBG_CACHE)
802 printf ("FcDirCacheWriteDir cache_file \"%s\"\n", cache_file);
804 atomic = FcAtomicCreate (cache_file);
808 if (!FcAtomicLock (atomic))
811 fd_orig = open((char *)FcAtomicOrigFile (atomic), O_RDONLY, 0666);
813 fd = open((char *)FcAtomicNewFile (atomic), O_RDWR | O_CREAT, 0666);
817 current_arch_machine_name = FcCacheMachineSignature ();
818 current_arch_start = 0;
822 FcCacheSkipToArch(fd_orig, current_arch_machine_name);
824 if (current_arch_start < 0)
825 current_arch_start = FcCacheNextOffset (lseek(fd_orig, 0, SEEK_END));
827 if (fd_orig != -1 && !FcCacheCopyOld(fd, fd_orig, current_arch_start))
833 current_arch_start = lseek(fd, 0, SEEK_CUR);
834 if (ftruncate (fd, current_arch_start) == -1)
837 /* allocate space for subdir names in this block */
839 for (i = 0; i < dirs->size; i++)
840 dirs_count += strlen((char *)dirs->strs[i]) + 1;
843 /* now write the address of the next offset */
844 truncate_to = FcCacheNextOffset (FcCacheNextOffset (current_arch_start + sizeof (FcCache) + dirs_count) + metadata.count) - current_arch_start;
845 header = malloc (10 + strlen (current_arch_machine_name));
848 sprintf (header, "%8x ", (int)truncate_to);
849 strcat (header, current_arch_machine_name);
850 if (!FcCacheWriteString (fd, header))
853 for (i = 0; i < dirs->size; i++)
854 FcCacheWriteString (fd, (char *)dirs->strs[i]);
855 FcCacheWriteString (fd, "");
857 write (fd, &metadata, sizeof(FcCache));
860 lseek (fd, FcCacheNextOffset (lseek(fd, 0, SEEK_END)), SEEK_SET);
861 write (fd, current_dir_block, metadata.count);
862 free (current_dir_block);
865 /* this actually serves to pad out the cache file, if needed */
866 if (ftruncate (fd, current_arch_start + truncate_to) == -1)
870 if (!FcAtomicReplaceOrig(atomic))
872 FcAtomicUnlock (atomic);
873 FcAtomicDestroy (atomic);
881 FcAtomicUnlock (atomic);
883 FcAtomicDestroy (atomic);
885 unlink ((char *)cache_file);
887 if (current_dir_block)
888 free (current_dir_block);
894 FcCacheMachineSignature ()
896 static char buf[MACHINE_SIGNATURE_SIZE];
897 int magic = ENDIAN_TEST;
898 char * m = (char *)&magic;
900 sprintf (buf, "%2x%2x%2x%2x "
901 "%4x %4x %4x %4x %4x %4x %4x %4x %4x %4x %4x %4x "
902 "%4x %4x %4x %4x %4x %4x %4x\n",
903 m[0], m[1], m[2], m[3],
904 (unsigned int)sizeof (char),
905 (unsigned int)sizeof (char *),
906 (unsigned int)sizeof (int),
907 (unsigned int)sizeof (FcPattern),
908 (unsigned int)sizeof (FcPatternEltPtr),
909 (unsigned int)sizeof (struct _FcPatternElt *),
910 (unsigned int)sizeof (FcPatternElt),
911 (unsigned int)sizeof (FcObjectPtr),
912 (unsigned int)sizeof (FcValueListPtr),
913 (unsigned int)sizeof (FcValue),
914 (unsigned int)sizeof (FcValueBinding),
915 (unsigned int)sizeof (struct _FcValueList *),
916 (unsigned int)sizeof (FcCharSet),
917 (unsigned int)sizeof (FcCharLeaf **),
918 (unsigned int)sizeof (FcChar16 *),
919 (unsigned int)sizeof (FcChar16),
920 (unsigned int)sizeof (FcCharLeaf),
921 (unsigned int)sizeof (FcChar32),
922 (unsigned int)sizeof (FcCache));
927 static int banks_ptr = 0, banks_alloc = 0;
928 static int * bankId = 0;
931 FcCacheHaveBank (int bank)
935 if (bank < FC_BANK_FIRST)
938 for (i = 0; i < banks_ptr; i++)
939 if (bankId[i] == bank)
946 FcCacheBankToIndex (int bank)
948 static int lastBank = FC_BANK_DYNAMIC, lastIndex = -1;
952 if (bank == lastBank)
955 for (i = 0; i < banks_ptr; i++)
956 if (bankId[i] == bank)
959 if (banks_ptr >= banks_alloc)
961 b = realloc (bankId, (banks_alloc + 4) * sizeof(int));