lib/libkvm/kvm.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1989, 1992, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * This code is derived from software developed by the Computer Systems
   8  * Engineering group at Lawrence Berkeley Laboratory under DARPA contract
   9  * BG 91-66 and contributed to Berkeley.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  * 3. Neither the name of the University nor the names of its contributors
  20  *    may be used to endorse or promote products derived from this software
  21  *    without specific prior written permission.
  22  *
  23  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33  * SUCH DAMAGE.
  34  */
  35
  36 #include <sys/cdefs.h>
  37 __FBSDID("$FreeBSD$");
  38 __SCCSID("@(#)kvm.c     8.2 (Berkeley) 2/13/94");
  39
  40 #include <sys/param.h>
  41 #include <sys/fnv_hash.h>
  42
  43 #define _WANT_VNET
  44
  45 #include <sys/user.h>
  46 #include <sys/linker.h>
  47 #include <sys/pcpu.h>
  48 #include <sys/stat.h>
  49 #include <sys/sysctl.h>
  50 #include <sys/mman.h>
  51
  52 #include <net/vnet.h>
  53
  54 #include <fcntl.h>
  55 #include <kvm.h>
  56 #include <limits.h>
  57 #include <paths.h>
  58 #include <stdint.h>
  59 #include <stdio.h>
  60 #include <stdlib.h>
  61 #include <string.h>
  62 #include <unistd.h>
  63
  64 #include "kvm_private.h"
  65
  66 SET_DECLARE(kvm_arch, struct kvm_arch);
  67
  68 static char _kd_is_null[] = "";
  69
  70 char *
  71 kvm_geterr(kvm_t *kd)
  72 {
  73
  74         if (kd == NULL)
  75                 return (_kd_is_null);
  76         return (kd->errbuf);
  77 }
  78
  79 static int
  80 _kvm_read_kernel_ehdr(kvm_t *kd)
  81 {
  82         Elf *elf;
  83
  84         if (elf_version(EV_CURRENT) == EV_NONE) {
  85                 _kvm_err(kd, kd->program, "Unsupported libelf");
  86                 return (-1);
  87         }
  88         elf = elf_begin(kd->nlfd, ELF_C_READ, NULL);
  89         if (elf == NULL) {
  90                 _kvm_err(kd, kd->program, "%s", elf_errmsg(0));
  91                 return (-1);
  92         }
  93         if (elf_kind(elf) != ELF_K_ELF) {
  94                 _kvm_err(kd, kd->program, "kernel is not an ELF file");
  95                 return (-1);
  96         }
  97         if (gelf_getehdr(elf, &kd->nlehdr) == NULL) {
  98                 _kvm_err(kd, kd->program, "%s", elf_errmsg(0));
  99                 elf_end(elf);
 100                 return (-1);
 101         }
 102         elf_end(elf);
 103
 104         switch (kd->nlehdr.e_ident[EI_DATA]) {
 105         case ELFDATA2LSB:
 106         case ELFDATA2MSB:
 107                 return (0);
 108         default:
 109                 _kvm_err(kd, kd->program,
 110                     "unsupported ELF data encoding for kernel");
 111                 return (-1);
 112         }
 113 }
 114
 115 static kvm_t *
 116 _kvm_open(kvm_t *kd, const char *uf, const char *mf, int flag, char *errout)
 117 {
 118         struct kvm_arch **parch;
 119         struct stat st;
 120
 121         kd->vmfd = -1;
 122         kd->pmfd = -1;
 123         kd->nlfd = -1;
 124         kd->vmst = NULL;
 125         kd->procbase = NULL;
 126         kd->argspc = NULL;
 127         kd->argv = NULL;
 128
 129         if (uf == NULL)
 130                 uf = getbootfile();
 131         else if (strlen(uf) >= MAXPATHLEN) {
 132                 _kvm_err(kd, kd->program, "exec file name too long");
 133                 goto failed;
 134         }
 135         if (flag & ~O_RDWR) {
 136                 _kvm_err(kd, kd->program, "bad flags arg");
 137                 goto failed;
 138         }
 139         if (mf == NULL)
 140                 mf = _PATH_MEM;
 141
 142         if ((kd->pmfd = open(mf, flag | O_CLOEXEC, 0)) < 0) {
 143                 _kvm_syserr(kd, kd->program, "%s", mf);
 144                 goto failed;
 145         }
 146         if (fstat(kd->pmfd, &st) < 0) {
 147                 _kvm_syserr(kd, kd->program, "%s", mf);
 148                 goto failed;
 149         }
 150         if (S_ISREG(st.st_mode) && st.st_size <= 0) {
 151                 errno = EINVAL;
 152                 _kvm_syserr(kd, kd->program, "empty file");
 153                 goto failed;
 154         }
 155         if (S_ISCHR(st.st_mode)) {
 156                 /*
 157                  * If this is a character special device, then check that
 158                  * it's /dev/mem.  If so, open kmem too.  (Maybe we should
 159                  * make it work for either /dev/mem or /dev/kmem -- in either
 160                  * case you're working with a live kernel.)
 161                  */
 162                 if (strcmp(mf, _PATH_DEVNULL) == 0) {
 163                         kd->vmfd = open(_PATH_DEVNULL, O_RDONLY | O_CLOEXEC);
 164                         return (kd);
 165                 } else if (strcmp(mf, _PATH_MEM) == 0) {
 166                         if ((kd->vmfd = open(_PATH_KMEM, flag | O_CLOEXEC)) <
 167                             0) {
 168                                 _kvm_syserr(kd, kd->program, "%s", _PATH_KMEM);
 169                                 goto failed;
 170                         }
 171                         return (kd);
 172                 }
 173         }
 174
 175         /*
 176          * This is either a crash dump or a remote live system with its physical
 177          * memory fully accessible via a special device.
 178          * Open the namelist fd and determine the architecture.
 179          */
 180         if ((kd->nlfd = open(uf, O_RDONLY | O_CLOEXEC, 0)) < 0) {
 181                 _kvm_syserr(kd, kd->program, "%s", uf);
 182                 goto failed;
 183         }
 184         if (_kvm_read_kernel_ehdr(kd) < 0)
 185                 goto failed;
 186         if (strncmp(mf, _PATH_FWMEM, strlen(_PATH_FWMEM)) == 0 ||
 187             strncmp(mf, _PATH_DEVVMM, strlen(_PATH_DEVVMM)) == 0) {
 188                 kd->rawdump = 1;
 189                 kd->writable = 1;
 190         }
 191         SET_FOREACH(parch, kvm_arch) {
 192                 if ((*parch)->ka_probe(kd)) {
 193                         kd->arch = *parch;
 194                         break;
 195                 }
 196         }
 197         if (kd->arch == NULL) {
 198                 _kvm_err(kd, kd->program, "unsupported architecture");
 199                 goto failed;
 200         }
 201
 202         /*
 203          * Non-native kernels require a symbol resolver.
 204          */
 205         if (!kd->arch->ka_native(kd) && kd->resolve_symbol == NULL) {
 206                 _kvm_err(kd, kd->program,
 207                     "non-native kernel requires a symbol resolver");
 208                 goto failed;
 209         }
 210
 211         /*
 212          * Initialize the virtual address translation machinery.
 213          */
 214         if (kd->arch->ka_initvtop(kd) < 0)
 215                 goto failed;
 216         return (kd);
 217 failed:
 218         /*
 219          * Copy out the error if doing sane error semantics.
 220          */
 221         if (errout != NULL)
 222                 strlcpy(errout, kd->errbuf, _POSIX2_LINE_MAX);
 223         (void)kvm_close(kd);
 224         return (NULL);
 225 }
 226
 227 kvm_t *
 228 kvm_openfiles(const char *uf, const char *mf, const char *sf __unused, int flag,
 229     char *errout)
 230 {
 231         kvm_t *kd;
 232
 233         if ((kd = calloc(1, sizeof(*kd))) == NULL) {
 234                 if (errout != NULL)
 235                         (void)strlcpy(errout, strerror(errno),
 236                             _POSIX2_LINE_MAX);
 237                 return (NULL);
 238         }
 239         return (_kvm_open(kd, uf, mf, flag, errout));
 240 }
 241
 242 kvm_t *
 243 kvm_open(const char *uf, const char *mf, const char *sf __unused, int flag,
 244     const char *errstr)
 245 {
 246         kvm_t *kd;
 247
 248         if ((kd = calloc(1, sizeof(*kd))) == NULL) {
 249                 if (errstr != NULL)
 250                         (void)fprintf(stderr, "%s: %s\n",
 251                                       errstr, strerror(errno));
 252                 return (NULL);
 253         }
 254         kd->program = errstr;
 255         return (_kvm_open(kd, uf, mf, flag, NULL));
 256 }
 257
 258 kvm_t *
 259 kvm_open2(const char *uf, const char *mf, int flag, char *errout,
 260     int (*resolver)(const char *, kvaddr_t *))
 261 {
 262         kvm_t *kd;
 263
 264         if ((kd = calloc(1, sizeof(*kd))) == NULL) {
 265                 if (errout != NULL)
 266                         (void)strlcpy(errout, strerror(errno),
 267                             _POSIX2_LINE_MAX);
 268                 return (NULL);
 269         }
 270         kd->resolve_symbol = resolver;
 271         return (_kvm_open(kd, uf, mf, flag, errout));
 272 }
 273
 274 int
 275 kvm_close(kvm_t *kd)
 276 {
 277         int error = 0;
 278
 279         if (kd == NULL) {
 280                 errno = EINVAL;
 281                 return (-1);
 282         }
 283         if (kd->vmst != NULL)
 284                 kd->arch->ka_freevtop(kd);
 285         if (kd->pmfd >= 0)
 286                 error |= close(kd->pmfd);
 287         if (kd->vmfd >= 0)
 288                 error |= close(kd->vmfd);
 289         if (kd->nlfd >= 0)
 290                 error |= close(kd->nlfd);
 291         if (kd->procbase != 0)
 292                 free((void *)kd->procbase);
 293         if (kd->argbuf != 0)
 294                 free((void *) kd->argbuf);
 295         if (kd->argspc != 0)
 296                 free((void *) kd->argspc);
 297         if (kd->argv != 0)
 298                 free((void *)kd->argv);
 299         if (kd->pt_map != NULL)
 300                 free(kd->pt_map);
 301         if (kd->page_map != NULL)
 302                 free(kd->page_map);
 303         if (kd->sparse_map != MAP_FAILED)
 304                 munmap(kd->sparse_map, kd->pt_sparse_size);
 305         free((void *)kd);
 306
 307         return (error);
 308 }
 309
 310 int
 311 kvm_nlist2(kvm_t *kd, struct kvm_nlist *nl)
 312 {
 313
 314         /*
 315          * If called via the public interface, permit initialization of
 316          * further virtualized modules on demand.
 317          */
 318         return (_kvm_nlist(kd, nl, 1));
 319 }
 320
 321 int
 322 kvm_nlist(kvm_t *kd, struct nlist *nl)
 323 {
 324         struct kvm_nlist *kl;
 325         int count, i, nfail;
 326
 327         /*
 328          * Avoid reporting truncated addresses by failing for non-native
 329          * cores.
 330          */
 331         if (!kvm_native(kd)) {
 332                 _kvm_err(kd, kd->program, "kvm_nlist of non-native vmcore");
 333                 return (-1);
 334         }
 335
 336         for (count = 0; nl[count].n_name != NULL && nl[count].n_name[0] != '\0';
 337              count++)
 338                 ;
 339         if (count == 0)
 340                 return (0);
 341         kl = calloc(count + 1, sizeof(*kl));
 342         for (i = 0; i < count; i++)
 343                 kl[i].n_name = nl[i].n_name;
 344         nfail = kvm_nlist2(kd, kl);
 345         for (i = 0; i < count; i++) {
 346                 nl[i].n_type = kl[i].n_type;
 347                 nl[i].n_other = 0;
 348                 nl[i].n_desc = 0;
 349                 nl[i].n_value = kl[i].n_value;
 350         }
 351         return (nfail);
 352 }
 353
 354 ssize_t
 355 kvm_read(kvm_t *kd, u_long kva, void *buf, size_t len)
 356 {
 357
 358         return (kvm_read2(kd, kva, buf, len));
 359 }
 360
 361 ssize_t
 362 kvm_read2(kvm_t *kd, kvaddr_t kva, void *buf, size_t len)
 363 {
 364         int cc;
 365         ssize_t cr;
 366         off_t pa;
 367         char *cp;
 368
 369         if (ISALIVE(kd)) {
 370                 /*
 371                  * We're using /dev/kmem.  Just read straight from the
 372                  * device and let the active kernel do the address translation.
 373                  */
 374                 errno = 0;
 375                 if (lseek(kd->vmfd, (off_t)kva, 0) == -1 && errno != 0) {
 376                         _kvm_err(kd, 0, "invalid address (0x%jx)",
 377                             (uintmax_t)kva);
 378                         return (-1);
 379                 }
 380                 cr = read(kd->vmfd, buf, len);
 381                 if (cr < 0) {
 382                         _kvm_syserr(kd, 0, "kvm_read");
 383                         return (-1);
 384                 } else if (cr < (ssize_t)len)
 385                         _kvm_err(kd, kd->program, "short read");
 386                 return (cr);
 387         }
 388
 389         cp = buf;
 390         while (len > 0) {
 391                 cc = kd->arch->ka_kvatop(kd, kva, &pa);
 392                 if (cc == 0)
 393                         return (-1);
 394                 if (cc > (ssize_t)len)
 395                         cc = len;
 396                 errno = 0;
 397                 if (lseek(kd->pmfd, pa, 0) == -1 && errno != 0) {
 398                         _kvm_syserr(kd, 0, _PATH_MEM);
 399                         break;
 400                 }
 401                 cr = read(kd->pmfd, cp, cc);
 402                 if (cr < 0) {
 403                         _kvm_syserr(kd, kd->program, "kvm_read");
 404                         break;
 405                 }
 406                 /*
 407                  * If ka_kvatop returns a bogus value or our core file is
 408                  * truncated, we might wind up seeking beyond the end of the
 409                  * core file in which case the read will return 0 (EOF).
 410                  */
 411                 if (cr == 0)
 412                         break;
 413                 cp += cr;
 414                 kva += cr;
 415                 len -= cr;
 416         }
 417
 418         return (cp - (char *)buf);
 419 }
 420
 421 ssize_t
 422 kvm_write(kvm_t *kd, u_long kva, const void *buf, size_t len)
 423 {
 424         int cc;
 425         ssize_t cw;
 426         off_t pa;
 427         const char *cp;
 428
 429         if (!ISALIVE(kd) && !kd->writable) {
 430                 _kvm_err(kd, kd->program,
 431                     "kvm_write not implemented for dead kernels");
 432                 return (-1);
 433         }
 434
 435         if (ISALIVE(kd)) {
 436                 /*
 437                  * Just like kvm_read, only we write.
 438                  */
 439                 errno = 0;
 440                 if (lseek(kd->vmfd, (off_t)kva, 0) == -1 && errno != 0) {
 441                         _kvm_err(kd, 0, "invalid address (%lx)", kva);
 442                         return (-1);
 443                 }
 444                 cc = write(kd->vmfd, buf, len);
 445                 if (cc < 0) {
 446                         _kvm_syserr(kd, 0, "kvm_write");
 447                         return (-1);
 448                 } else if ((size_t)cc < len)
 449                         _kvm_err(kd, kd->program, "short write");
 450                 return (cc);
 451         }
 452
 453         cp = buf;
 454         while (len > 0) {
 455                 cc = kd->arch->ka_kvatop(kd, kva, &pa);
 456                 if (cc == 0)
 457                         return (-1);
 458                 if (cc > (ssize_t)len)
 459                         cc = len;
 460                 errno = 0;
 461                 if (lseek(kd->pmfd, pa, 0) == -1 && errno != 0) {
 462                         _kvm_syserr(kd, 0, _PATH_MEM);
 463                         break;
 464                 }
 465                 cw = write(kd->pmfd, cp, cc);
 466                 if (cw < 0) {
 467                         _kvm_syserr(kd, kd->program, "kvm_write");
 468                         break;
 469                 }
 470                 /*
 471                  * If ka_kvatop returns a bogus value or our core file is
 472                  * truncated, we might wind up seeking beyond the end of the
 473                  * core file in which case the read will return 0 (EOF).
 474                  */
 475                 if (cw == 0)
 476                         break;
 477                 cp += cw;
 478                 kva += cw;
 479                 len -= cw;
 480         }
 481
 482         return (cp - (const char *)buf);
 483 }
 484
 485 int
 486 kvm_native(kvm_t *kd)
 487 {
 488
 489         if (ISALIVE(kd))
 490                 return (1);
 491         return (kd->arch->ka_native(kd));
 492 }
 493
 494 int
 495 kvm_walk_pages(kvm_t *kd, kvm_walk_pages_cb_t *cb, void *closure)
 496 {
 497
 498         if (kd->arch->ka_walk_pages == NULL)
 499                 return (0);
 500
 501         return (kd->arch->ka_walk_pages(kd, cb, closure));
 502 }
 503
 504 kssize_t
 505 kvm_kerndisp(kvm_t *kd)
 506 {
 507         unsigned long kernbase, rel_kernbase;
 508         size_t kernbase_len = sizeof(kernbase);
 509         size_t rel_kernbase_len = sizeof(rel_kernbase);
 510
 511         if (ISALIVE(kd)) {
 512                 if (sysctlbyname("kern.base_address", &kernbase,
 513                     &kernbase_len, NULL, 0) == -1) {
 514                         _kvm_syserr(kd, kd->program,
 515                                 "failed to get kernel base address");
 516                         return (0);
 517                 }
 518                 if (sysctlbyname("kern.relbase_address", &rel_kernbase,
 519                     &rel_kernbase_len, NULL, 0) == -1) {
 520                         _kvm_syserr(kd, kd->program,
 521                                 "failed to get relocated kernel base address");
 522                         return (0);
 523                 }
 524                 return (rel_kernbase - kernbase);
 525         }
 526
 527         if (kd->arch->ka_kerndisp == NULL)
 528                 return (0);
 529
 530         return (kd->arch->ka_kerndisp(kd));
 531 }