lib/libkvm/kvm.c

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