root/sys/arch/hppa/stand/mkboot/mkboot.c
/*      $NetBSD: mkboot.c,v 1.5 2024/10/31 01:21:12 gutteridge Exp $    */

/*      $OpenBSD: mkboot.c,v 1.9 2001/05/17 00:57:55 pvalchev Exp $     */

/*
 * Copyright (c) 1990, 1993
 *      The Regents of the University of California.  All rights reserved.
 *
 * 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. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``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 THE REGENTS OR CONTRIBUTORS 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.
 *
 *      @(#)mkboot.c    8.1 (Berkeley) 7/15/93
 */

#if 0
#ifndef lint
static char copyright[] =
"@(#) Copyright (c) 1990, 1993\n\
        The Regents of the University of California.  All rights reserved.\n";
#endif /* not lint */

#ifndef lint
static char rcsid[] = "$OpenBSD: mkboot.c,v 1.9 2001/05/17 00:57:55 pvalchev Exp $";
#endif /* not lint */
#endif

#if HAVE_NBTOOL_CONFIG_H
#include "nbtool_config.h"
#include "../../sys/sys/bootblock.h"
#else
#include <sys/bootblock.h>
#endif

#include <sys/param.h>
#include <sys/endian.h>
#include <sys/file.h>
#include <sys/stat.h>
#include <string.h>
#include <stdlib.h>
#include <unistd.h>
#include <time.h>
#include <err.h>

/* BFD ELF headers */
#include <elf/common.h>
#include <elf/external.h>

#define IS_ELF(ehdr) ((ehdr).e_ident[EI_MAG0] == ELFMAG0 && \
                      (ehdr).e_ident[EI_MAG1] == ELFMAG1 && \
                      (ehdr).e_ident[EI_MAG2] == ELFMAG2 && \
                      (ehdr).e_ident[EI_MAG3] == ELFMAG3)

/*
 * Macros to get values from multi-byte ELF header fields.  These assume
 * a big-endian image.
 */
#define ELFGET16(x)     (((x)[0] << 8) | (x)[1])

#define ELFGET32(x)     (((x)[0] << 24) | ((x)[1] << 16) |              \
                         ((x)[2] <<  8) |  (x)[3])

/*
 * Header prepended to each a.out file.
 */
struct exec {
        u_long  a_midmag;       /* htobe32(flags<<26 | mid<<16 | magic) */
        u_long  a_text;         /* text segment size */
        u_long  a_data;         /* initialized data size */
        u_long  a_bss;          /* uninitialized data size */
        u_long  a_syms;         /* symbol table size */
        u_long  a_entry;        /* entry point */
        u_long  a_trsize;       /* text relocation size */
        u_long  a_drsize;       /* data relocation size */
};

/* a_magic */
#define OMAGIC          0407    /* old impure format */
#define NMAGIC          0410    /* read-only text */
#define ZMAGIC          0413    /* demand load format */
#define QMAGIC          0314    /* "compact" demand load format; deprecated */

#define N_GETMAGIC(ex) \
    ((((ex).a_midmag)&0xffff0000) ? \
    (be32toh((uint32_t)((ex).a_midmag))&0xffff) : ((ex).a_midmag))

#include <stdio.h>
#include <ctype.h>

int putfile(char *, int);
void __dead usage(void);
void bcddate(char *, char *);
char *lifname(char *);
int cksum(int, int *, int);

char *to_file;
int loadpoint, verbose;
u_long entry;
time_t repro_epoch = 0;

/*
 * Old Format:
 *      sector 0:       LIF volume header (40 bytes)
 *      sector 1:       <unused>
 *      sector 2:       LIF directory (8 x 32 == 256 bytes)
 *      sector 3-:      LIF file 0, LIF file 1, etc.
 * where sectors are 256 bytes.
 *
 * New Format:
 *      sector 0:       LIF volume header (40 bytes)
 *      sector 1:       <unused>
 *      sector 2:       LIF directory (8 x 32 == 256 bytes)
 *      sector 3:       <unused>
 *      sector 4-31:    disklabel (~300 bytes right now)
 *      sector 32-:     LIF file 0, LIF file 1, etc.
 */
int
main(int argc, char **argv)
{
        int to, n, pos, c;
        char buf[HPPA_LIF_FILESTART];
        struct hppa_lifvol *lifv = (struct hppa_lifvol *)buf;
        struct hppa_lifdir *lifd = (struct hppa_lifdir *)(buf + HPPA_LIF_DIRSTART);

        while ((c = getopt(argc, argv, "l:t:v")) != -1) {
                switch (c) {
                case 'l':
                        loadpoint = strtol(optarg, NULL, 0);
                        break;
                case 't':
                        repro_epoch = atoll(optarg);
                        break;
                case 'v':
                        verbose++;
                        break;
                default:
                        usage();
                }
        }
        if (argc - optind < 2)
                usage();
        else if (argc - optind > 8)
                errx(1, "too many boot programs (max 8 supported)");

        to_file = argv[--argc];
        if ((to = open(to_file, O_RDWR | O_TRUNC | O_CREAT, 0644)) < 0)
                err(1, "%s: open", to_file);

        memset(buf, 0, sizeof(buf));

        /* record volume info */
        lifv->vol_id = htobe16(HPPA_LIF_VOL_ID);
        strncpy(lifv->vol_label, "MKBOOT", 6);
        lifv->vol_addr = htobe32(hppa_btolifs(HPPA_LIF_DIRSTART));
        lifv->vol_oct = htobe16(HPPA_LIF_VOL_OCT);
        lifv->vol_dirsize = htobe32(hppa_btolifs(HPPA_LIF_DIRSIZE));
        lifv->vol_version = htobe16(1);
        lifv->vol_number = htobe32(1);
        lifv->vol_lastvol = htobe32(1);
        lifv->vol_length = HPPA_LIF_FILESTART;  /* ... so far. */
        bcddate(to_file, lifv->vol_toc);
        lifv->ipl_addr = htobe32(HPPA_LIF_FILESTART);

        argv += optind;
        argc -= optind;
        optind = 0;
        for (pos = HPPA_LIF_FILESTART; optind < argc; optind++) {

                /* output bootfile */
                if (lseek(to, pos, SEEK_SET) < 0)
                        err(1, "%s: lseek", to_file);
                lifd[optind].dir_addr = htobe32(hppa_btolifs(pos));
                n = hppa_btolifs(putfile(argv[optind], to));
                if (lifv->ipl_entry == 0) {
                        lifv->ipl_entry = htobe32(loadpoint + entry);
                        lifv->ipl_size = htobe32(hppa_lifstob(n));
                        lifd[optind].dir_type = htobe16(HPPA_LIF_DIR_ISL);
                        lifd[optind].dir_implement = 0;
                } else {
                        lifd[optind].dir_type = htobe16(HPPA_LIF_DIR_TYPE);
                        lifd[optind].dir_implement = htobe32(loadpoint + entry);
                }

                memcpy(lifd[optind].dir_name, lifname(argv[optind]),
                        sizeof(lifd[optind].dir_name));
                lifd[optind].dir_length = htobe32(n);
                bcddate(argv[optind], lifd[optind].dir_toc);
                lifd[optind].dir_flag = htobe16(HPPA_LIF_DIR_FLAG);

                lifv->vol_length += n;
                pos += hppa_lifstob(n);
        }

        /* terminate the directory */
        lifd[optind].dir_type = htobe16(0xffff);

        /* byte-swap the length now that we're done computing it */
        lifv->vol_length = htobe32(lifv->vol_length);

        /* output volume/directory header info */
        if (lseek(to, HPPA_LIF_VOLSTART, SEEK_SET) < 0)
                err(1, "%s: lseek", to_file);
        if (write(to, buf, sizeof(buf)) != sizeof(buf))
                err(1, "%s: write LIF volume", to_file);
        lseek(to, 0, SEEK_END);

        if (close(to) < 0)
                err(1, "%s", to_file);

        return(0);
}

int
putfile(char *from_file, int to)
{
        struct exec ex;
        char buf[2048];
        int n, total;
        int from, check_sum = 0;
        struct hppa_lifload load;
        Elf32_External_Ehdr elf_header;
        Elf32_External_Phdr *elf_segments = NULL;
        int i, header_count, memory_needed, elf_load_image_segment;

        if ((from = open(from_file, O_RDONLY)) < 0)
                err(1, "%s", from_file);

        n = read(from, &ex, sizeof(ex));
        if (n != sizeof(ex))
                err(1, "%s: reading file header", from_file);

        entry = ex.a_entry;
        if (N_GETMAGIC(ex) == OMAGIC || N_GETMAGIC(ex) == NMAGIC)
                entry += sizeof(ex);
        else if (IS_ELF(*(Elf32_External_Ehdr *)&ex)) {

                if (lseek(from, 0, SEEK_SET) < 0)
                        err(1, "lseek");
                n = read(from, &elf_header, sizeof (elf_header));
                if (n != sizeof (elf_header))
                        err(1, "%s: reading ELF header", from_file);
                header_count = ELFGET16(elf_header.e_phnum);
                memory_needed = header_count * sizeof (Elf32_External_Phdr);
                elf_segments = malloc(memory_needed);
                if (elf_segments == NULL)
                        err(1, "malloc");
                if (lseek(from, ELFGET32(elf_header.e_phoff), SEEK_SET) < 0)
                        err(1, "lseek");
                n = read(from, elf_segments, memory_needed);
                if (n != memory_needed)
                        err(1, "%s: reading ELF segments", from_file);
                elf_load_image_segment = -1;
                for (i = 0; i < header_count; i++) {
                        if (ELFGET32(elf_segments[i].p_filesz) &&
                            ELFGET32(elf_segments[i].p_flags) & PF_X) {
                                if (elf_load_image_segment != -1)
                                        errx(1, "%s: more than one ELF program "
                                             "segment", from_file);
                                elf_load_image_segment = i;
                        }
                }
                if (elf_load_image_segment == -1)
                        errx(1, "%s: no suitable ELF program segment",
                             from_file);
                entry = ELFGET32(elf_header.e_entry) +
                        ELFGET32(elf_segments[elf_load_image_segment].p_offset) -
                        ELFGET32(elf_segments[elf_load_image_segment].p_vaddr);
        } else if (*(uint8_t *)&ex == 0x1f && ((uint8_t *)&ex)[1] == 0x8b) {
                entry = 0;
        } else
                errx(1, "%s: bad magic number", from_file);

        entry += sizeof(load);
        lseek(to, sizeof(load), SEEK_CUR);

        total = 0;
        n = sizeof(buf) - sizeof(load);
        /* copy the whole file */
        for (lseek(from, 0, SEEK_SET); ; n = sizeof(buf)) {
                memset(buf, 0, sizeof(buf));
                if ((n = read(from, buf, n)) < 0)
                        err(1, "%s", from_file);
                else if (n == 0)
                        break;

                if (write(to, buf, n) != n)
                        err(1, "%s", to_file);

                total += n;
                check_sum = cksum(check_sum, (int *)buf, n);
        }

        /* load header */
        load.address = htobe32(loadpoint + sizeof(load));
        load.count = htobe32(4 + total);
        check_sum = cksum(check_sum, (int *)&load, sizeof(load));

        if (verbose)
                warnx("wrote %d bytes of file \'%s\'", total, from_file);

        total += sizeof(load);
        /* insert the header */
        lseek(to, -total, SEEK_CUR);
        if (write(to, &load, sizeof(load)) != sizeof(load))
                err(1, "%s", to_file);
        lseek(to, total - sizeof(load), SEEK_CUR);

        memset(buf, 0, sizeof(buf));
        /* pad to int */
        n = sizeof(int) - total % sizeof(int);
        if (total % sizeof(int)) {
                if (write(to, buf, n) != n)
                        err(1, "%s", to_file);
                else
                        total += n;
        }

        /* pad to the blocksize */
        n = sizeof(buf) - total % sizeof(buf);

        if (n < sizeof(int)) {
                n += sizeof(buf);
                total += sizeof(buf);
        } else
                total += n;

        /* TODO should pad here to the 65k boundary for tape boot */

        if (verbose)
                warnx("checksum is 0x%08x", -check_sum);

        check_sum = htobe32(-check_sum);
        if (write(to, &check_sum, sizeof(int)) != sizeof(int))
                err(1, "%s", to_file);

        n -= sizeof(int);

        if (write(to, buf, n) != n)
                err(1, "%s", to_file);

        if (close(from) < 0)
                err(1, "%s", from_file);

        free(elf_segments);
        return total;
}

int
cksum(int ck, int *p, int size)
{
        /* we assume size is int-aligned */
        for (size = (size + sizeof(int) - 1) / sizeof(int); size--; p++ )
                ck += be32toh(*p);

        return ck;
}

void __dead
usage(void)
{
        fprintf(stderr,
            "Usage: %s [-v] [-l <loadpoint>] [-t <timestamp>] prog1 {progN} outfile\n",
            getprogname());
        exit(1);
}

char *
lifname(char *str)
{
        static char lname[10] = "XXXXXXXXXX";
        char *cp;
        int i;

        cp = strrchr(str, '/');
        if (cp != NULL) {
                str = cp + 1;
        }
        for (i = 0; i < 9; i++) {
                if (islower(*str))
                        lname[i] = toupper(*str);
                else if (isalnum(*str) || *str == '_')
                        lname[i] = *str;
                else
                        break;
                str++;
        }
        for ( ; i < 10; i++)
                lname[i] = ' ';
        return(lname);
}


void
bcddate(char *file, char *toc)
{
        struct stat statb;
        struct tm *tm;

        if (repro_epoch)
                tm = gmtime(&repro_epoch);
        else {
                stat(file, &statb);
                tm = localtime(&statb.st_ctime);
        }
        tm->tm_year %= 100;
        *toc = (tm->tm_year / 10) << 4;
        *toc++ |= tm->tm_year % 10;
        *toc = ((tm->tm_mon+1) / 10) << 4;
        *toc++ |= (tm->tm_mon+1) % 10;
        *toc = (tm->tm_mday / 10) << 4;
        *toc++ |= tm->tm_mday % 10;
        *toc = (tm->tm_hour / 10) << 4;
        *toc++ |= tm->tm_hour % 10;
        *toc = (tm->tm_min / 10) << 4;
        *toc++ |= tm->tm_min % 10;
        *toc = (tm->tm_sec / 10) << 4;
        *toc |= tm->tm_sec % 10;
}