libexec/rtld-elf/libmap.c

   1 /*
   2  * $FreeBSD$
   3  */
   4
   5 #include <sys/types.h>
   6 #include <sys/param.h>
   7 #include <sys/fcntl.h>
   8 #include <sys/mman.h>
   9 #include <sys/queue.h>
  10 #include <sys/stat.h>
  11 #include <dirent.h>
  12 #include <errno.h>
  13 #include <stdlib.h>
  14 #include <string.h>
  15
  16 #include "debug.h"
  17 #include "rtld.h"
  18 #include "libmap.h"
  19 #include "paths.h"
  20
  21 TAILQ_HEAD(lm_list, lm);
  22 struct lm {
  23         char *f;
  24         char *t;
  25         TAILQ_ENTRY(lm) lm_link;
  26 };
  27
  28 TAILQ_HEAD(lmp_list, lmp) lmp_head = TAILQ_HEAD_INITIALIZER(lmp_head);
  29 struct lmp {
  30         char *p;
  31         enum { T_EXACT=0, T_BASENAME, T_DIRECTORY } type;
  32         struct lm_list lml;
  33         TAILQ_ENTRY(lmp) lmp_link;
  34 };
  35
  36 static TAILQ_HEAD(lmc_list, lmc) lmc_head = TAILQ_HEAD_INITIALIZER(lmc_head);
  37 struct lmc {
  38         char *path;
  39         dev_t dev;
  40         ino_t ino;
  41         TAILQ_ENTRY(lmc) next;
  42 };
  43
  44 static int lm_count;
  45
  46 static void lmc_parse(char *, size_t);
  47 static void lmc_parse_file(char *);
  48 static void lmc_parse_dir(char *);
  49 static void lm_add(const char *, const char *, const char *);
  50 static void lm_free(struct lm_list *);
  51 static char *lml_find(struct lm_list *, const char *);
  52 static struct lm_list *lmp_find(const char *);
  53 static struct lm_list *lmp_init(char *);
  54 static const char *quickbasename(const char *);
  55
  56 #define iseol(c)        (((c) == '#') || ((c) == '\0') || \
  57                          ((c) == '\n') || ((c) == '\r'))
  58
  59 /*
  60  * Do not use ctype.h macros, which rely on working TLS.  It is
  61  * too early to have thread-local variables functional.
  62  */
  63 #define rtld_isspace(c) ((c) == ' ' || (c) == '\t')
  64
  65 int
  66 lm_init(char *libmap_override)
  67 {
  68         char *p;
  69
  70         dbg("lm_init(\"%s\")", libmap_override);
  71         TAILQ_INIT(&lmp_head);
  72
  73         lmc_parse_file(ld_path_libmap_conf);
  74
  75         if (libmap_override) {
  76                 /*
  77                  * Do some character replacement to make $LDLIBMAP look
  78                  * like a text file, then parse it.
  79                  */
  80                 libmap_override = xstrdup(libmap_override);
  81                 for (p = libmap_override; *p; p++) {
  82                         switch (*p) {
  83                         case '=':
  84                                 *p = ' ';
  85                                 break;
  86                         case ',':
  87                                 *p = '\n';
  88                                 break;
  89                         }
  90                 }
  91                 lmc_parse(libmap_override, p - libmap_override);
  92                 free(libmap_override);
  93         }
  94
  95         return (lm_count == 0);
  96 }
  97
  98 static void
  99 lmc_parse_file(char *path)
 100 {
 101         struct lmc *p;
 102         char *lm_map;
 103         struct stat st;
 104         int fd;
 105
 106         TAILQ_FOREACH(p, &lmc_head, next) {
 107                 if (strcmp(p->path, path) == 0)
 108                         return;
 109         }
 110
 111         fd = open(path, O_RDONLY | O_CLOEXEC);
 112         if (fd == -1) {
 113                 dbg("lm_parse_file: open(\"%s\") failed, %s", path,
 114                     rtld_strerror(errno));
 115                 return;
 116         }
 117         if (fstat(fd, &st) == -1) {
 118                 close(fd);
 119                 dbg("lm_parse_file: fstat(\"%s\") failed, %s", path,
 120                     rtld_strerror(errno));
 121                 return;
 122         }
 123
 124         TAILQ_FOREACH(p, &lmc_head, next) {
 125                 if (p->dev == st.st_dev && p->ino == st.st_ino) {
 126                         close(fd);
 127                         return;
 128                 }
 129         }
 130
 131         lm_map = mmap(NULL, st.st_size, PROT_READ, MAP_PRIVATE, fd, 0);
 132         if (lm_map == (const char *)MAP_FAILED) {
 133                 close(fd);
 134                 dbg("lm_parse_file: mmap(\"%s\") failed, %s", path,
 135                     rtld_strerror(errno));
 136                 return;
 137         }
 138         close(fd);
 139         p = xmalloc(sizeof(struct lmc));
 140         p->path = xstrdup(path);
 141         p->dev = st.st_dev;
 142         p->ino = st.st_ino;
 143         TAILQ_INSERT_HEAD(&lmc_head, p, next);
 144         lmc_parse(lm_map, st.st_size);
 145         munmap(lm_map, st.st_size);
 146 }
 147
 148 static void
 149 lmc_parse_dir(char *idir)
 150 {
 151         DIR *d;
 152         struct dirent *dp;
 153         struct lmc *p;
 154         char conffile[MAXPATHLEN];
 155         char *ext;
 156
 157         TAILQ_FOREACH(p, &lmc_head, next) {
 158                 if (strcmp(p->path, idir) == 0)
 159                         return;
 160         }
 161         d = opendir(idir);
 162         if (d == NULL)
 163                 return;
 164
 165         p = xmalloc(sizeof(struct lmc));
 166         p->path = xstrdup(idir);
 167         p->dev = NODEV;
 168         p->ino = 0;
 169         TAILQ_INSERT_HEAD(&lmc_head, p, next);
 170
 171         while ((dp = readdir(d)) != NULL) {
 172                 if (dp->d_ino == 0)
 173                         continue;
 174                 if (dp->d_type != DT_REG)
 175                         continue;
 176                 ext = strrchr(dp->d_name, '.');
 177                 if (ext == NULL)
 178                         continue;
 179                 if (strcmp(ext, ".conf") != 0)
 180                         continue;
 181                 if (strlcpy(conffile, idir, MAXPATHLEN) >= MAXPATHLEN)
 182                         continue; /* too long */
 183                 if (strlcat(conffile, "/", MAXPATHLEN) >= MAXPATHLEN)
 184                         continue; /* too long */
 185                 if (strlcat(conffile, dp->d_name, MAXPATHLEN) >= MAXPATHLEN)
 186                         continue; /* too long */
 187                 lmc_parse_file(conffile);
 188         }
 189         closedir(d);
 190 }
 191
 192 static void
 193 lmc_parse(char *lm_p, size_t lm_len)
 194 {
 195         char *cp, *f, *t, *c, *p;
 196         char prog[MAXPATHLEN];
 197         /* allow includedir + full length path */
 198         char line[MAXPATHLEN + 13];
 199         size_t cnt;
 200         int i;
 201
 202         cnt = 0;
 203         p = NULL;
 204         while (cnt < lm_len) {
 205                 i = 0;
 206                 while (cnt < lm_len && lm_p[cnt] != '\n' &&
 207                     i < sizeof(line) - 1) {
 208                         line[i] = lm_p[cnt];
 209                         cnt++;
 210                         i++;
 211                 }
 212                 line[i] = '\0';
 213                 while (cnt < lm_len && lm_p[cnt] != '\n')
 214                         cnt++;
 215                 /* skip over nl */
 216                 cnt++;
 217
 218                 cp = &line[0];
 219                 t = f = c = NULL;
 220
 221                 /* Skip over leading space */
 222                 while (rtld_isspace(*cp))
 223                         cp++;
 224
 225                 /* Found a comment or EOL */
 226                 if (iseol(*cp))
 227                         continue;
 228
 229                 /* Found a constraint selector */
 230                 if (*cp == '[') {
 231                         cp++;
 232
 233                         /* Skip leading space */
 234                         while (rtld_isspace(*cp))
 235                                 cp++;
 236
 237                         /* Found comment, EOL or end of selector */
 238                         if  (iseol(*cp) || *cp == ']')
 239                                 continue;
 240
 241                         c = cp++;
 242                         /* Skip to end of word */
 243                         while (!rtld_isspace(*cp) && !iseol(*cp) && *cp != ']')
 244                                 cp++;
 245
 246                         /* Skip and zero out trailing space */
 247                         while (rtld_isspace(*cp))
 248                                 *cp++ = '\0';
 249
 250                         /* Check if there is a closing brace */
 251                         if (*cp != ']')
 252                                 continue;
 253
 254                         /* Terminate string if there was no trailing space */
 255                         *cp++ = '\0';
 256
 257                         /*
 258                          * There should be nothing except whitespace or comment
 259                           from this point to the end of the line.
 260                          */
 261                         while (rtld_isspace(*cp))
 262                                 cp++;
 263                         if (!iseol(*cp))
 264                                 continue;
 265
 266                         if (strlcpy(prog, c, sizeof prog) >= sizeof prog)
 267                                 continue;
 268                         p = prog;
 269                         continue;
 270                 }
 271
 272                 /* Parse the 'from' candidate. */
 273                 f = cp++;
 274                 while (!rtld_isspace(*cp) && !iseol(*cp))
 275                         cp++;
 276
 277                 /* Skip and zero out the trailing whitespace */
 278                 while (rtld_isspace(*cp))
 279                         *cp++ = '\0';
 280
 281                 /* Found a comment or EOL */
 282                 if (iseol(*cp))
 283                         continue;
 284
 285                 /* Parse 'to' mapping */
 286                 t = cp++;
 287                 while (!rtld_isspace(*cp) && !iseol(*cp))
 288                         cp++;
 289
 290                 /* Skip and zero out the trailing whitespace */
 291                 while (rtld_isspace(*cp))
 292                         *cp++ = '\0';
 293
 294                 /* Should be no extra tokens at this point */
 295                 if (!iseol(*cp))
 296                         continue;
 297
 298                 *cp = '\0';
 299                 if (strcmp(f, "includedir") == 0)
 300                         lmc_parse_dir(t);
 301                 else if (strcmp(f, "include") == 0)
 302                         lmc_parse_file(t);
 303                 else
 304                         lm_add(p, f, t);
 305         }
 306 }
 307
 308 static void
 309 lm_free(struct lm_list *lml)
 310 {
 311         struct lm *lm;
 312
 313         dbg("%s(%p)", __func__, lml);
 314
 315         while (!TAILQ_EMPTY(lml)) {
 316                 lm = TAILQ_FIRST(lml);
 317                 TAILQ_REMOVE(lml, lm, lm_link);
 318                 free(lm->f);
 319                 free(lm->t);
 320                 free(lm);
 321         }
 322 }
 323
 324 void
 325 lm_fini(void)
 326 {
 327         struct lmp *lmp;
 328         struct lmc *p;
 329
 330         dbg("%s()", __func__);
 331
 332         while (!TAILQ_EMPTY(&lmc_head)) {
 333                 p = TAILQ_FIRST(&lmc_head);
 334                 TAILQ_REMOVE(&lmc_head, p, next);
 335                 free(p->path);
 336                 free(p);
 337         }
 338
 339         while (!TAILQ_EMPTY(&lmp_head)) {
 340                 lmp = TAILQ_FIRST(&lmp_head);
 341                 TAILQ_REMOVE(&lmp_head, lmp, lmp_link);
 342                 free(lmp->p);
 343                 lm_free(&lmp->lml);
 344                 free(lmp);
 345         }
 346 }
 347
 348 static void
 349 lm_add(const char *p, const char *f, const char *t)
 350 {
 351         struct lm_list *lml;
 352         struct lm *lm;
 353         const char *t1;
 354
 355         if (p == NULL)
 356                 p = "$DEFAULT$";
 357
 358         dbg("%s(\"%s\", \"%s\", \"%s\")", __func__, p, f, t);
 359
 360         if ((lml = lmp_find(p)) == NULL)
 361                 lml = lmp_init(xstrdup(p));
 362
 363         t1 = lml_find(lml, f);
 364         if (t1 == NULL || strcmp(t1, t) != 0) {
 365                 lm = xmalloc(sizeof(struct lm));
 366                 lm->f = xstrdup(f);
 367                 lm->t = xstrdup(t);
 368                 TAILQ_INSERT_HEAD(lml, lm, lm_link);
 369                 lm_count++;
 370         }
 371 }
 372
 373 char *
 374 lm_find(const char *p, const char *f)
 375 {
 376         struct lm_list *lml;
 377         char *t;
 378
 379         dbg("%s(\"%s\", \"%s\")", __func__, p, f);
 380
 381         if (p != NULL && (lml = lmp_find(p)) != NULL) {
 382                 t = lml_find(lml, f);
 383                 if (t != NULL) {
 384                         /*
 385                          * Add a global mapping if we have
 386                          * a successful constrained match.
 387                          */
 388                         lm_add(NULL, f, t);
 389                         return (t);
 390                 }
 391         }
 392         lml = lmp_find("$DEFAULT$");
 393         if (lml != NULL)
 394                 return (lml_find(lml, f));
 395         return (NULL);
 396 }
 397
 398 /*
 399  * Given a libmap translation list and a library name, return the
 400  * replacement library, or NULL.
 401  */
 402 char *
 403 lm_findn(const char *p, const char *f, const int n)
 404 {
 405         char pathbuf[64], *s, *t;
 406
 407         if (n < sizeof(pathbuf) - 1)
 408                 s = pathbuf;
 409         else
 410                 s = xmalloc(n + 1);
 411         memcpy(s, f, n);
 412         s[n] = '\0';
 413         t = lm_find(p, s);
 414         if (s != pathbuf)
 415                 free(s);
 416         return (t);
 417 }
 418
 419 static char *
 420 lml_find(struct lm_list *lmh, const char *f)
 421 {
 422         struct lm *lm;
 423
 424         dbg("%s(%p, \"%s\")", __func__, lmh, f);
 425
 426         TAILQ_FOREACH(lm, lmh, lm_link) {
 427                 if (strcmp(f, lm->f) == 0)
 428                         return (lm->t);
 429         }
 430         return (NULL);
 431 }
 432
 433 /*
 434  * Given an executable name, return a pointer to the translation list or
 435  * NULL if no matches.
 436  */
 437 static struct lm_list *
 438 lmp_find(const char *n)
 439 {
 440         struct lmp *lmp;
 441
 442         dbg("%s(\"%s\")", __func__, n);
 443
 444         TAILQ_FOREACH(lmp, &lmp_head, lmp_link) {
 445                 if ((lmp->type == T_EXACT && strcmp(n, lmp->p) == 0) ||
 446                     (lmp->type == T_DIRECTORY && strncmp(n, lmp->p,
 447                     strlen(lmp->p)) == 0) ||
 448                     (lmp->type == T_BASENAME && strcmp(quickbasename(n),
 449                     lmp->p) == 0))
 450                         return (&lmp->lml);
 451         }
 452         return (NULL);
 453 }
 454
 455 static struct lm_list *
 456 lmp_init(char *n)
 457 {
 458         struct lmp *lmp;
 459
 460         dbg("%s(\"%s\")", __func__, n);
 461
 462         lmp = xmalloc(sizeof(struct lmp));
 463         lmp->p = n;
 464         if (n[strlen(n) - 1] == '/')
 465                 lmp->type = T_DIRECTORY;
 466         else if (strchr(n,'/') == NULL)
 467                 lmp->type = T_BASENAME;
 468         else
 469                 lmp->type = T_EXACT;
 470         TAILQ_INIT(&lmp->lml);
 471         TAILQ_INSERT_HEAD(&lmp_head, lmp, lmp_link);
 472
 473         return (&lmp->lml);
 474 }
 475
 476 /*
 477  * libc basename is overkill.  Return a pointer to the character after
 478  * the last /, or the original string if there are no slashes.
 479  */
 480 static const char *
 481 quickbasename(const char *path)
 482 {
 483         const char *p;
 484
 485         for (p = path; *path != '\0'; path++) {
 486                 if (*path == '/')
 487                         p = path + 1;
 488         }
 489         return (p);
 490 }