2 * SPDX-License-Identifier: BSD-2-Clause
4 * Copyright (c) 1998 John D. Polstra
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #include <sys/param.h>
30 #include <sys/endian.h>
36 #include <elf-hints.h>
47 #define MAXDIRS 1024 /* Maximum directories in path */
48 #define MAXFILESIZE (16*1024) /* Maximum hints file size */
50 static void add_dir(const char *, const char *, bool);
51 static void read_dirs_from_file(const char *, const char *);
52 static void read_elf_hints(const char *, bool, bool);
53 static void write_elf_hints(const char *);
55 static const char *dirs[MAXDIRS];
61 add_dir(const char *hintsfile, const char *name, bool trusted)
66 /* Do some security checks */
67 if (!trusted && !insecure) {
68 if (stat(name, &stbuf) == -1) {
72 if (stbuf.st_uid != 0) {
73 warnx("%s: ignoring directory not owned by root", name);
76 if ((stbuf.st_mode & S_IWOTH) != 0) {
77 warnx("%s: ignoring world-writable directory", name);
80 if ((stbuf.st_mode & S_IWGRP) != 0) {
81 warnx("%s: ignoring group-writable directory", name);
86 for (i = 0; i < ndirs; i++)
87 if (strcmp(dirs[i], name) == 0)
90 errx(1, "\"%s\": Too many directories in path", hintsfile);
95 list_elf_hints(const char *hintsfile)
100 read_elf_hints(hintsfile, true, false);
101 printf("%s:\n", hintsfile);
102 printf("\tsearch directories:");
103 for (i = 0; i < ndirs; i++)
104 printf("%c%s", i == 0 ? ' ' : ':', dirs[i]);
108 for (i = 0; i < ndirs; i++) {
112 if ((dirp = opendir(dirs[i])) == NULL)
114 while ((dp = readdir(dirp)) != NULL) {
120 /* Name can't be shorter than "libx.so.0" */
121 if ((len = strlen(dp->d_name)) < 9 ||
122 strncmp(dp->d_name, "lib", 3) != 0)
124 name = dp->d_name + 3;
125 vers = dp->d_name + len;
126 while (vers > dp->d_name && isdigit(*(vers-1)))
128 if (vers == dp->d_name + len)
130 if (vers < dp->d_name + 4 ||
131 strncmp(vers - 4, ".so.", 4) != 0)
134 /* We have a valid shared library name. */
135 namelen = (vers - 4) - name;
136 printf("\t%d:-l%.*s.%s => %s/%s\n", nlibs,
137 namelen, name, vers, dirs[i], dp->d_name);
145 read_dirs_from_file(const char *hintsfile, const char *listfile)
148 char buf[MAXPATHLEN];
151 if ((fp = fopen(listfile, "r")) == NULL)
152 err(1, "%s", listfile);
155 while (fgets(buf, sizeof buf, fp) != NULL) {
160 /* Skip leading white space. */
163 if (*cp == '#' || *cp == '\0')
166 /* Advance over the directory name. */
167 while (!isspace(*cp) && *cp != '\0')
169 /* Terminate the string and skip trailing white space. */
175 /* Now we had better be at the end of the line. */
177 warnx("%s:%d: trailing characters ignored",
180 if ((sp = strdup(sp)) == NULL)
181 errx(1, "Out of memory");
182 add_dir(hintsfile, sp, 0);
188 /* Convert between native byte order and forced little resp. big endian. */
189 #define COND_SWAP(n) (is_be ? be32toh(n) : le32toh(n))
192 read_elf_hints(const char *hintsfile, bool must_exist, bool force_be)
197 struct elfhints_hdr *hdr;
203 if ((fd = open(hintsfile, O_RDONLY)) == -1) {
204 if (errno == ENOENT && !must_exist)
206 err(1, "Cannot open \"%s\"", hintsfile);
208 if (fstat(fd, &s) == -1)
209 err(1, "Cannot stat \"%s\"", hintsfile);
210 if (s.st_size > MAXFILESIZE)
211 errx(1, "\"%s\" is unreasonably large", hintsfile);
213 * We use a read-write, private mapping so that we can null-terminate
214 * some strings in it without affecting the underlying file.
216 mapbase = mmap(NULL, s.st_size, PROT_READ|PROT_WRITE,
218 if (mapbase == MAP_FAILED)
219 err(1, "Cannot mmap \"%s\"", hintsfile);
222 hdr = (struct elfhints_hdr *)mapbase;
223 is_be = be32toh(hdr->magic) == ELFHINTS_MAGIC;
224 if (COND_SWAP(hdr->magic) != ELFHINTS_MAGIC)
225 errx(1, "\"%s\": invalid file format", hintsfile);
226 if (force_be && !is_be)
227 errx(1, "\"%s\": incompatible endianness requested", hintsfile);
228 hdr_version = COND_SWAP(hdr->version);
229 if (hdr_version != 1)
230 errx(1, "\"%s\": unrecognized file version (%d)", hintsfile,
233 strtab = (char *)mapbase + COND_SWAP(hdr->strtab);
234 dirlist = strtab + COND_SWAP(hdr->dirlist);
236 if (*dirlist != '\0')
237 while ((p = strsep(&dirlist, ":")) != NULL)
238 add_dir(hintsfile, p, 1);
242 update_elf_hints(const char *hintsfile, int argc, char **argv, bool merge,
249 * Remove "be32toh(1) == 1" from this condition to create
250 * little-endian hints files on all architectures by default.
252 is_be = be32toh(1) == 1 || force_be;
254 read_elf_hints(hintsfile, false, force_be);
255 for (i = 0; i < argc; i++) {
256 if (stat(argv[i], &s) == -1)
257 warn("warning: %s", argv[i]);
258 else if (S_ISREG(s.st_mode))
259 read_dirs_from_file(hintsfile, argv[i]);
261 add_dir(hintsfile, argv[i], 0);
263 write_elf_hints(hintsfile);
267 write_elf_hints(const char *hintsfile)
269 struct elfhints_hdr hdr;
275 if (asprintf(&tempname, "%s.XXXXXX", hintsfile) == -1)
276 errx(1, "Out of memory");
277 if ((fd = mkstemp(tempname)) == -1)
278 err(1, "mkstemp(%s)", tempname);
279 if (fchmod(fd, 0444) == -1)
280 err(1, "fchmod(%s)", tempname);
281 if ((fp = fdopen(fd, "wb")) == NULL)
282 err(1, "fdopen(%s)", tempname);
284 hdr.magic = COND_SWAP(ELFHINTS_MAGIC);
285 hdr.version = COND_SWAP(1);
286 hdr.strtab = COND_SWAP(sizeof hdr);
289 memset(hdr.spare, 0, sizeof hdr.spare);
291 /* Count up the size of the string table. */
293 hdr.strsize += strlen(dirs[0]);
294 for (i = 1; i < ndirs; i++)
295 hdr.strsize += 1 + strlen(dirs[i]);
297 hdr.dirlistlen = COND_SWAP(hdr.strsize);
298 hdr.strsize++; /* For the null terminator */
299 /* convert in-place from native to target endianness */
300 hdr.strsize = COND_SWAP(hdr.strsize);
302 /* Write the header. */
303 if (fwrite(&hdr, 1, sizeof hdr, fp) != sizeof hdr)
304 err(1, "%s: write error", tempname);
305 /* Write the strings. */
307 if (fputs(dirs[0], fp) == EOF)
308 err(1, "%s: write error", tempname);
309 for (i = 1; i < ndirs; i++)
310 if (fprintf(fp, ":%s", dirs[i]) < 0)
311 err(1, "%s: write error", tempname);
313 if (putc('\0', fp) == EOF || fclose(fp) == EOF)
314 err(1, "%s: write error", tempname);
316 if (rename(tempname, hintsfile) == -1)
317 err(1, "rename %s to %s", tempname, hintsfile);