root/usr.sbin/kvm_mkdb/nlist_ecoff.c
/* $NetBSD: nlist_ecoff.c,v 1.11 2003/11/12 13:31:07 grant Exp $ */

/*
 * Copyright (c) 1996 Christopher G. Demetriou
 * 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. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *          This product includes software developed for the
 *          NetBSD Project.  See http://www.NetBSD.org/ for
 *          information about NetBSD.
 * 4. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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.
 * 
 * <<Id: LICENSE,v 1.2 2000/06/14 15:57:33 cgd Exp>>
 */

#include <sys/cdefs.h>
#ifndef lint
__RCSID("$NetBSD: nlist_ecoff.c,v 1.11 2003/11/12 13:31:07 grant Exp $");
#endif /* not lint */

#include <sys/param.h>
#include <sys/mman.h>
#include <sys/stat.h>

#include <a.out.h>
#include <db.h>
#include <err.h>
#include <errno.h>
#include <fcntl.h>
#include <kvm.h>
#include <limits.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>

#include "extern.h"

#ifdef NLIST_ECOFF
#include <sys/exec_ecoff.h>

typedef struct nlist NLIST;
#define _strx   n_un.n_strx
#define _name   n_un.n_name

#define badfmt(str)                                                     \
        do {                                                            \
                warnx("%s: %s: %s", kfile, str, strerror(EFTYPE));      \
                punt();                                                 \
        } while (0)

#define check(off, size)        ((off < 0) || (off + size > mappedsize))
#define BAD                     do { rv = -1; goto out; } while (0)
#define BADUNMAP                do { rv = -1; goto unmap; } while (0)

static const char *kfile;

int
create_knlist_ecoff(name, db)
        const char *name;
        DB *db;
{
        struct ecoff_exechdr *exechdrp;
        struct ecoff_symhdr *symhdrp;
        struct ecoff_extsym *esyms;
        struct stat st;
        struct nlist nbuf;
        DBT key, data;
        char *mappedfile, *symname, *nsymname, *fsymname, *tmpcp;
        size_t mappedsize, symnamesize, fsymnamesize;
        u_long symhdroff, extrstroff;
        u_long symhdrsize, i, nesyms;
        int fd, rv;

        rv = -1;

        /*
         * Open and map the whole file.  If we can't open/stat it,
         * something bad is going on so we punt.
         */
        kfile = name;
        if ((fd = open(name, O_RDONLY, 0)) < 0) {
                warn("%s", kfile);
                punt();
        }
        if (fstat(fd, &st) < 0) {
                warn("%s", kfile);
                punt();
        }
        if (st.st_size > SIZE_T_MAX)
                BAD;

        /*
         * Map the file in its entirety.
         */
        mappedsize = st.st_size;
        mappedfile = mmap(NULL, mappedsize, PROT_READ, MAP_FILE|MAP_PRIVATE,
            fd, 0);
        if (mappedfile == (char *)-1)
                BAD;

        /*
         * Make sure we can access the executable's header
         * directly, and make sure the recognize the executable
         * as an ECOFF binary.
         */
        if (check(0, sizeof *exechdrp))
                BADUNMAP;
        exechdrp = (struct ecoff_exechdr *)&mappedfile[0];

        if (ECOFF_BADMAG(exechdrp))
                BADUNMAP;

        /*
         * We've recognized it as an ECOFF binary.  From here
         * on out, all errors are fatal.
         */

        /*
         * Find the symbol list and string table.
         */
        symhdroff = exechdrp->f.f_symptr;
        symhdrsize = exechdrp->f.f_nsyms;

        if (symhdrsize == 0)
                badfmt("stripped");
        if (check(symhdroff, sizeof *symhdrp) || sizeof *symhdrp != symhdrsize)
                badfmt("bogus symbol table");
        symhdrp = (struct ecoff_symhdr *)&mappedfile[symhdroff];

        nesyms = symhdrp->esymMax;
        if (check(symhdrp->cbExtOffset, nesyms * sizeof *esyms))
                badfmt("bogus external symbol list");
        esyms = (struct ecoff_extsym *)&mappedfile[symhdrp->cbExtOffset];
        extrstroff = symhdrp->cbSsExtOffset;

        /*
         * Set up the data item, pointing to a nlist structure.
         * which we fill in for each symbol.
         */
        data.data = (u_char *)&nbuf;
        data.size = sizeof(nbuf);

        /*
         * Create a buffer (to be expanded later, if necessary)
         * to hold symbol names after we've added underscores
         * to them.
         */
        symnamesize = 1024;
        if ((symname = malloc(symnamesize)) == NULL) {
                warn("malloc");
                punt();
        }

        /*
         * Read each symbol and enter it into the database.
         */
        for (i = 0; i < nesyms; i++) {

                /*
                 * Find symbol name, copy it (with added underscore) to
                 * temporary buffer, and prepare the database key for
                 * insertion.
                 */
                fsymname = &mappedfile[extrstroff + esyms[i].es_strindex];
                fsymnamesize = strlen(fsymname) + 1;
                while (symnamesize < fsymnamesize + 1) {
                        if ((nsymname = realloc(symname, symnamesize * 2)) == NULL) {
                                warn("malloc");
                                punt();
                        }
                        symname = nsymname;
                        symnamesize *= 2;
                }
                strlcpy(symname, "_", symnamesize);
                strlcat(symname, fsymname, symnamesize);

                key.data = symname;
                key.size = strlen((char *)key.data);

                /*
                 * Convert the symbol information into an nlist structure,
                 * as best we can.
                 */
                nbuf.n_value = esyms[i].es_value;
                nbuf.n_type = N_EXT;                            /* XXX */
                nbuf.n_desc = 0;                                /* XXX */
                nbuf.n_other = 0;                               /* XXX */

                /*
                 * Enter the symbol into the database.
                 */
                if (db->put(db, &key, &data, 0)) {
                        warn("record enter");
                        punt();
                }

                /*
                 * If it's the kernel version string, we've gotta keep
                 * some extra data around.  Under a separate key,
                 * we enter the first line (i.e. up to the first newline,
                 * with the newline replaced by a NUL to terminate the
                 * entered string) of the version string.
                 */
                if (strcmp((char *)key.data, VRS_SYM) == 0) {
                        unsigned long vma;

                        key.data = (u_char *)VRS_KEY;
                        key.size = sizeof(VRS_KEY) - 1;

                        /* Find the version string, relative to start */
                        vma = nbuf.n_value;
                        if (exechdrp->a.text_start <= vma &&
                            vma < (exechdrp->a.text_start + exechdrp->a.tsize))
                                vma = vma - exechdrp->a.text_start +
                                    ECOFF_TXTOFF(exechdrp);
                        else if (exechdrp->a.data_start <= vma &&
                            vma < (exechdrp->a.data_start + exechdrp->a.dsize))
                                vma = vma - exechdrp->a.data_start +
                                    ECOFF_DATOFF(exechdrp);
                        else {
                                warn("version string neither text nor data");
                                punt();
                        }
                        data.data = strdup(&mappedfile[vma]);

                        /* assumes newline terminates version. */
                        if ((tmpcp = strchr(data.data, '\n')) != NULL)
                                *tmpcp = '\0';
                        data.size = strlen((char *)data.data);

                        if (db->put(db, &key, &data, 0)) {
                                warn("record enter");
                                punt();
                        }

                        /* free pointer created by strdup(). */
                        free(data.data);

                        /* Restore to original values */
                        data.data = (u_char *)&nbuf;
                        data.size = sizeof(nbuf);
                }
        }

        rv = 0;

unmap:
        munmap(mappedfile, mappedsize);
out:
        return (rv);
}

#endif /* NLIST_ECOFF */