lib/libelf/elf_update.c

   1 /*-
   2  * Copyright (c) 2006-2008 Joseph Koshy
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  */
  26
  27 #include <sys/cdefs.h>
  28 __FBSDID("$FreeBSD$");
  29
  30 #include <sys/mman.h>
  31 #include <sys/param.h>
  32
  33 #include <assert.h>
  34 #include <errno.h>
  35 #include <gelf.h>
  36 #include <libelf.h>
  37 #include <stdlib.h>
  38 #include <string.h>
  39 #include <unistd.h>
  40
  41 #include "_libelf.h"
  42
  43 /*
  44  * Update the internal data structures associated with an ELF object.
  45  * Returns the size in bytes the ELF object would occupy in its file
  46  * representation.
  47  *
  48  * After a successful call to this function, the following structures
  49  * are updated:
  50  *
  51  * - The ELF header is updated.
  52  * - All sections are sorted in order of ascending addresses and their
  53  *   section header table entries updated.   An error is signalled
  54  *   if an overlap was detected among sections.
  55  * - All data descriptors associated with a section are sorted in order
  56  *   of ascending addresses.  Overlaps, if detected, are signalled as
  57  *   errors.  Other sanity checks for alignments, section types etc. are
  58  *   made.
  59  *
  60  * After a resync_elf() successfully returns, the ELF descriptor is
  61  * ready for being handed over to _libelf_write_elf().
  62  *
  63  * File alignments:
  64  * PHDR - Addr
  65  * SHDR - Addr
  66  *
  67  * XXX: how do we handle 'flags'.
  68  */
  69
  70 /*
  71  * Compute the extents of a section, by looking at the data
  72  * descriptors associated with it.  The function returns zero if an
  73  * error was detected.  `*rc' holds the maximum file extent seen so
  74  * far.
  75  */
  76 static int
  77 _libelf_compute_section_extents(Elf *e, Elf_Scn *s, off_t *rc)
  78 {
  79         int ec;
  80         Elf_Data *d, *td;
  81         unsigned int elftype;
  82         uint32_t sh_type;
  83         uint64_t d_align;
  84         uint64_t sh_align, sh_entsize, sh_offset, sh_size;
  85         uint64_t scn_size, scn_alignment;
  86
  87         /*
  88          * We need to recompute library private data structures if one
  89          * or more of the following is true:
  90          * - The underlying Shdr structure has been marked `dirty'.  Significant
  91          *   fields include: `sh_offset', `sh_type', `sh_size', `sh_addralign'.
  92          * - The Elf_Data structures part of this section have been marked
  93          *   `dirty'.  Affected members include `d_align', `d_offset', `d_type',
  94          *   and `d_size'.
  95          * - The section as a whole is `dirty', e.g., it has been allocated
  96          *   using elf_newscn(), or if a new Elf_Data structure was added using
  97          *   elf_newdata().
  98          *
  99          * Each of these conditions would result in the ELF_F_DIRTY bit being
 100          * set on the section descriptor's `s_flags' field.
 101          */
 102
 103         ec = e->e_class;
 104
 105         if (ec == ELFCLASS32) {
 106                 sh_type    = s->s_shdr.s_shdr32.sh_type;
 107                 sh_align   = (uint64_t) s->s_shdr.s_shdr32.sh_addralign;
 108                 sh_entsize = (uint64_t) s->s_shdr.s_shdr32.sh_entsize;
 109                 sh_offset  = (uint64_t) s->s_shdr.s_shdr32.sh_offset;
 110                 sh_size    = (uint64_t) s->s_shdr.s_shdr32.sh_size;
 111         } else {
 112                 sh_type    = s->s_shdr.s_shdr64.sh_type;
 113                 sh_align   = s->s_shdr.s_shdr64.sh_addralign;
 114                 sh_entsize = s->s_shdr.s_shdr64.sh_entsize;
 115                 sh_offset  = s->s_shdr.s_shdr64.sh_offset;
 116                 sh_size    = s->s_shdr.s_shdr64.sh_size;
 117         }
 118
 119         if (sh_type == SHT_NULL || sh_type == SHT_NOBITS)
 120                 return (1);
 121
 122         if ((s->s_flags & ELF_F_DIRTY) == 0) {
 123                 if ((size_t) *rc < sh_offset + sh_size)
 124                         *rc = sh_offset + sh_size;
 125                 return (1);
 126         }
 127
 128         elftype = _libelf_xlate_shtype(sh_type);
 129         if (elftype > ELF_T_LAST) {
 130                 LIBELF_SET_ERROR(SECTION, 0);
 131                 return (0);
 132         }
 133
 134         /*
 135          * Compute the extent of the data descriptors associated with
 136          * this section.
 137          */
 138         scn_alignment = 0;
 139         if (sh_align == 0)
 140                 sh_align = _libelf_falign(elftype, ec);
 141
 142         /* Compute the section alignment. */
 143         STAILQ_FOREACH(d, &s->s_data, d_next)  {
 144                 if (d->d_type != elftype) {
 145                         LIBELF_SET_ERROR(DATA, 0);
 146                         return (0);
 147                 }
 148                 if (d->d_version != e->e_version) {
 149                         LIBELF_SET_ERROR(VERSION, 0);
 150                         return (0);
 151                 }
 152                 if ((d_align = d->d_align) % sh_align) {
 153                         LIBELF_SET_ERROR(LAYOUT, 0);
 154                         return (0);
 155                 }
 156                 if (d_align == 0 || (d_align & (d_align - 1))) {
 157                         LIBELF_SET_ERROR(DATA, 0);
 158                         return (0);
 159                 }
 160                 if (d_align > scn_alignment)
 161                         scn_alignment = d_align;
 162         }
 163
 164         scn_size = 0L;
 165
 166         STAILQ_FOREACH_SAFE(d, &s->s_data, d_next, td) {
 167                 if (e->e_flags & ELF_F_LAYOUT) {
 168                         if ((uint64_t) d->d_off + d->d_size > scn_size)
 169                                 scn_size = d->d_off + d->d_size;
 170                 } else {
 171                         scn_size = roundup2(scn_size, scn_alignment);
 172                         d->d_off = scn_size;
 173                         scn_size += d->d_size;
 174                 }
 175         }
 176
 177         /*
 178          * If the application is requesting full control over the layout
 179          * of the section, check its values for sanity.
 180          */
 181         if (e->e_flags & ELF_F_LAYOUT) {
 182                 if (scn_alignment > sh_align || sh_offset % sh_align ||
 183                     sh_size < scn_size) {
 184                         LIBELF_SET_ERROR(LAYOUT, 0);
 185                         return (0);
 186                 }
 187         } else {
 188                 /*
 189                  * Otherwise compute the values in the section header.
 190                  */
 191
 192                 if (scn_alignment > sh_align)
 193                         sh_align = scn_alignment;
 194
 195                 /*
 196                  * If the section entry size is zero, try and fill in an
 197                  * appropriate entry size.  Per the elf(5) manual page
 198                  * sections without fixed-size entries should have their
 199                  * 'sh_entsize' field set to zero.
 200                  */
 201                 if (sh_entsize == 0 &&
 202                     (sh_entsize = _libelf_fsize(elftype, ec, e->e_version,
 203                     (size_t) 1)) == 1)
 204                         sh_entsize = 0;
 205
 206                 sh_size = scn_size;
 207                 sh_offset = roundup(*rc, sh_align);
 208
 209                 if (ec == ELFCLASS32) {
 210                         s->s_shdr.s_shdr32.sh_addralign = (uint32_t) sh_align;
 211                         s->s_shdr.s_shdr32.sh_entsize   = (uint32_t) sh_entsize;
 212                         s->s_shdr.s_shdr32.sh_offset    = (uint32_t) sh_offset;
 213                         s->s_shdr.s_shdr32.sh_size      = (uint32_t) sh_size;
 214                 } else {
 215                         s->s_shdr.s_shdr64.sh_addralign = sh_align;
 216                         s->s_shdr.s_shdr64.sh_entsize   = sh_entsize;
 217                         s->s_shdr.s_shdr64.sh_offset    = sh_offset;
 218                         s->s_shdr.s_shdr64.sh_size      = sh_size;
 219                 }
 220         }
 221
 222         if ((size_t) *rc < sh_offset + sh_size)
 223                 *rc = sh_offset + sh_size;
 224
 225         s->s_size = sh_size;
 226         s->s_offset = sh_offset;
 227         return (1);
 228 }
 229
 230
 231 /*
 232  * Insert a section in ascending order in the list
 233  */
 234
 235 static int
 236 _libelf_insert_section(Elf *e, Elf_Scn *s)
 237 {
 238         Elf_Scn *t, *prevt;
 239         uint64_t smax, smin, tmax, tmin;
 240
 241         smin = s->s_offset;
 242         smax = smin + s->s_size;
 243
 244         prevt = NULL;
 245         STAILQ_FOREACH(t, &e->e_u.e_elf.e_scn, s_next) {
 246                 tmin = t->s_offset;
 247                 tmax = tmin + t->s_size;
 248
 249                 if (tmax <= smin) {
 250                         /*
 251                          * 't' lies entirely before 's': ...| t |...| s |...
 252                          */
 253                         prevt = t;
 254                         continue;
 255                 } else if (smax <= tmin)
 256                         /*
 257                          * 's' lies entirely before 't', and after 'prevt':
 258                          *      ...| prevt |...| s |...| t |...
 259                          */
 260                         break;
 261                 else {  /* 's' and 't' overlap. */
 262                         LIBELF_SET_ERROR(LAYOUT, 0);
 263                         return (0);
 264                 }
 265         }
 266
 267         if (prevt)
 268                 STAILQ_INSERT_AFTER(&e->e_u.e_elf.e_scn, prevt, s, s_next);
 269         else
 270                 STAILQ_INSERT_HEAD(&e->e_u.e_elf.e_scn, s, s_next);
 271         return (1);
 272 }
 273
 274 static off_t
 275 _libelf_resync_sections(Elf *e, off_t rc)
 276 {
 277         int ec;
 278         off_t nrc;
 279         size_t sh_type, shdr_start, shdr_end;
 280         Elf_Scn *s, *ts;
 281
 282         ec = e->e_class;
 283
 284         /*
 285          * Make a pass through sections, computing the extent of each
 286          * section. Order in increasing order of addresses.
 287          */
 288
 289         nrc = rc;
 290         STAILQ_FOREACH(s, &e->e_u.e_elf.e_scn, s_next)
 291                 if (_libelf_compute_section_extents(e, s, &nrc) == 0)
 292                         return ((off_t) -1);
 293
 294         STAILQ_FOREACH_SAFE(s, &e->e_u.e_elf.e_scn, s_next, ts) {
 295                 if (ec == ELFCLASS32)
 296                         sh_type = s->s_shdr.s_shdr32.sh_type;
 297                 else
 298                         sh_type = s->s_shdr.s_shdr64.sh_type;
 299
 300                 /* XXX Do we need the 'size' field of an SHT_NOBITS section */
 301                 if (sh_type == SHT_NOBITS || sh_type == SHT_NULL)
 302                         continue;
 303
 304                 if (s->s_offset < (uint64_t) rc) {
 305                         if (s->s_offset + s->s_size < (uint64_t) rc) {
 306                                 /*
 307                                  * Try insert this section in the
 308                                  * correct place in the list,
 309                                  * detecting overlaps if any.
 310                                  */
 311                                 STAILQ_REMOVE(&e->e_u.e_elf.e_scn, s, _Elf_Scn,
 312                                     s_next);
 313                                 if (_libelf_insert_section(e, s) == 0)
 314                                         return ((off_t) -1);
 315                         } else {
 316                                 LIBELF_SET_ERROR(LAYOUT, 0);
 317                                 return ((off_t) -1);
 318                         }
 319                 } else
 320                         rc = s->s_offset + s->s_size;
 321         }
 322
 323         /*
 324          * If the application is controlling file layout, check for an
 325          * overlap between this section's extents and the SHDR table.
 326          */
 327         if (e->e_flags & ELF_F_LAYOUT) {
 328
 329                 if (e->e_class == ELFCLASS32)
 330                         shdr_start = e->e_u.e_elf.e_ehdr.e_ehdr32->e_shoff;
 331                 else
 332                         shdr_start = e->e_u.e_elf.e_ehdr.e_ehdr64->e_shoff;
 333
 334                 shdr_end = shdr_start + _libelf_fsize(ELF_T_SHDR, e->e_class,
 335                     e->e_version, e->e_u.e_elf.e_nscn);
 336
 337                 STAILQ_FOREACH(s, &e->e_u.e_elf.e_scn, s_next) {
 338                         if (s->s_offset >= shdr_end ||
 339                             s->s_offset + s->s_size <= shdr_start)
 340                                 continue;
 341                         LIBELF_SET_ERROR(LAYOUT, 0);
 342                         return ((off_t) -1);
 343                 }
 344         }
 345
 346         assert(nrc == rc);
 347
 348         return (rc);
 349 }
 350
 351 static off_t
 352 _libelf_resync_elf(Elf *e)
 353 {
 354         int ec, eh_class, eh_type;
 355         unsigned int eh_byteorder, eh_version;
 356         size_t align, fsz;
 357         size_t phnum, shnum;
 358         off_t rc, phoff, shoff;
 359         void *ehdr;
 360         Elf32_Ehdr *eh32;
 361         Elf64_Ehdr *eh64;
 362
 363         rc = 0;
 364
 365         ec = e->e_class;
 366
 367         assert(ec == ELFCLASS32 || ec == ELFCLASS64);
 368
 369         /*
 370          * Prepare the EHDR.
 371          */
 372         if ((ehdr = _libelf_ehdr(e, ec, 0)) == NULL)
 373                 return ((off_t) -1);
 374
 375         eh32 = ehdr;
 376         eh64 = ehdr;
 377
 378         if (ec == ELFCLASS32) {
 379                 eh_byteorder = eh32->e_ident[EI_DATA];
 380                 eh_class     = eh32->e_ident[EI_CLASS];
 381                 phoff        = (uint64_t) eh32->e_phoff;
 382                 shoff        = (uint64_t) eh32->e_shoff;
 383                 eh_type      = eh32->e_type;
 384                 eh_version   = eh32->e_version;
 385         } else {
 386                 eh_byteorder = eh64->e_ident[EI_DATA];
 387                 eh_class     = eh64->e_ident[EI_CLASS];
 388                 phoff        = eh64->e_phoff;
 389                 shoff        = eh64->e_shoff;
 390                 eh_type      = eh64->e_type;
 391                 eh_version   = eh64->e_version;
 392         }
 393
 394         if (eh_version == EV_NONE)
 395                 eh_version = EV_CURRENT;
 396
 397         if (eh_version != e->e_version) {       /* always EV_CURRENT */
 398                 LIBELF_SET_ERROR(VERSION, 0);
 399                 return ((off_t) -1);
 400         }
 401
 402         if (eh_class != e->e_class) {
 403                 LIBELF_SET_ERROR(CLASS, 0);
 404                 return ((off_t) -1);
 405         }
 406
 407         if (e->e_cmd != ELF_C_WRITE && eh_byteorder != e->e_byteorder) {
 408                 LIBELF_SET_ERROR(HEADER, 0);
 409                 return ((off_t) -1);
 410         }
 411
 412         shnum = e->e_u.e_elf.e_nscn;
 413         phnum = e->e_u.e_elf.e_nphdr;
 414
 415         e->e_byteorder = eh_byteorder;
 416
 417 #define INITIALIZE_EHDR(E,EC,V) do {                                    \
 418                 (E)->e_ident[EI_MAG0] = ELFMAG0;                        \
 419                 (E)->e_ident[EI_MAG1] = ELFMAG1;                        \
 420                 (E)->e_ident[EI_MAG2] = ELFMAG2;                        \
 421                 (E)->e_ident[EI_MAG3] = ELFMAG3;                        \
 422                 (E)->e_ident[EI_CLASS] = (EC);                          \
 423                 (E)->e_ident[EI_VERSION] = (V);                         \
 424                 (E)->e_ehsize = _libelf_fsize(ELF_T_EHDR, (EC), (V),    \
 425                     (size_t) 1);                                        \
 426                 (E)->e_phentsize = _libelf_fsize(ELF_T_PHDR, (EC), (V), \
 427                     (size_t) 1);                                        \
 428                 (E)->e_shentsize = _libelf_fsize(ELF_T_SHDR, (EC), (V), \
 429                     (size_t) 1);                                        \
 430         } while (0)
 431
 432         if (ec == ELFCLASS32)
 433                 INITIALIZE_EHDR(eh32, ec, eh_version);
 434         else
 435                 INITIALIZE_EHDR(eh64, ec, eh_version);
 436
 437         (void) elf_flagehdr(e, ELF_C_SET, ELF_F_DIRTY);
 438
 439         rc += _libelf_fsize(ELF_T_EHDR, ec, eh_version, (size_t) 1);
 440
 441         /*
 442          * Compute the layout the program header table, if one is
 443          * present.  The program header table needs to be aligned to a
 444          * `natural' boundary.
 445          */
 446         if (phnum) {
 447                 fsz = _libelf_fsize(ELF_T_PHDR, ec, eh_version, phnum);
 448                 align = _libelf_falign(ELF_T_PHDR, ec);
 449
 450                 if (e->e_flags & ELF_F_LAYOUT) {
 451                         /*
 452                          * Check offsets for sanity.
 453                          */
 454                         if (rc > phoff) {
 455                                 LIBELF_SET_ERROR(HEADER, 0);
 456                                 return ((off_t) -1);
 457                         }
 458
 459                         if (phoff % align) {
 460                                 LIBELF_SET_ERROR(LAYOUT, 0);
 461                                 return ((off_t) -1);
 462                         }
 463
 464                 } else
 465                         phoff = roundup(rc, align);
 466
 467                 rc = phoff + fsz;
 468         } else
 469                 phoff = 0;
 470
 471         /*
 472          * Compute the layout of the sections associated with the
 473          * file.
 474          */
 475
 476         if ((rc = _libelf_resync_sections(e, rc)) < 0)
 477                 return ((off_t) -1);
 478
 479         /*
 480          * Compute the space taken up by the section header table, if
 481          * one is needed.  If ELF_F_LAYOUT is asserted, the
 482          * application may have placed the section header table in
 483          * between existing sections, so the net size of the file need
 484          * not increase due to the presence of the section header
 485          * table.
 486          */
 487         if (shnum) {
 488                 fsz = _libelf_fsize(ELF_T_SHDR, ec, eh_version, (size_t) 1);
 489                 align = _libelf_falign(ELF_T_SHDR, ec);
 490
 491                 if (e->e_flags & ELF_F_LAYOUT) {
 492                         if (shoff % align) {
 493                                 LIBELF_SET_ERROR(LAYOUT, 0);
 494                                 return ((off_t) -1);
 495                         }
 496                 } else
 497                         shoff = roundup(rc, align);
 498
 499                 if (shoff + fsz * shnum > (size_t) rc)
 500                         rc = shoff + fsz * shnum;
 501         } else
 502                 shoff = 0;
 503
 504         /*
 505          * Set the fields of the Executable Header that could potentially use
 506          * extended numbering.
 507          */
 508         _libelf_setphnum(e, ehdr, ec, phnum);
 509         _libelf_setshnum(e, ehdr, ec, shnum);
 510
 511         /*
 512          * Update the `e_phoff' and `e_shoff' fields if the library is
 513          * doing the layout.
 514          */
 515         if ((e->e_flags & ELF_F_LAYOUT) == 0) {
 516                 if (ec == ELFCLASS32) {
 517                         eh32->e_phoff = (uint32_t) phoff;
 518                         eh32->e_shoff = (uint32_t) shoff;
 519                 } else {
 520                         eh64->e_phoff = (uint64_t) phoff;
 521                         eh64->e_shoff = (uint64_t) shoff;
 522                 }
 523         }
 524
 525         return (rc);
 526 }
 527
 528 /*
 529  * Write out the contents of a section.
 530  */
 531
 532 static off_t
 533 _libelf_write_scn(Elf *e, char *nf, Elf_Scn *s, off_t rc)
 534 {
 535         int ec;
 536         size_t fsz, msz, nobjects;
 537         uint32_t sh_type;
 538         uint64_t sh_off;
 539         int elftype;
 540         Elf_Data *d, dst;
 541
 542         if ((ec = e->e_class) == ELFCLASS32)
 543                 sh_type = s->s_shdr.s_shdr32.sh_type;
 544         else
 545                 sh_type = s->s_shdr.s_shdr64.sh_type;
 546
 547         /*
 548          * Ignore sections that do not allocate space in the file.
 549          */
 550         if (sh_type == SHT_NOBITS || sh_type == SHT_NULL)
 551                 return (rc);
 552
 553
 554         elftype = _libelf_xlate_shtype(sh_type);
 555         assert(elftype >= ELF_T_FIRST && elftype <= ELF_T_LAST);
 556
 557         msz = _libelf_msize(elftype, ec, e->e_version);
 558
 559         sh_off = s->s_offset;
 560         assert(sh_off % _libelf_falign(elftype, ec) == 0);
 561
 562         /*
 563          * If the section has a `rawdata' descriptor, and the section
 564          * contents have not been modified, use its contents directly.
 565          * The `s_rawoff' member contains the offset into the original
 566          * file, while `s_offset' contains its new location in the
 567          * destination.
 568          */
 569
 570         if (STAILQ_EMPTY(&s->s_data)) {
 571
 572                 if ((d = elf_rawdata(s, NULL)) == NULL)
 573                         return ((off_t) -1);
 574
 575                 STAILQ_FOREACH(d, &s->s_rawdata, d_next) {
 576                         if ((uint64_t) rc < sh_off + d->d_off)
 577                                 (void) memset(nf + rc,
 578                                     LIBELF_PRIVATE(fillchar), sh_off +
 579                                     d->d_off - rc);
 580                         rc = sh_off + d->d_off;
 581
 582                         assert(d->d_buf != NULL);
 583                         assert(d->d_type == ELF_T_BYTE);
 584                         assert(d->d_version == e->e_version);
 585
 586                         (void) memcpy(nf + rc,
 587                             e->e_rawfile + s->s_rawoff + d->d_off, d->d_size);
 588
 589                         rc += d->d_size;
 590                 }
 591
 592                 return (rc);
 593         }
 594
 595         /*
 596          * Iterate over the set of data descriptors for this section.
 597          * The prior call to _libelf_resync_elf() would have setup the
 598          * descriptors for this step.
 599          */
 600
 601         dst.d_version = e->e_version;
 602
 603         STAILQ_FOREACH(d, &s->s_data, d_next) {
 604
 605                 if ((uint64_t) rc < sh_off + d->d_off)
 606                         (void) memset(nf + rc,
 607                             LIBELF_PRIVATE(fillchar), sh_off + d->d_off - rc);
 608
 609                 rc = sh_off + d->d_off;
 610
 611                 assert(d->d_buf != NULL);
 612                 assert(d->d_type == (Elf_Type) elftype);
 613                 assert(d->d_version == e->e_version);
 614                 assert(d->d_size % msz == 0);
 615
 616                 nobjects = d->d_size / msz;
 617
 618                 fsz = _libelf_fsize(elftype, ec, e->e_version, nobjects);
 619
 620                 dst.d_buf    = nf + rc;
 621                 dst.d_size   = fsz;
 622
 623                 if (_libelf_xlate(&dst, d, e->e_byteorder, ec, ELF_TOFILE) ==
 624                     NULL)
 625                         return ((off_t) -1);
 626
 627                 rc += fsz;
 628         }
 629
 630         return ((off_t) rc);
 631 }
 632
 633 /*
 634  * Write out the file image.
 635  *
 636  * The original file could have been mapped in with an ELF_C_RDWR
 637  * command and the application could have added new content or
 638  * re-arranged its sections before calling elf_update().  Consequently
 639  * its not safe to work `in place' on the original file.  So we
 640  * malloc() the required space for the updated ELF object and build
 641  * the object there and write it out to the underlying file at the
 642  * end.  Note that the application may have opened the underlying file
 643  * in ELF_C_RDWR and only retrieved/modified a few sections.  We take
 644  * care to avoid translating file sections unnecessarily.
 645  *
 646  * Gaps in the coverage of the file by the file's sections will be
 647  * filled with the fill character set by elf_fill(3).
 648  */
 649
 650 static off_t
 651 _libelf_write_elf(Elf *e, off_t newsize)
 652 {
 653         int ec;
 654         off_t maxrc, rc;
 655         size_t fsz, msz, phnum, shnum;
 656         uint64_t phoff, shoff;
 657         void *ehdr;
 658         char *newfile;
 659         Elf_Data dst, src;
 660         Elf_Scn *scn, *tscn;
 661         Elf32_Ehdr *eh32;
 662         Elf64_Ehdr *eh64;
 663
 664         assert(e->e_kind == ELF_K_ELF);
 665         assert(e->e_cmd != ELF_C_READ);
 666         assert(e->e_fd >= 0);
 667
 668         if ((newfile = malloc((size_t) newsize)) == NULL) {
 669                 LIBELF_SET_ERROR(RESOURCE, errno);
 670                 return ((off_t) -1);
 671         }
 672
 673         ec = e->e_class;
 674
 675         ehdr = _libelf_ehdr(e, ec, 0);
 676         assert(ehdr != NULL);
 677
 678         phnum = e->e_u.e_elf.e_nphdr;
 679
 680         if (ec == ELFCLASS32) {
 681                 eh32 = (Elf32_Ehdr *) ehdr;
 682
 683                 phoff = (uint64_t) eh32->e_phoff;
 684                 shnum = eh32->e_shnum;
 685                 shoff = (uint64_t) eh32->e_shoff;
 686         } else {
 687                 eh64 = (Elf64_Ehdr *) ehdr;
 688
 689                 phoff = eh64->e_phoff;
 690                 shnum = eh64->e_shnum;
 691                 shoff = eh64->e_shoff;
 692         }
 693
 694         fsz = _libelf_fsize(ELF_T_EHDR, ec, e->e_version, (size_t) 1);
 695         msz = _libelf_msize(ELF_T_EHDR, ec, e->e_version);
 696
 697         (void) memset(&dst, 0, sizeof(dst));
 698         (void) memset(&src, 0, sizeof(src));
 699
 700         src.d_buf     = ehdr;
 701         src.d_size    = msz;
 702         src.d_type    = ELF_T_EHDR;
 703         src.d_version = dst.d_version = e->e_version;
 704
 705         rc = 0;
 706
 707         dst.d_buf     = newfile + rc;
 708         dst.d_size    = fsz;
 709
 710         if (_libelf_xlate(&dst, &src, e->e_byteorder, ec, ELF_TOFILE) ==
 711             NULL)
 712                 goto error;
 713
 714         rc += fsz;
 715
 716         /*
 717          * Write the program header table if present.
 718          */
 719
 720         if (phnum != 0 && phoff != 0) {
 721                 assert((unsigned) rc <= phoff);
 722
 723                 fsz = _libelf_fsize(ELF_T_PHDR, ec, e->e_version, phnum);
 724
 725                 assert(phoff % _libelf_falign(ELF_T_PHDR, ec) == 0);
 726                 assert(fsz > 0);
 727
 728                 src.d_version = dst.d_version = e->e_version;
 729                 src.d_type = ELF_T_PHDR;
 730
 731                 if (ec == ELFCLASS32)
 732                         src.d_buf = e->e_u.e_elf.e_phdr.e_phdr32;
 733                 else
 734                         src.d_buf = e->e_u.e_elf.e_phdr.e_phdr64;
 735
 736                 src.d_size = phnum * _libelf_msize(ELF_T_PHDR, ec,
 737                     e->e_version);
 738
 739                 dst.d_size = fsz;
 740
 741                 if ((uint64_t) rc < phoff)
 742                         (void) memset(newfile + rc,
 743                             LIBELF_PRIVATE(fillchar), phoff - rc);
 744
 745                 dst.d_buf = newfile + rc;
 746
 747                 if (_libelf_xlate(&dst, &src, e->e_byteorder, ec, ELF_TOFILE) ==
 748                     NULL)
 749                         goto error;
 750
 751                 rc = phoff + fsz;
 752         }
 753
 754         /*
 755          * Write out individual sections.
 756          */
 757
 758         STAILQ_FOREACH(scn, &e->e_u.e_elf.e_scn, s_next)
 759                 if ((rc = _libelf_write_scn(e, newfile, scn, rc)) < 0)
 760                         goto error;
 761
 762         /*
 763          * Write out the section header table, if required.  Note that
 764          * if flag ELF_F_LAYOUT has been set the section header table
 765          * could reside in between byte ranges mapped by section
 766          * descriptors.
 767          */
 768         if (shnum != 0 && shoff != 0) {
 769                 if ((uint64_t) rc < shoff)
 770                         (void) memset(newfile + rc,
 771                             LIBELF_PRIVATE(fillchar), shoff - rc);
 772
 773                 maxrc = rc;
 774                 rc = shoff;
 775
 776                 assert(rc % _libelf_falign(ELF_T_SHDR, ec) == 0);
 777
 778                 src.d_type = ELF_T_SHDR;
 779                 src.d_size = _libelf_msize(ELF_T_SHDR, ec, e->e_version);
 780                 src.d_version = dst.d_version = e->e_version;
 781
 782                 fsz = _libelf_fsize(ELF_T_SHDR, ec, e->e_version, (size_t) 1);
 783
 784                 STAILQ_FOREACH(scn, &e->e_u.e_elf.e_scn, s_next) {
 785                         if (ec == ELFCLASS32)
 786                                 src.d_buf = &scn->s_shdr.s_shdr32;
 787                         else
 788                                 src.d_buf = &scn->s_shdr.s_shdr64;
 789
 790                         dst.d_size = fsz;
 791                         dst.d_buf = newfile + rc + scn->s_ndx * fsz;
 792
 793                         if (_libelf_xlate(&dst, &src, e->e_byteorder, ec,
 794                                 ELF_TOFILE) != &dst)
 795                                 goto error;
 796                 }
 797
 798                 rc += e->e_u.e_elf.e_nscn * fsz;
 799                 if (maxrc > rc)
 800                         rc = maxrc;
 801         }
 802
 803         assert(rc == newsize);
 804
 805         /*
 806          * Write out the constructed contents and remap the file in
 807          * read-only.
 808          */
 809
 810         if (e->e_rawfile && munmap(e->e_rawfile, e->e_rawsize) < 0) {
 811                 LIBELF_SET_ERROR(IO, errno);
 812                 goto error;
 813         }
 814
 815         if (write(e->e_fd, newfile, (size_t) newsize) != newsize ||
 816             lseek(e->e_fd, (off_t) 0, SEEK_SET) < 0) {
 817                 LIBELF_SET_ERROR(IO, errno);
 818                 goto error;
 819         }
 820
 821         if (e->e_cmd != ELF_C_WRITE) {
 822                 if ((e->e_rawfile = mmap(NULL, (size_t) newsize, PROT_READ,
 823                     MAP_PRIVATE, e->e_fd, (off_t) 0)) == MAP_FAILED) {
 824                         LIBELF_SET_ERROR(IO, errno);
 825                         goto error;
 826                 }
 827                 e->e_rawsize = newsize;
 828         }
 829
 830         /*
 831          * Reset flags, remove existing section descriptors and
 832          * {E,P}HDR pointers so that a subsequent elf_get{e,p}hdr()
 833          * and elf_getscn() will function correctly.
 834          */
 835
 836         e->e_flags &= ~ELF_F_DIRTY;
 837
 838         STAILQ_FOREACH_SAFE(scn, &e->e_u.e_elf.e_scn, s_next, tscn)
 839                 _libelf_release_scn(scn);
 840
 841         if (ec == ELFCLASS32) {
 842                 free(e->e_u.e_elf.e_ehdr.e_ehdr32);
 843                 if (e->e_u.e_elf.e_phdr.e_phdr32)
 844                         free(e->e_u.e_elf.e_phdr.e_phdr32);
 845
 846                 e->e_u.e_elf.e_ehdr.e_ehdr32 = NULL;
 847                 e->e_u.e_elf.e_phdr.e_phdr32 = NULL;
 848         } else {
 849                 free(e->e_u.e_elf.e_ehdr.e_ehdr64);
 850                 if (e->e_u.e_elf.e_phdr.e_phdr64)
 851                         free(e->e_u.e_elf.e_phdr.e_phdr64);
 852
 853                 e->e_u.e_elf.e_ehdr.e_ehdr64 = NULL;
 854                 e->e_u.e_elf.e_phdr.e_phdr64 = NULL;
 855         }
 856
 857         return (rc);
 858
 859  error:
 860         if (newfile)
 861                 free(newfile);
 862         return ((off_t) -1);
 863 }
 864
 865 off_t
 866 elf_update(Elf *e, Elf_Cmd c)
 867 {
 868         int ec;
 869         off_t rc;
 870
 871         rc = (off_t) -1;
 872
 873         if (e == NULL || e->e_kind != ELF_K_ELF ||
 874             (c != ELF_C_NULL && c != ELF_C_WRITE)) {
 875                 LIBELF_SET_ERROR(ARGUMENT, 0);
 876                 return (rc);
 877         }
 878
 879         if ((ec = e->e_class) != ELFCLASS32 && ec != ELFCLASS64) {
 880                 LIBELF_SET_ERROR(CLASS, 0);
 881                 return (rc);
 882         }
 883
 884         if (e->e_version == EV_NONE)
 885                 e->e_version = EV_CURRENT;
 886
 887         if (c == ELF_C_WRITE && e->e_cmd == ELF_C_READ) {
 888                 LIBELF_SET_ERROR(MODE, 0);
 889                 return (rc);
 890         }
 891
 892         if ((rc = _libelf_resync_elf(e)) < 0)
 893                 return (rc);
 894
 895         if (c == ELF_C_NULL)
 896                 return (rc);
 897
 898         if (e->e_cmd == ELF_C_READ) {
 899                 /*
 900                  * This descriptor was opened in read-only mode or by
 901                  * elf_memory().
 902                  */
 903                 if (e->e_fd)
 904                         LIBELF_SET_ERROR(MODE, 0);
 905                 else
 906                         LIBELF_SET_ERROR(ARGUMENT, 0);
 907                 return ((off_t) -1);
 908         }
 909
 910         if (e->e_fd < 0) {
 911                 LIBELF_SET_ERROR(SEQUENCE, 0);
 912                 return ((off_t) -1);
 913         }
 914
 915         return (_libelf_write_elf(e, rc));
 916 }