/*      $NetBSD: kvm_x86_64.c,v 1.13 2022/01/10 19:51:30 christos Exp $ */

/*-
 * Copyright (c) 1989, 1992, 1993
 *      The Regents of the University of California.  All rights reserved.
 *
 * This code is derived from software developed by the Computer Systems
 * Engineering group at Lawrence Berkeley Laboratory under DARPA contract
 * BG 91-66 and contributed to Berkeley.
 *
 * 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.
 */

#include <sys/cdefs.h>
#if defined(LIBC_SCCS) && !defined(lint)
#if 0
static char sccsid[] = "@(#)kvm_hp300.c 8.1 (Berkeley) 6/4/93";
#else
__RCSID("$NetBSD: kvm_x86_64.c,v 1.13 2022/01/10 19:51:30 christos Exp $");
#endif
#endif /* LIBC_SCCS and not lint */

/*
 * x86-64 machine dependent routines for kvm.
 */

#include <sys/param.h>
#include <sys/proc.h>
#include <sys/stat.h>
#include <sys/kcore.h>
#include <sys/types.h>

#include <stdlib.h>
#include <unistd.h>
#include <nlist.h>
#include <kvm.h>

#include <uvm/uvm_extern.h>

#include <limits.h>
#include <db.h>

#include "kvm_private.h"

#include <machine/kcore.h>
#include <machine/pmap.h>
#include <machine/pte.h>
#include <machine/vmparam.h>

void
_kvm_freevtop(kvm_t *kd)
{

        /* Not actually used for anything right now, but safe. */
        if (kd->vmst != 0)
                free(kd->vmst);
}

/*ARGSUSED*/
int
_kvm_initvtop(kvm_t *kd)
{

        return (0);
}

/*
 * Translate a kernel virtual address to a physical address.
 */
int
_kvm_kvatop(kvm_t *kd, vaddr_t va, paddr_t *pa)
{
        cpu_kcore_hdr_t *cpu_kh;
        u_long page_off;
        pd_entry_t pde;
        pt_entry_t pte;
        paddr_t pde_pa, pte_pa;

        if (ISALIVE(kd)) {
                _kvm_err(kd, 0, "vatop called in live kernel!");
                return (0);
        }

        cpu_kh = kd->cpu_data;

        /*
         * Find and read all entries to get to the pa.
         */

        /*
         * Level 4.
         */
        pde_pa = cpu_kh->ptdpaddr + (pl4_pi(va) * sizeof(pd_entry_t));
        if (_kvm_pread(kd, kd->pmfd, (void *)&pde, sizeof(pde),
            _kvm_pa2off(kd, pde_pa)) != sizeof(pde)) {
                _kvm_syserr(kd, 0, "could not read PT level 4 entry");
                goto lose;
        }
        if ((pde & PTE_P) == 0) {
                _kvm_err(kd, 0, "invalid translation (invalid level 4 PDE)");
                goto lose;
        }

        /*
         * Level 3.
         */
        pde_pa = (pde & PTE_FRAME) + (pl3_pi(va) * sizeof(pd_entry_t));
        if (_kvm_pread(kd, kd->pmfd, (void *)&pde, sizeof(pde),
            _kvm_pa2off(kd, pde_pa)) != sizeof(pde)) {
                _kvm_syserr(kd, 0, "could not read PT level 3 entry");
                goto lose;
        }
        if ((pde & PTE_P) == 0) {
                _kvm_err(kd, 0, "invalid translation (invalid level 3 PDE)");
                goto lose;
        }
        if (pde & PTE_PS) {
                page_off = va & (NBPD_L3 - 1);
                *pa = (pde & PTE_1GFRAME) + page_off;
                return (int)(NBPD_L3 - page_off);
        }

        /*
         * Level 2.
         */
        pde_pa = (pde & PTE_FRAME) + (pl2_pi(va) * sizeof(pd_entry_t));
        if (_kvm_pread(kd, kd->pmfd, (void *)&pde, sizeof(pde),
            _kvm_pa2off(kd, pde_pa)) != sizeof(pde)) {
                _kvm_syserr(kd, 0, "could not read PT level 2 entry");
                goto lose;
        }
        if ((pde & PTE_P) == 0) {
                _kvm_err(kd, 0, "invalid translation (invalid level 2 PDE)");
                goto lose;
        }
        if (pde & PTE_PS) {
                page_off = va & (NBPD_L2 - 1);
                *pa = (pde & PTE_2MFRAME) + page_off;
                return (int)(NBPD_L2 - page_off);
        }

        /*
         * Level 1.
         */
        pte_pa = (pde & PTE_FRAME) + (pl1_pi(va) * sizeof(pt_entry_t));
        if (_kvm_pread(kd, kd->pmfd, (void *) &pte, sizeof(pte),
            _kvm_pa2off(kd, pte_pa)) != sizeof(pte)) {
                _kvm_syserr(kd, 0, "could not read PTE");
                goto lose;
        }
        /*
         * Validate the PTE and return the physical address.
         */
        if ((pte & PTE_P) == 0) {
                _kvm_err(kd, 0, "invalid translation (invalid PTE)");
                goto lose;
        }
        page_off = va & PGOFSET;
        *pa = (pte & PTE_FRAME) + page_off;
        return (int)(NBPG - page_off);

 lose:
        *pa = (u_long)~0L;
        return (0);
}

struct p2o {
        paddr_t pa;
        psize_t sz;
        off_t off;
};

static int
cmp_p2o(const void *a, const void *b)
{
        const struct p2o *p1 = a;
        const struct p2o *p2 = b;

        /* If one range contains the start of the other, it's a match. */
        if (p1->pa >= p2->pa && p1->pa < p2->pa + p2->sz) {
                return 0;
        }
        if (p2->pa >= p1->pa && p2->pa < p1->pa + p1->sz) {
                return 0;
        }

        /* Otherwise sort by pa. */
        if (p1->pa < p2->pa)
                return -1;
        else if (p1->pa > p2->pa)
                return 1;
        else
                return 0;
}


/*
 * Translate a physical address to a file-offset in the crash dump.
 */
off_t
_kvm_pa2off(kvm_t *kd, paddr_t pa)
{
        cpu_kcore_hdr_t *cpu_kh;
        phys_ram_seg_t *ramsegs;
        off_t off;
        int i;

        static struct p2o *map;
        struct p2o key, *val;

        cpu_kh = kd->cpu_data;
        ramsegs = (void *)((char *)(void *)cpu_kh + ALIGN(sizeof *cpu_kh));

        if (map == NULL) {
                map = calloc(sizeof *map, cpu_kh->nmemsegs);
                off = 0;
                for (i = 0; i < cpu_kh->nmemsegs; i++) {
                        map[i].pa = ramsegs[i].start;
                        map[i].sz = ramsegs[i].size;
                        map[i].off = off;
                        off += ramsegs[i].size;
                }
#if 0
                /* The array appears to be sorted already */
                qsort(map, cpu_kh->nmemsegs, sizeof(*map), cmp_p2o);
#endif
        }

        key.pa = pa;
        key.sz = 1;
        key.off = -1;
        val = bsearch(&key, map, cpu_kh->nmemsegs, sizeof (key), cmp_p2o);
        if (val)
                off = val->off + pa - val->pa;
        else
                off = 0;

        return (kd->dump_off + off);
}

/*
 * Machine-dependent initialization for ALL open kvm descriptors,
 * not just those for a kernel crash dump.  Some architectures
 * have to deal with these NOT being constants!  (i.e. m68k)
 */
int
_kvm_mdopen(kvm_t *kd)
{

        kd->min_uva = VM_MIN_ADDRESS;
        kd->max_uva = VM_MAXUSER_ADDRESS;

        return (0);
}