19237bbe79ed492527c047821e44acd0c96d8ba9
[kopensolaris-gnu/glibc.git] / elf / cache.c
1 /* Copyright (C) 1999, 2000, 2001 Free Software Foundation, Inc.
2    This file is part of the GNU C Library.
3    Contributed by Andreas Jaeger <aj@suse.de>, 1999.
4
5    The GNU C Library is free software; you can redistribute it and/or
6    modify it under the terms of the GNU Library General Public License as
7    published by the Free Software Foundation; either version 2 of the
8    License, or (at your option) any later version.
9
10    The GNU C Library is distributed in the hope that it will be useful,
11    but WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13    Library General Public License for more details.
14
15    You should have received a copy of the GNU Library General Public
16    License along with the GNU C Library; see the file COPYING.LIB.  If not,
17    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18    Boston, MA 02111-1307, USA.  */
19
20 #include <errno.h>
21 #include <error.h>
22 #include <dirent.h>
23 #include <inttypes.h>
24 #include <libintl.h>
25 #include <stdio.h>
26 #include <stdlib.h>
27 #include <string.h>
28 #include <unistd.h>
29 #include <sys/fcntl.h>
30 #include <sys/mman.h>
31 #include <sys/stat.h>
32 #include <sys/types.h>
33
34 #include "ldconfig.h"
35 #include "dl-cache.h"
36
37 struct cache_entry
38 {
39   char *lib;                    /* Library name.  */
40   char *path;                   /* Path to find library.  */
41   int flags;                    /* Flags to indicate kind of library.  */
42   unsigned int osversion;       /* Required OS version.  */
43   uint64_t hwcap;               /* Important hardware capabilities.  */
44   int bits_hwcap;               /* Number of bits set in hwcap.  */
45   struct cache_entry *next;     /* Next entry in list.  */
46 };
47
48 /* List of all cache entries.  */
49 static struct cache_entry *entries;
50
51 static const char *flag_descr[] =
52 { "libc4", "ELF", "libc5", "libc6"};
53
54 /* Print a single entry.  */
55 static void
56 print_entry (const char *lib, int flag, unsigned int osversion,
57              uint64_t hwcap, const char *key)
58 {
59   printf ("\t%s (", lib);
60   switch (flag & FLAG_TYPE_MASK)
61     {
62     case FLAG_LIBC4:
63     case FLAG_ELF:
64     case FLAG_ELF_LIBC5:
65     case FLAG_ELF_LIBC6:
66       fputs (flag_descr[flag & FLAG_TYPE_MASK], stdout);
67       break;
68     default:
69       fputs ("unknown", stdout);
70       break;
71     }
72   switch (flag & FLAG_REQUIRED_MASK)
73     {
74 #ifdef __sparc__
75     case FLAG_SPARC_LIB64:
76       fputs (",64bit", stdout);
77 #endif
78 #if defined __ia64__ || defined __i386__
79     case FLAG_IA64_LIB64:
80       fputs (",IA-64", stdout);
81 #endif
82     case 0:
83       break;
84     default:
85       printf (",%d", flag & FLAG_REQUIRED_MASK);
86       break;
87     }
88   if (hwcap != 0)
89     printf (", hwcap: 0x%" PRIx64, hwcap);
90   if (osversion != 0)
91     {
92       static const char *const abi_tag_os[] =
93       {
94         [0] = "Linux",
95         [1] = "Hurd",
96         [2] = "Solaris",
97         [3] = "Unknown OS"
98       };
99       unsigned int os = osversion >> 24;
100
101       printf (", OS ABI: %s %d.%d.%d",
102               abi_tag_os[os > 3 ? 3 : os],
103               (osversion >> 16) & 0xff,
104               (osversion >> 8) & 0xff,
105               osversion & 0xff);
106     }
107   printf (") => %s\n", key);
108 }
109
110
111 /* Print the whole cache file, if a file contains the new cache format
112    hidden in the old one, print the contents of the new format.  */
113 void
114 print_cache (const char *cache_name)
115 {
116   size_t cache_size;
117   struct stat64 st;
118   int fd;
119   unsigned int i;
120   struct cache_file *cache;
121   struct cache_file_new *cache_new = NULL;
122   const char *cache_data;
123   int format = 0;
124
125   fd = open (cache_name, O_RDONLY);
126   if (fd < 0)
127     error (EXIT_FAILURE, errno, _("Can't open cache file %s\n"), cache_name);
128
129   if (fstat64 (fd, &st) < 0
130       /* No need to map the file if it is empty.  */
131       || st.st_size == 0)
132     {
133       close (fd);
134       return;
135     }
136
137   cache = mmap (0, st.st_size, PROT_READ, MAP_SHARED, fd, 0);
138   if (cache == MAP_FAILED)
139     error (EXIT_FAILURE, errno, _("mmap of cache file failed.\n"));
140   cache_size = st.st_size;
141
142   if (cache_size < sizeof (struct cache_file))
143     error (EXIT_FAILURE, 0, _("File is not a cache file.\n"));
144
145   if (memcmp (cache->magic, CACHEMAGIC, sizeof CACHEMAGIC - 1))
146     {
147       /* This can only be the new format without the old one.  */
148       cache_new = (struct cache_file_new *) cache;
149
150       if (memcmp (cache_new->magic, CACHEMAGIC_NEW, sizeof CACHEMAGIC_NEW - 1)
151           || memcmp (cache_new->version, CACHE_VERSION,
152                       sizeof CACHE_VERSION - 1))
153         error (EXIT_FAILURE, 0, _("File is not a cache file.\n"));
154       format = 1;
155       /* This is where the strings start.  */
156       cache_data = (const char *) cache_new;
157     }
158   else
159     {
160       size_t offset = ALIGN_CACHE (sizeof (struct cache_file)
161                                    + (cache->nlibs
162                                       * sizeof (struct file_entry)));
163       /* This is where the strings start.  */
164       cache_data = (const char *) &cache->libs[cache->nlibs];
165
166       /* Check for a new cache embedded in the old format.  */
167       if (cache_size >
168           (offset + sizeof (struct cache_file_new)))
169         {
170
171           cache_new = (struct cache_file_new *) ((void *)cache + offset);
172
173           if (memcmp (cache_new->magic, CACHEMAGIC_NEW,
174                       sizeof CACHEMAGIC_NEW - 1) == 0
175               && memcmp (cache_new->version, CACHE_VERSION,
176                          sizeof CACHE_VERSION - 1) == 0)
177             {
178               cache_data = (const char *) cache_new;
179               format = 1;
180             }
181         }
182     }
183
184   if (format == 0)
185     {
186       printf (_("%d libs found in cache `%s'\n"), cache->nlibs, cache_name);
187
188       /* Print everything.  */
189       for (i = 0; i < cache->nlibs; i++)
190         print_entry (cache_data + cache->libs[i].key,
191                      cache->libs[i].flags, 0, 0,
192                      cache_data + cache->libs[i].value);
193     }
194   else if (format == 1)
195     {
196       printf (_("%d libs found in cache `%s'\n"),
197               cache_new->nlibs, cache_name);
198
199       /* Print everything.  */
200       for (i = 0; i < cache_new->nlibs; i++)
201         print_entry (cache_data + cache_new->libs[i].key,
202                      cache_new->libs[i].flags,
203                      cache_new->libs[i].osversion,
204                      cache_new->libs[i].hwcap,
205                      cache_data + cache_new->libs[i].value);
206     }
207   /* Cleanup.  */
208   munmap (cache, cache_size);
209   close (fd);
210 }
211
212 /* Initialize cache data structures.  */
213 void
214 init_cache (void)
215 {
216   entries = NULL;
217 }
218
219
220
221 static
222 int compare (const struct cache_entry *e1, const struct cache_entry *e2)
223 {
224   int res;
225
226   /* We need to swap entries here to get the correct sort order.  */
227   res = _dl_cache_libcmp (e2->lib, e1->lib);
228   if (res == 0)
229     {
230       if (e1->flags < e2->flags)
231         return 1;
232       else if (e1->flags > e2->flags)
233         return -1;
234       /* Sort by most specific hwcap.  */
235       else if (e2->bits_hwcap > e1->bits_hwcap)
236         return 1;
237       else if (e2->bits_hwcap < e1->bits_hwcap)
238         return -1;
239       else if (e2->hwcap > e1->hwcap)
240         return 1;
241       else if (e2->hwcap < e1->hwcap)
242         return -1;
243       if (e2->osversion > e1->osversion)
244         return 1;
245       if (e2->osversion < e1->osversion)
246         return -1;
247     }
248   return res;
249 }
250
251 /* Save the contents of the cache.  */
252 void
253 save_cache (const char *cache_name)
254 {
255   struct cache_entry *entry;
256   int fd, idx_old, idx_new;
257   size_t total_strlen, len;
258   char *strings, *str, *temp_name;
259   struct cache_file *file_entries = NULL;
260   struct cache_file_new *file_entries_new = NULL;
261   size_t file_entries_size = 0;
262   size_t file_entries_new_size = 0;
263   unsigned int str_offset;
264   /* Number of cache entries.  */
265   int cache_entry_count = 0;
266   /* Number of normal cache entries.  */
267   int cache_entry_old_count = 0;
268   /* Pad for alignment of cache_file_new.  */
269   size_t pad;
270
271   /* The cache entries are sorted already, save them in this order. */
272
273   /* Count the length of all strings.  */
274   /* The old format doesn't contain hwcap entries and doesn't contain
275      libraries in subdirectories with hwcaps entries.  Count therefore
276      also all entries with hwcap == 0.  */
277   total_strlen = 0;
278   for (entry = entries; entry != NULL; entry = entry->next)
279     {
280       /* Account the final NULs.  */
281       total_strlen += strlen (entry->lib) + strlen (entry->path) + 2;
282       ++cache_entry_count;
283       if (entry->hwcap == 0)
284         ++cache_entry_old_count;
285     }
286
287   /* Create the on disk cache structure.  */
288   /* First an array for all strings.  */
289   strings = (char *)xmalloc (total_strlen);
290
291   if (opt_format != 2)
292     {
293       /* And the list of all entries in the old format.  */
294       file_entries_size = sizeof (struct cache_file)
295         + cache_entry_old_count * sizeof (struct file_entry);
296       file_entries = (struct cache_file *) xmalloc (file_entries_size);
297
298       /* Fill in the header.  */
299       memset (file_entries, 0, sizeof (struct cache_file));
300       memcpy (file_entries->magic, CACHEMAGIC, sizeof CACHEMAGIC - 1);
301
302       file_entries->nlibs = cache_entry_old_count;
303     }
304
305   if (opt_format != 0)
306     {
307       /* And the list of all entries in the new format.  */
308       file_entries_new_size = sizeof (struct cache_file_new)
309         + cache_entry_count * sizeof (struct file_entry_new);
310       file_entries_new =
311         (struct cache_file_new *) xmalloc (file_entries_new_size);
312
313       /* Fill in the header.  */
314       memset (file_entries_new, 0, sizeof (struct cache_file_new));
315       memcpy (file_entries_new->magic, CACHEMAGIC_NEW,
316               sizeof CACHEMAGIC_NEW - 1);
317       memcpy (file_entries_new->version, CACHE_VERSION,
318               sizeof CACHE_VERSION - 1);
319
320       file_entries_new->nlibs = cache_entry_count;
321       file_entries_new->len_strings = total_strlen;
322     }
323
324   pad = ALIGN_CACHE (file_entries_size) - file_entries_size;
325
326   /* If we have both formats, we hide the new format in the strings
327      table, we have to adjust all string indices for this so that
328      old libc5/glibc 2 dynamic linkers just ignore them.  */
329   if (opt_format != 0)
330     str_offset = file_entries_new_size;
331   else
332     str_offset = 0;
333
334   str = strings;
335   for (idx_old = 0, idx_new = 0, entry = entries; entry != NULL;
336        entry = entry->next, ++idx_new)
337     {
338       /* First the library.  */
339       if (opt_format != 2)
340         {
341           file_entries->libs[idx_old].flags = entry->flags;
342           /* XXX: Actually we can optimize here and remove duplicates.  */
343           file_entries->libs[idx_old].key = str_offset + pad;
344         }
345       if (opt_format != 0)
346         {
347           /* We could subtract file_entries_new_size from str_offset -
348              not doing so makes the code easier, the string table
349              always begins at the beginning of the the new cache
350              struct.  */
351           file_entries_new->libs[idx_new].flags = entry->flags;
352           file_entries_new->libs[idx_new].osversion = entry->osversion;
353           file_entries_new->libs[idx_new].hwcap = entry->hwcap;
354           file_entries_new->libs[idx_new].key = str_offset;
355         }
356       len = strlen (entry->lib);
357       str = stpcpy (str, entry->lib);
358       /* Account the final NUL.  */
359       ++str;
360       str_offset += len + 1;
361       /* Then the path.  */
362       if (opt_format != 2)
363         file_entries->libs[idx_old].value = str_offset + pad;
364       if (opt_format != 0)
365         file_entries_new->libs[idx_new].value = str_offset;
366       len = strlen (entry->path);
367       str = stpcpy (str, entry->path);
368       /* Account the final NUL.  */
369       ++str;
370       str_offset += len + 1;
371       /* Ignore entries with hwcap for old format.  */
372       if (entry->hwcap == 0)
373         ++idx_old;
374     }
375
376   /* Write out the cache.  */
377
378   /* Write cache first to a temporary file and rename it later.  */
379   temp_name = xmalloc (strlen (cache_name) + 2);
380   sprintf (temp_name, "%s~", cache_name);
381   /* First remove an old copy if it exists.  */
382   if (unlink (temp_name) && errno != ENOENT)
383     error (EXIT_FAILURE, errno, _("Can't remove old temporary cache file %s"),
384            temp_name);
385
386   /* Create file.  */
387   fd = open (temp_name, O_CREAT|O_WRONLY|O_TRUNC|O_NOFOLLOW,
388              S_IROTH|S_IRGRP|S_IRUSR|S_IWUSR);
389   if (fd < 0)
390     error (EXIT_FAILURE, errno, _("Can't create temporary cache file %s"),
391            temp_name);
392
393   /* Write contents.  */
394   if (opt_format != 2)
395     {
396       if (write (fd, file_entries, file_entries_size)
397           != (ssize_t)file_entries_size)
398         error (EXIT_FAILURE, errno, _("Writing of cache data failed"));
399     }
400   if (opt_format != 0)
401     {
402       /* Align cache.  */
403       if (opt_format != 2)
404         {
405           char zero[pad];
406           if (write (fd, zero, pad) != (ssize_t)pad)
407             error (EXIT_FAILURE, errno, _("Writing of cache data failed"));
408         }
409       if (write (fd, file_entries_new, file_entries_new_size)
410           != (ssize_t)file_entries_new_size)
411         error (EXIT_FAILURE, errno, _("Writing of cache data failed"));
412     }
413
414   if (write (fd, strings, total_strlen) != (ssize_t)total_strlen)
415     error (EXIT_FAILURE, errno, _("Writing of cache data failed."));
416
417   close (fd);
418
419   /* Make sure user can always read cache file */
420   if (chmod (temp_name, S_IROTH|S_IRGRP|S_IRUSR|S_IWUSR))
421     error (EXIT_FAILURE, errno,
422            _("Changing access rights of %s to %#o failed"), temp_name,
423            S_IROTH|S_IRGRP|S_IRUSR|S_IWUSR);
424
425   /* Move temporary to its final location.  */
426   if (rename (temp_name, cache_name))
427     error (EXIT_FAILURE, errno, _("Renaming of %s to %s failed"), temp_name,
428            cache_name);
429
430   /* Free all allocated memory.  */
431   free (file_entries);
432   free (strings);
433
434   while (entries)
435     {
436       entry = entries;
437       free (entry->path);
438       free (entry->lib);
439       entries = entries->next;
440       free (entry);
441     }
442 }
443
444
445 /* Add one library to the cache.  */
446 void
447 add_to_cache (const char *path, const char *lib, int flags,
448               unsigned int osversion, uint64_t hwcap)
449 {
450   struct cache_entry *new_entry, *ptr, *prev;
451   char *full_path;
452   int len, i;
453
454   new_entry = (struct cache_entry *) xmalloc (sizeof (struct cache_entry));
455
456   len = strlen (lib) + strlen (path) + 2;
457
458   full_path = (char *) xmalloc (len);
459   snprintf (full_path, len, "%s/%s", path, lib);
460
461   new_entry->lib = xstrdup (lib);
462   new_entry->path = full_path;
463   new_entry->flags = flags;
464   new_entry->osversion = osversion;
465   new_entry->hwcap = hwcap;
466   new_entry->bits_hwcap = 0;
467
468   /* Count the number of bits set in the masked value.  */
469   for (i = 0; (~((1ULL << i) - 1) & hwcap) != 0; ++i)
470     if ((hwcap & (1ULL << i)) != 0)
471       ++new_entry->bits_hwcap;
472
473
474   /* Keep the list sorted - search for right place to insert.  */
475   ptr = entries;
476   prev = entries;
477   while (ptr != NULL)
478     {
479       if (compare (ptr, new_entry) > 0)
480         break;
481       prev = ptr;
482       ptr = ptr->next;
483     }
484   /* Is this the first entry?  */
485   if (ptr == entries)
486     {
487       new_entry->next = entries;
488       entries = new_entry;
489     }
490   else
491     {
492       new_entry->next = prev->next;
493       prev->next = new_entry;
494     }
495 }