lib/libkvm/kvm_minidump_amd64.c

   1 /*-
   2  * Copyright (c) 2006 Peter Wemm
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23  * SUCH DAMAGE.
  24  */
  25
  26 #include <sys/cdefs.h>
  27 __FBSDID("$FreeBSD$");
  28
  29 /*
  30  * AMD64 machine dependent routines for kvm and minidumps.
  31  */
  32
  33 #include <sys/param.h>
  34 #include <sys/endian.h>
  35 #include <stdint.h>
  36 #include <stdlib.h>
  37 #include <string.h>
  38 #include <unistd.h>
  39 #include <kvm.h>
  40
  41 #include "../../sys/amd64/include/minidump.h"
  42
  43 #include <limits.h>
  44
  45 #include "kvm_private.h"
  46 #include "kvm_amd64.h"
  47
  48 #define amd64_round_page(x)     roundup2((kvaddr_t)(x), AMD64_PAGE_SIZE)
  49 #define VM_IS_V1(vm)            (vm->hdr.version == 1)
  50 #define VA_OFF(vm, va)          \
  51         (VM_IS_V1(vm) ? ((va) & (AMD64_PAGE_SIZE - 1)) : ((va) & AMD64_PAGE_MASK))
  52
  53 struct vmstate {
  54         struct minidumphdr hdr;
  55 };
  56
  57 static vm_prot_t
  58 _amd64_entry_to_prot(uint64_t entry)
  59 {
  60         vm_prot_t prot = VM_PROT_READ;
  61
  62         if ((entry & PG_RW) != 0)
  63                 prot |= VM_PROT_WRITE;
  64         if ((entry & PG_NX) == 0)
  65                 prot |= VM_PROT_EXECUTE;
  66         return prot;
  67 }
  68
  69 /*
  70  * Version 2 minidumps use page directory entries, while version 1 use page
  71  * table entries.
  72  */
  73
  74 static amd64_pde_t
  75 _amd64_pde_get(kvm_t *kd, u_long pdeindex)
  76 {
  77         amd64_pde_t *pde = _kvm_pmap_get(kd, pdeindex, sizeof(*pde));
  78
  79         return le64toh(*pde);
  80 }
  81
  82 static amd64_pte_t
  83 _amd64_pte_get(kvm_t *kd, u_long pteindex)
  84 {
  85         amd64_pte_t *pte = _kvm_pmap_get(kd, pteindex, sizeof(*pte));
  86
  87         return le64toh(*pte);
  88 }
  89
  90 /* Get the first page table entry for a given page directory index. */
  91 static amd64_pte_t *
  92 _amd64_pde_first_pte(kvm_t *kd, u_long pdeindex)
  93 {
  94         u_long *pa;
  95
  96         pa = _kvm_pmap_get(kd, pdeindex, sizeof(amd64_pde_t));
  97         if (pa == NULL)
  98                 return NULL;
  99         return _kvm_map_get(kd, *pa & AMD64_PG_FRAME, AMD64_PAGE_SIZE);
 100 }
 101
 102 static int
 103 _amd64_minidump_probe(kvm_t *kd)
 104 {
 105
 106         return (_kvm_probe_elf_kernel(kd, ELFCLASS64, EM_X86_64) &&
 107             _kvm_is_minidump(kd));
 108 }
 109
 110 static void
 111 _amd64_minidump_freevtop(kvm_t *kd)
 112 {
 113         struct vmstate *vm = kd->vmst;
 114
 115         free(vm);
 116         kd->vmst = NULL;
 117 }
 118
 119 static int
 120 _amd64_minidump_initvtop(kvm_t *kd)
 121 {
 122         struct vmstate *vmst;
 123         off_t off, sparse_off;
 124
 125         vmst = _kvm_malloc(kd, sizeof(*vmst));
 126         if (vmst == NULL) {
 127                 _kvm_err(kd, kd->program, "cannot allocate vm");
 128                 return (-1);
 129         }
 130         kd->vmst = vmst;
 131         if (pread(kd->pmfd, &vmst->hdr, sizeof(vmst->hdr), 0) !=
 132             sizeof(vmst->hdr)) {
 133                 _kvm_err(kd, kd->program, "cannot read dump header");
 134                 return (-1);
 135         }
 136         if (strncmp(MINIDUMP_MAGIC, vmst->hdr.magic, sizeof(vmst->hdr.magic)) != 0) {
 137                 _kvm_err(kd, kd->program, "not a minidump for this platform");
 138                 return (-1);
 139         }
 140
 141         /*
 142          * NB: amd64 minidump header is binary compatible between version 1
 143          * and version 2; this may not be the case for the future versions.
 144          */
 145         vmst->hdr.version = le32toh(vmst->hdr.version);
 146         if (vmst->hdr.version != MINIDUMP_VERSION && vmst->hdr.version != 1) {
 147                 _kvm_err(kd, kd->program, "wrong minidump version. expected %d got %d",
 148                     MINIDUMP_VERSION, vmst->hdr.version);
 149                 return (-1);
 150         }
 151         vmst->hdr.msgbufsize = le32toh(vmst->hdr.msgbufsize);
 152         vmst->hdr.bitmapsize = le32toh(vmst->hdr.bitmapsize);
 153         vmst->hdr.pmapsize = le32toh(vmst->hdr.pmapsize);
 154         vmst->hdr.kernbase = le64toh(vmst->hdr.kernbase);
 155         vmst->hdr.dmapbase = le64toh(vmst->hdr.dmapbase);
 156         vmst->hdr.dmapend = le64toh(vmst->hdr.dmapend);
 157
 158         /* Skip header and msgbuf */
 159         off = AMD64_PAGE_SIZE + amd64_round_page(vmst->hdr.msgbufsize);
 160
 161         sparse_off = off + amd64_round_page(vmst->hdr.bitmapsize) +
 162             amd64_round_page(vmst->hdr.pmapsize);
 163         if (_kvm_pt_init(kd, vmst->hdr.bitmapsize, off, sparse_off,
 164             AMD64_PAGE_SIZE, sizeof(uint64_t)) == -1) {
 165                 return (-1);
 166         }
 167         off += amd64_round_page(vmst->hdr.bitmapsize);
 168
 169         if (_kvm_pmap_init(kd, vmst->hdr.pmapsize, off) == -1) {
 170                 return (-1);
 171         }
 172         off += amd64_round_page(vmst->hdr.pmapsize);
 173
 174         return (0);
 175 }
 176
 177 static int
 178 _amd64_minidump_vatop_v1(kvm_t *kd, kvaddr_t va, off_t *pa)
 179 {
 180         struct vmstate *vm;
 181         amd64_physaddr_t offset;
 182         amd64_pte_t pte;
 183         kvaddr_t pteindex;
 184         amd64_physaddr_t a;
 185         off_t ofs;
 186
 187         vm = kd->vmst;
 188         offset = va & AMD64_PAGE_MASK;
 189
 190         if (va >= vm->hdr.kernbase) {
 191                 pteindex = (va - vm->hdr.kernbase) >> AMD64_PAGE_SHIFT;
 192                 if (pteindex >= vm->hdr.pmapsize / sizeof(pte))
 193                         goto invalid;
 194                 pte = _amd64_pte_get(kd, pteindex);
 195                 if ((pte & AMD64_PG_V) == 0) {
 196                         _kvm_err(kd, kd->program,
 197                             "_amd64_minidump_vatop_v1: pte not valid");
 198                         goto invalid;
 199                 }
 200                 a = pte & AMD64_PG_FRAME;
 201                 ofs = _kvm_pt_find(kd, a, AMD64_PAGE_SIZE);
 202                 if (ofs == -1) {
 203                         _kvm_err(kd, kd->program,
 204             "_amd64_minidump_vatop_v1: physical address 0x%jx not in minidump",
 205                             (uintmax_t)a);
 206                         goto invalid;
 207                 }
 208                 *pa = ofs + offset;
 209                 return (AMD64_PAGE_SIZE - offset);
 210         } else if (va >= vm->hdr.dmapbase && va < vm->hdr.dmapend) {
 211                 a = (va - vm->hdr.dmapbase) & ~AMD64_PAGE_MASK;
 212                 ofs = _kvm_pt_find(kd, a, AMD64_PAGE_SIZE);
 213                 if (ofs == -1) {
 214                         _kvm_err(kd, kd->program,
 215     "_amd64_minidump_vatop_v1: direct map address 0x%jx not in minidump",
 216                             (uintmax_t)va);
 217                         goto invalid;
 218                 }
 219                 *pa = ofs + offset;
 220                 return (AMD64_PAGE_SIZE - offset);
 221         } else {
 222                 _kvm_err(kd, kd->program,
 223             "_amd64_minidump_vatop_v1: virtual address 0x%jx not minidumped",
 224                     (uintmax_t)va);
 225                 goto invalid;
 226         }
 227
 228 invalid:
 229         _kvm_err(kd, 0, "invalid address (0x%jx)", (uintmax_t)va);
 230         return (0);
 231 }
 232
 233 static int
 234 _amd64_minidump_vatop(kvm_t *kd, kvaddr_t va, off_t *pa)
 235 {
 236         amd64_pte_t pt[AMD64_NPTEPG];
 237         struct vmstate *vm;
 238         amd64_physaddr_t offset;
 239         amd64_pde_t pde;
 240         amd64_pte_t pte;
 241         kvaddr_t pteindex;
 242         kvaddr_t pdeindex;
 243         amd64_physaddr_t a;
 244         off_t ofs;
 245
 246         vm = kd->vmst;
 247         offset = va & AMD64_PAGE_MASK;
 248
 249         if (va >= vm->hdr.kernbase) {
 250                 pdeindex = (va - vm->hdr.kernbase) >> AMD64_PDRSHIFT;
 251                 if (pdeindex >= vm->hdr.pmapsize / sizeof(pde))
 252                         goto invalid;
 253                 pde = _amd64_pde_get(kd, pdeindex);
 254                 if ((pde & AMD64_PG_V) == 0) {
 255                         _kvm_err(kd, kd->program,
 256                             "_amd64_minidump_vatop: pde not valid");
 257                         goto invalid;
 258                 }
 259                 if ((pde & AMD64_PG_PS) == 0) {
 260                         a = pde & AMD64_PG_FRAME;
 261                         /* TODO: Just read the single PTE */
 262                         ofs = _kvm_pt_find(kd, a, AMD64_PAGE_SIZE);
 263                         if (ofs == -1) {
 264                                 _kvm_err(kd, kd->program,
 265                                     "cannot find page table entry for %ju",
 266                                     (uintmax_t)a);
 267                                 goto invalid;
 268                         }
 269                         if (pread(kd->pmfd, &pt, AMD64_PAGE_SIZE, ofs) !=
 270                             AMD64_PAGE_SIZE) {
 271                                 _kvm_err(kd, kd->program,
 272                                     "cannot read page table entry for %ju",
 273                                     (uintmax_t)a);
 274                                 goto invalid;
 275                         }
 276                         pteindex = (va >> AMD64_PAGE_SHIFT) &
 277                             (AMD64_NPTEPG - 1);
 278                         pte = le64toh(pt[pteindex]);
 279                         if ((pte & AMD64_PG_V) == 0) {
 280                                 _kvm_err(kd, kd->program,
 281                                     "_amd64_minidump_vatop: pte not valid");
 282                                 goto invalid;
 283                         }
 284                         a = pte & AMD64_PG_FRAME;
 285                 } else {
 286                         a = pde & AMD64_PG_PS_FRAME;
 287                         a += (va & AMD64_PDRMASK) ^ offset;
 288                 }
 289                 ofs = _kvm_pt_find(kd, a, AMD64_PAGE_SIZE);
 290                 if (ofs == -1) {
 291                         _kvm_err(kd, kd->program,
 292             "_amd64_minidump_vatop: physical address 0x%jx not in minidump",
 293                             (uintmax_t)a);
 294                         goto invalid;
 295                 }
 296                 *pa = ofs + offset;
 297                 return (AMD64_PAGE_SIZE - offset);
 298         } else if (va >= vm->hdr.dmapbase && va < vm->hdr.dmapend) {
 299                 a = (va - vm->hdr.dmapbase) & ~AMD64_PAGE_MASK;
 300                 ofs = _kvm_pt_find(kd, a, AMD64_PAGE_SIZE);
 301                 if (ofs == -1) {
 302                         _kvm_err(kd, kd->program,
 303             "_amd64_minidump_vatop: direct map address 0x%jx not in minidump",
 304                             (uintmax_t)va);
 305                         goto invalid;
 306                 }
 307                 *pa = ofs + offset;
 308                 return (AMD64_PAGE_SIZE - offset);
 309         } else {
 310                 _kvm_err(kd, kd->program,
 311             "_amd64_minidump_vatop: virtual address 0x%jx not minidumped",
 312                     (uintmax_t)va);
 313                 goto invalid;
 314         }
 315
 316 invalid:
 317         _kvm_err(kd, 0, "invalid address (0x%jx)", (uintmax_t)va);
 318         return (0);
 319 }
 320
 321 static int
 322 _amd64_minidump_kvatop(kvm_t *kd, kvaddr_t va, off_t *pa)
 323 {
 324
 325         if (ISALIVE(kd)) {
 326                 _kvm_err(kd, 0,
 327                     "_amd64_minidump_kvatop called in live kernel!");
 328                 return (0);
 329         }
 330         if (((struct vmstate *)kd->vmst)->hdr.version == 1)
 331                 return (_amd64_minidump_vatop_v1(kd, va, pa));
 332         else
 333                 return (_amd64_minidump_vatop(kd, va, pa));
 334 }
 335
 336 static int
 337 _amd64_minidump_walk_pages(kvm_t *kd, kvm_walk_pages_cb_t *cb, void *arg)
 338 {
 339         struct vmstate *vm = kd->vmst;
 340         u_long npdes = vm->hdr.pmapsize / sizeof(amd64_pde_t);
 341         u_long bmindex, dva, pa, pdeindex, va;
 342         struct kvm_bitmap bm;
 343         int ret = 0;
 344         vm_prot_t prot;
 345         unsigned int pgsz = AMD64_PAGE_SIZE;
 346
 347         if (vm->hdr.version < 2)
 348                 return (0);
 349
 350         if (!_kvm_bitmap_init(&bm, vm->hdr.bitmapsize, &bmindex))
 351                 return (0);
 352
 353         for (pdeindex = 0; pdeindex < npdes; pdeindex++) {
 354                 pd_entry_t pde = _amd64_pde_get(kd, pdeindex);
 355                 pt_entry_t *ptes;
 356                 u_long i;
 357
 358                 va = vm->hdr.kernbase + (pdeindex << AMD64_PDRSHIFT);
 359                 if ((pde & PG_V) == 0)
 360                         continue;
 361
 362                 if ((pde & AMD64_PG_PS) != 0) {
 363                         /*
 364                          * Large page.  Iterate on each 4K page section
 365                          * within this page.  This differs from 4K pages in
 366                          * that every page here uses the same PDE to
 367                          * generate permissions.
 368                          */
 369                         pa = pde & AMD64_PG_PS_FRAME +
 370                             ((va & AMD64_PDRMASK) ^ VA_OFF(vm, va));
 371                         dva = vm->hdr.dmapbase + pa;
 372                         _kvm_bitmap_set(&bm, pa, AMD64_PAGE_SIZE);
 373                         if (!_kvm_visit_cb(kd, cb, arg, pa, va, dva,
 374                             _amd64_entry_to_prot(pde), AMD64_NBPDR, pgsz)) {
 375                                 goto out;
 376                         }
 377                         continue;
 378                 }
 379
 380                 /* 4K pages: pde references another page of entries. */
 381                 ptes = _amd64_pde_first_pte(kd, pdeindex);
 382                 /* Ignore page directory pages that were not dumped. */
 383                 if (ptes == NULL)
 384                         continue;
 385
 386                 for (i = 0; i < NPTEPG; i++) {
 387                         pt_entry_t pte = (u_long)ptes[i];
 388
 389                         pa = pte & AMD64_PG_FRAME;
 390                         dva = vm->hdr.dmapbase + pa;
 391                         if ((pte & PG_V) != 0) {
 392                                 _kvm_bitmap_set(&bm, pa, AMD64_PAGE_SIZE);
 393                                 if (!_kvm_visit_cb(kd, cb, arg, pa, va, dva,
 394                                     _amd64_entry_to_prot(pte), pgsz, 0)) {
 395                                         goto out;
 396                                 }
 397                         }
 398                         va += AMD64_PAGE_SIZE;
 399                 }
 400         }
 401
 402         while (_kvm_bitmap_next(&bm, &bmindex)) {
 403                 pa = bmindex * AMD64_PAGE_SIZE;
 404                 dva = vm->hdr.dmapbase + pa;
 405                 if (vm->hdr.dmapend < (dva + pgsz))
 406                         break;
 407                 va = 0;
 408                 /* amd64/pmap.c: create_pagetables(): dmap always R|W. */
 409                 prot = VM_PROT_READ | VM_PROT_WRITE;
 410                 if (!_kvm_visit_cb(kd, cb, arg, pa, va, dva, prot, pgsz, 0)) {
 411                         goto out;
 412                 }
 413         }
 414
 415         ret = 1;
 416
 417 out:
 418         _kvm_bitmap_deinit(&bm);
 419         return (ret);
 420 }
 421
 422 static struct kvm_arch kvm_amd64_minidump = {
 423         .ka_probe = _amd64_minidump_probe,
 424         .ka_initvtop = _amd64_minidump_initvtop,
 425         .ka_freevtop = _amd64_minidump_freevtop,
 426         .ka_kvatop = _amd64_minidump_kvatop,
 427         .ka_native = _amd64_native,
 428         .ka_walk_pages = _amd64_minidump_walk_pages,
 429 };
 430
 431 KVM_ARCH(kvm_amd64_minidump);