root/sys/arch/sparc64/stand/ofwboot/elf64_exec.c
/*      $OpenBSD: elf64_exec.c,v 1.19 2025/11/14 19:17:13 miod Exp $    */
/*      $NetBSD: elfXX_exec.c,v 1.2 2001/08/15 20:08:15 eeh Exp $       */

/*
 * Copyright (c) 1998-2000 Eduardo Horvath.  All rights reserved.
 * Copyright (c) 1997 Jason R. Thorpe.  All rights reserved.
 * Copyright (C) 1995, 1996 Wolfgang Solfrank.
 * Copyright (C) 1995, 1996 TooLs GmbH.
 * All rights reserved.
 *
 * ELF support derived from NetBSD/alpha's boot loader, written
 * by Christopher G. Demetriou.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *      This product includes software developed by TooLs GmbH.
 * 4. The name of TooLs GmbH may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY TOOLS GMBH ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/*
 * First try for the boot code
 *
 * Input syntax is:
 *      [promdev[{:|,}partition]]/[filename] [flags]
 */

#define ELFSIZE         64
#define MB              (1024 * 1024)

#define ELF_ALIGN(x)    (((x) + 7) & (~7))

#include <lib/libsa/stand.h>

#include <sys/param.h>
#include <sys/exec_elf.h>

#include <machine/boot_flag.h>

#ifdef SOFTRAID
#include <sys/queue.h>
#include <sys/disklabel.h>
#include <dev/biovar.h>
#include <dev/softraidvar.h>

#include "disk.h"
#include "softraid_sparc64.h"
#endif

#include <lib/libsa/arc4.h>

#include "openfirm.h"

extern int boothowto;

void syncicache(void *, int);

int
elf64_exec(int fd, Elf_Ehdr *elf, u_int64_t *entryp, void **ssymp, void **esymp){
        Elf_Shdr *shp;
        Elf_Off off;
        void *addr;
        size_t size;
        u_int align;
        int i, first = 1;
        struct openbsd_bootdata *obd;
#ifdef SOFTRAID
        struct sr_boot_volume *bv;
#endif

        /*
         * Don't display load address for ELF; it's encoded in
         * each section.
         */
        for (i = 0; i < elf->e_phnum; i++) {
                Elf_Phdr phdr;
                size = lseek(fd, (size_t)(elf->e_phoff + sizeof(phdr) * i),
                    SEEK_SET);
                if (read(fd, (void *)&phdr, sizeof(phdr)) != sizeof(phdr)) {
                        printf("read phdr: %s\n", strerror(errno));
                        return (1);
                }

                if (phdr.p_type == PT_OPENBSD_BOOTDATA) {
                        memset((void *) (long)phdr.p_paddr, 0, phdr.p_filesz);

                        if (phdr.p_filesz < BOOTDATA_LEN_BOOTHOWTO)
                                continue;

                        obd = (struct openbsd_bootdata *)(long)phdr.p_paddr;
                        obd->version = BOOTDATA_VERSION;
                        obd->len = sizeof(struct openbsd_bootdata);

#ifdef SOFTRAID
                        /*
                         * If booting from softraid we must pass additional
                         * information to the kernel:
                         * 1) The uuid of the softraid volume we booted from.
                         * 2) The maskkey for decryption, if applicable.
                         */
                        if (bootdev_dip && bootdev_dip->sr_vol) {
                                bv = bootdev_dip->sr_vol;
                                memcpy(obd->sr_uuid, bv->sbv_uuid.sui_id,
                                    sizeof(obd->sr_uuid));
                                if (bv->sbv_maskkey)
                                        memcpy(obd->sr_maskkey, bv->sbv_maskkey,
                                            sizeof(obd->sr_maskkey));
                        }

#endif

                        if (phdr.p_filesz < sizeof(struct openbsd_bootdata))
                                continue;

                        obd->boothowto = boothowto;
                        continue;
                }

                if (phdr.p_type == PT_OPENBSD_RANDOMIZE) {
                        extern struct rc4_ctx randomctx;

                        rc4_getbytes(&randomctx, (void *)(long)phdr.p_paddr,
                            phdr.p_filesz);
                }

                if (phdr.p_type != PT_LOAD ||
                    (phdr.p_flags & (PF_W|PF_X)) == 0)
                        continue;

                /* Read in segment. */
                printf("%s%lu@0x%lx", first ? "" : "+", (u_long)phdr.p_filesz,
                    (u_long)phdr.p_vaddr);
                (void)lseek(fd, (size_t)phdr.p_offset, SEEK_SET);

                /*
                 * If the segment's VA is aligned on a 4MB boundary, align its
                 * request 4MB aligned physical memory.  Otherwise use default
                 * alignment.  Make sure BSS is extended to a 4MB boundary, too.
                 */
                align = phdr.p_align;
                if ((phdr.p_vaddr & (4 * MB - 1)) == 0)
                        align = 4 * MB;
                if (phdr.p_filesz < phdr.p_memsz)
                        phdr.p_memsz = roundup(phdr.p_memsz, 4 * MB);
                phdr.p_memsz = roundup(phdr.p_memsz, PAGE_SIZE);
                if (OF_claim((void *)(long)phdr.p_vaddr, phdr.p_memsz, align) ==
                    (void *)-1)
                        panic("cannot claim memory");
                if (read(fd, (void *)(long)phdr.p_vaddr, phdr.p_filesz) !=
                    phdr.p_filesz) {
                        printf("read segment: %s\n", strerror(errno));
                        return (1);
                }
                if (phdr.p_flags & PF_X)
                        syncicache((void *)(long)phdr.p_vaddr, phdr.p_filesz);

                /* Zero BSS. */
                if (phdr.p_filesz < phdr.p_memsz) {
                        printf("+%lu@0x%lx",
                            (u_long)phdr.p_memsz - phdr.p_filesz,
                            (u_long)(phdr.p_vaddr + phdr.p_filesz));
                        bzero((void *)(long)phdr.p_vaddr + phdr.p_filesz,
                            (size_t)phdr.p_memsz - phdr.p_filesz);
                }
                first = 0;
        }

        printf(" \n");

        /*
         * Compute the size of the symbol table.
         */
        size = sizeof(Elf_Ehdr) + (elf->e_shnum * sizeof(Elf_Shdr));
        shp = addr = alloc(elf->e_shnum * sizeof(Elf_Shdr));
        (void)lseek(fd, (off_t)elf->e_shoff, SEEK_SET);
        if (read(fd, addr, (size_t)(elf->e_shnum * sizeof(Elf_Shdr))) !=
            elf->e_shnum * sizeof(Elf_Shdr)) {
                printf("read section headers: %s\n", strerror(errno));
                return (1);
        }

        size_t shstrsz = shp[elf->e_shstrndx].sh_size;
        char *shstr = alloc(shstrsz);
        if (lseek(fd, (off_t)shp[elf->e_shstrndx].sh_offset, SEEK_SET) == -1) {
                printf("lseek section header string table: %s\n", strerror(errno));
                return 1;
        }
        if (read(fd, shstr, shstrsz) != shstrsz) {
                printf("read section header string table: %s\n", strerror(errno));
                return 1;
        }

        for (i = 0; i < elf->e_shnum; i++, shp++) {
                if (shp->sh_type == SHT_NULL)
                        continue;
                if (shp->sh_type != SHT_SYMTAB
                    && shp->sh_type != SHT_STRTAB
                    && strcmp(shstr + shp->sh_name, ELF_CTF)) {
                        shp->sh_offset = 0;
                        continue;
                }
                size += shp->sh_size;
        }
        shp = addr;

        /*
         * Reserve memory for the symbols.
         */
        if ((addr = OF_claim(0, roundup(size, PAGE_SIZE), PAGE_SIZE)) == (void *)-1)
                panic("no space for symbol table");

        /*
         * Copy the headers.
         */
        elf->e_phoff = 0;
        elf->e_shoff = sizeof(Elf_Ehdr);
        elf->e_phentsize = 0;
        elf->e_phnum = 0;
        bcopy(elf, addr, sizeof(Elf_Ehdr));
        bcopy(shp, addr + sizeof(Elf_Ehdr), elf->e_shnum * sizeof(Elf_Shdr));
        free(shp, elf->e_shnum * sizeof(Elf_Shdr));
        *ssymp = addr;

        /*
         * Now load the symbol sections themselves.
         */
        shp = addr + sizeof(Elf_Ehdr);
        size = sizeof(Elf_Ehdr) + (elf->e_shnum * sizeof(Elf_Shdr));
        size = ELF_ALIGN(size);
        addr += size;
        off = size;
        for (first = 1, i = 0; i < elf->e_shnum; i++, shp++) {
                if (shp->sh_type == SHT_SYMTAB
                    || shp->sh_type == SHT_STRTAB
                    || !strcmp(shstr + shp->sh_name, ELF_CTF)) {
                        if (first)
                                printf("symbols @ 0x%lx ", (u_long)addr);
                        printf("%s%d", first ? "" : "+", (int)shp->sh_size);
                        (void)lseek(fd, shp->sh_offset, SEEK_SET);
                        if (read(fd, addr, shp->sh_size) != shp->sh_size) {
                                printf("read symbols: %s\n", strerror(errno));
                                return (1);
                        }
                        addr += ELF_ALIGN(shp->sh_size);
                        shp->sh_offset = off;
                        shp->sh_flags |= SHF_ALLOC;
                        off += ELF_ALIGN(shp->sh_size);
                        first = 0;
                }
        }
        *esymp = addr;

        *entryp = elf->e_entry;
        return (0);
}

#undef ELF_ALIGN