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. All advertising materials mentioning features or use of this software 18 * must display the following acknowledgement: 19 * This product includes software developed by the University of 20 * California, Berkeley and its contributors. 21 * 4. Neither the name of the University nor the names of its contributors 22 * may be used to endorse or promote products derived from this software 23 * without specific prior written permission. 24 * 25 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 26 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 28 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 31 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 32 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 33 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 34 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 35 * SUCH DAMAGE. 36 */ 37 38 #if defined(LIBC_SCCS) && !defined(lint) 39 static char sccsid[] = "@(#)kvm.c 8.2 (Berkeley) 2/13/94"; 40 #endif /* LIBC_SCCS and not lint */ 41 42 #include <sys/param.h> 43 #include <sys/user.h> 44 #include <sys/proc.h> 45 #include <sys/ioctl.h> 46 #include <sys/stat.h> 47 #include <sys/sysctl.h> 48 49 #include <vm/vm.h> 50 #include <vm/vm_param.h> 51 #include <vm/swap_pager.h> 52 53 #include <machine/vmparam.h> 54 55 #include <ctype.h> 56 #include <db.h> 57 #include <fcntl.h> 58 #include <kvm.h> 59 #include <limits.h> 60 #include <nlist.h> 61 #include <paths.h> 62 #include <stdio.h> 63 #include <stdlib.h> 64 #include <string.h> 65 #include <unistd.h> 66 67 #include "kvm_private.h" 68 69 static int kvm_dbopen __P((kvm_t *, const char *)); 70 71 char * 72 kvm_geterr(kd) 73 kvm_t *kd; 74 { 75 return (kd->errbuf); 76 } 77 78 #if __STDC__ 79 #include <stdarg.h> 80 #else 81 #include <varargs.h> 82 #endif 83 84 /* 85 * Report an error using printf style arguments. "program" is kd->program 86 * on hard errors, and 0 on soft errors, so that under sun error emulation, 87 * only hard errors are printed out (otherwise, programs like gdb will 88 * generate tons of error messages when trying to access bogus pointers). 89 */ 90 void 91 #if __STDC__ 92 _kvm_err(kvm_t *kd, const char *program, const char *fmt, ...) 93 #else 94 _kvm_err(kd, program, fmt, va_alist) 95 kvm_t *kd; 96 char *program, *fmt; 97 va_dcl 98 #endif 99 { 100 va_list ap; 101 102 #ifdef __STDC__ 103 va_start(ap, fmt); 104 #else 105 va_start(ap); 106 #endif 107 if (program != NULL) { 108 (void)fprintf(stderr, "%s: ", program); 109 (void)vfprintf(stderr, fmt, ap); 110 (void)fputc('\n', stderr); 111 } else 112 (void)vsnprintf(kd->errbuf, 113 sizeof(kd->errbuf), (char *)fmt, ap); 114 115 va_end(ap); 116 } 117 118 void 119 #if __STDC__ 120 _kvm_syserr(kvm_t *kd, const char *program, const char *fmt, ...) 121 #else 122 _kvm_syserr(kd, program, fmt, va_alist) 123 kvm_t *kd; 124 char *program, *fmt; 125 va_dcl 126 #endif 127 { 128 va_list ap; 129 register int n; 130 131 #if __STDC__ 132 va_start(ap, fmt); 133 #else 134 va_start(ap); 135 #endif 136 if (program != NULL) { 137 (void)fprintf(stderr, "%s: ", program); 138 (void)vfprintf(stderr, fmt, ap); 139 (void)fprintf(stderr, ": %s\n", strerror(errno)); 140 } else { 141 register char *cp = kd->errbuf; 142 143 (void)vsnprintf(cp, sizeof(kd->errbuf), (char *)fmt, ap); 144 n = strlen(cp); 145 (void)snprintf(&cp[n], sizeof(kd->errbuf) - n, ": %s", 146 strerror(errno)); 147 } 148 va_end(ap); 149 } 150 151 void * 152 _kvm_malloc(kd, n) 153 register kvm_t *kd; 154 register size_t n; 155 { 156 void *p; 157 158 if ((p = malloc(n)) == NULL) 159 _kvm_err(kd, kd->program, strerror(errno)); 160 memset(p, 0, n); 161 return (p); 162 } 163 164 static kvm_t * 165 _kvm_open(kd, uf, mf, sf, flag, errout) 166 register kvm_t *kd; 167 const char *uf; 168 const char *mf; 169 const char *sf; 170 int flag; 171 char *errout; 172 { 173 struct stat st; 174 175 kd->vmfd = -1; 176 kd->pmfd = -1; 177 kd->swfd = -1; 178 kd->nlfd = -1; 179 kd->vmst = 0; 180 kd->db = 0; 181 kd->procbase = 0; 182 kd->argspc = 0; 183 kd->argv = 0; 184 185 if (uf == 0) 186 uf = getbootfile(); 187 else if (strlen(uf) >= MAXPATHLEN) { 188 _kvm_err(kd, kd->program, "exec file name too long"); 189 goto failed; 190 } 191 if (flag & ~O_RDWR) { 192 _kvm_err(kd, kd->program, "bad flags arg"); 193 goto failed; 194 } 195 if (mf == 0) 196 mf = _PATH_MEM; 197 if (sf == 0) 198 sf = _PATH_DRUM; 199 200 if ((kd->pmfd = open(mf, flag, 0)) < 0) { 201 _kvm_syserr(kd, kd->program, "%s", mf); 202 goto failed; 203 } 204 if (fstat(kd->pmfd, &st) < 0) { 205 _kvm_syserr(kd, kd->program, "%s", mf); 206 goto failed; 207 } 208 if (S_ISCHR(st.st_mode)) { 209 /* 210 * If this is a character special device, then check that 211 * it's /dev/mem. If so, open kmem too. (Maybe we should 212 * make it work for either /dev/mem or /dev/kmem -- in either 213 * case you're working with a live kernel.) 214 */ 215 if (strcmp(mf, _PATH_MEM) != 0) { /* XXX */ 216 _kvm_err(kd, kd->program, 217 "%s: not physical memory device", mf); 218 goto failed; 219 } 220 if ((kd->vmfd = open(_PATH_KMEM, flag)) < 0) { 221 _kvm_syserr(kd, kd->program, "%s", _PATH_KMEM); 222 goto failed; 223 } 224 if ((kd->swfd = open(sf, flag, 0)) < 0) { 225 _kvm_syserr(kd, kd->program, "%s", sf); 226 goto failed; 227 } 228 /* 229 * Open kvm nlist database. We go ahead and do this 230 * here so that we don't have to hold on to the kernel 231 * path name. Since a kvm application will surely do 232 * a kvm_nlist(), this probably won't be a wasted effort. 233 * If the database cannot be opened, open the namelist 234 * argument so we revert to slow nlist() calls. 235 */ 236 if (kvm_dbopen(kd, uf) < 0 && 237 (kd->nlfd = open(uf, O_RDONLY, 0)) < 0) { 238 _kvm_syserr(kd, kd->program, "%s", uf); 239 goto failed; 240 } 241 } else { 242 /* 243 * This is a crash dump. 244 * Initalize the virtual address translation machinery, 245 * but first setup the namelist fd. 246 */ 247 if ((kd->nlfd = open(uf, O_RDONLY, 0)) < 0) { 248 _kvm_syserr(kd, kd->program, "%s", uf); 249 goto failed; 250 } 251 if (_kvm_initvtop(kd) < 0) 252 goto failed; 253 } 254 return (kd); 255 failed: 256 /* 257 * Copy out the error if doing sane error semantics. 258 */ 259 if (errout != 0) 260 strcpy(errout, kd->errbuf); 261 (void)kvm_close(kd); 262 return (0); 263 } 264 265 kvm_t * 266 kvm_openfiles(uf, mf, sf, flag, errout) 267 const char *uf; 268 const char *mf; 269 const char *sf; 270 int flag; 271 char *errout; 272 { 273 register kvm_t *kd; 274 275 if ((kd = malloc(sizeof(*kd))) == NULL) { 276 (void)strcpy(errout, strerror(errno)); 277 return (0); 278 } 279 memset(kd, 0, sizeof(*kd)); 280 kd->program = 0; 281 return (_kvm_open(kd, uf, mf, sf, flag, errout)); 282 } 283 284 kvm_t * 285 kvm_open(uf, mf, sf, flag, errstr) 286 const char *uf; 287 const char *mf; 288 const char *sf; 289 int flag; 290 const char *errstr; 291 { 292 register kvm_t *kd; 293 294 if ((kd = malloc(sizeof(*kd))) == NULL) { 295 if (errstr != NULL) 296 (void)fprintf(stderr, "%s: %s\n", 297 errstr, strerror(errno)); 298 return (0); 299 } 300 memset(kd, 0, sizeof(*kd)); 301 kd->program = errstr; 302 return (_kvm_open(kd, uf, mf, sf, flag, NULL)); 303 } 304 305 int 306 kvm_close(kd) 307 kvm_t *kd; 308 { 309 register int error = 0; 310 311 if (kd->pmfd >= 0) 312 error |= close(kd->pmfd); 313 if (kd->vmfd >= 0) 314 error |= close(kd->vmfd); 315 if (kd->nlfd >= 0) 316 error |= close(kd->nlfd); 317 if (kd->swfd >= 0) 318 error |= close(kd->swfd); 319 if (kd->db != 0) 320 error |= (kd->db->close)(kd->db); 321 if (kd->vmst) 322 _kvm_freevtop(kd); 323 if (kd->procbase != 0) 324 free((void *)kd->procbase); 325 if (kd->argv != 0) 326 free((void *)kd->argv); 327 free((void *)kd); 328 329 return (0); 330 } 331 332 /* 333 * Set up state necessary to do queries on the kernel namelist 334 * data base. If the data base is out-of-data/incompatible with 335 * given executable, set up things so we revert to standard nlist call. 336 * Only called for live kernels. Return 0 on success, -1 on failure. 337 */ 338 static int 339 kvm_dbopen(kd, uf) 340 kvm_t *kd; 341 const char *uf; 342 { 343 char *cp; 344 DBT rec; 345 int dbversionlen; 346 struct nlist nitem; 347 char dbversion[_POSIX2_LINE_MAX]; 348 char kversion[_POSIX2_LINE_MAX]; 349 char dbname[MAXPATHLEN]; 350 351 if ((cp = rindex(uf, '/')) != 0) 352 uf = cp + 1; 353 354 (void)snprintf(dbname, sizeof(dbname), "%skvm_%s.db", _PATH_VARDB, uf); 355 kd->db = dbopen(dbname, O_RDONLY, 0, DB_HASH, NULL); 356 if (kd->db == 0) 357 return (-1); 358 /* 359 * read version out of database 360 */ 361 rec.data = VRS_KEY; 362 rec.size = sizeof(VRS_KEY) - 1; 363 if ((kd->db->get)(kd->db, (DBT *)&rec, (DBT *)&rec, 0)) 364 goto close; 365 if (rec.data == 0 || rec.size > sizeof(dbversion)) 366 goto close; 367 368 bcopy(rec.data, dbversion, rec.size); 369 dbversionlen = rec.size; 370 /* 371 * Read version string from kernel memory. 372 * Since we are dealing with a live kernel, we can call kvm_read() 373 * at this point. 374 */ 375 rec.data = VRS_SYM; 376 rec.size = sizeof(VRS_SYM) - 1; 377 if ((kd->db->get)(kd->db, (DBT *)&rec, (DBT *)&rec, 0)) 378 goto close; 379 if (rec.data == 0 || rec.size != sizeof(struct nlist)) 380 goto close; 381 bcopy((char *)rec.data, (char *)&nitem, sizeof(nitem)); 382 if (kvm_read(kd, (u_long)nitem.n_value, kversion, dbversionlen) != 383 dbversionlen) 384 goto close; 385 /* 386 * If they match, we win - otherwise clear out kd->db so 387 * we revert to slow nlist(). 388 */ 389 if (bcmp(dbversion, kversion, dbversionlen) == 0) 390 return (0); 391 close: 392 (void)(kd->db->close)(kd->db); 393 kd->db = 0; 394 395 return (-1); 396 } 397 398 int 399 kvm_nlist(kd, nl) 400 kvm_t *kd; 401 struct nlist *nl; 402 { 403 register struct nlist *p; 404 register int nvalid; 405 406 /* 407 * If we can't use the data base, revert to the 408 * slow library call. 409 */ 410 if (kd->db == 0) 411 return (__fdnlist(kd->nlfd, nl)); 412 413 /* 414 * We can use the kvm data base. Go through each nlist entry 415 * and look it up with a db query. 416 */ 417 nvalid = 0; 418 for (p = nl; p->n_name && p->n_name[0]; ++p) { 419 register int len; 420 DBT rec; 421 422 if ((len = strlen(p->n_name)) > 4096) { 423 /* sanity */ 424 _kvm_err(kd, kd->program, "symbol too large"); 425 return (-1); 426 } 427 rec.data = p->n_name; 428 rec.size = len; 429 if ((kd->db->get)(kd->db, (DBT *)&rec, (DBT *)&rec, 0)) 430 continue; 431 if (rec.data == 0 || rec.size != sizeof(struct nlist)) 432 continue; 433 ++nvalid; 434 /* 435 * Avoid alignment issues. 436 */ 437 bcopy((char *)&((struct nlist *)rec.data)->n_type, 438 (char *)&p->n_type, 439 sizeof(p->n_type)); 440 bcopy((char *)&((struct nlist *)rec.data)->n_value, 441 (char *)&p->n_value, 442 sizeof(p->n_value)); 443 } 444 /* 445 * Return the number of entries that weren't found. 446 */ 447 return ((p - nl) - nvalid); 448 } 449 450 ssize_t 451 kvm_read(kd, kva, buf, len) 452 kvm_t *kd; 453 register u_long kva; 454 register void *buf; 455 register size_t len; 456 { 457 register int cc; 458 register void *cp; 459 460 if (ISALIVE(kd)) { 461 /* 462 * We're using /dev/kmem. Just read straight from the 463 * device and let the active kernel do the address translation. 464 */ 465 errno = 0; 466 if (lseek(kd->vmfd, (off_t)kva, 0) == -1 && errno != 0) { 467 _kvm_err(kd, 0, "invalid address (%x)", kva); 468 return (0); 469 } 470 cc = read(kd->vmfd, buf, len); 471 if (cc < 0) { 472 _kvm_syserr(kd, 0, "kvm_read"); 473 return (0); 474 } else if (cc < len) 475 _kvm_err(kd, kd->program, "short read"); 476 return (cc); 477 } else { 478 cp = buf; 479 while (len > 0) { 480 u_long pa; 481 482 cc = _kvm_kvatop(kd, kva, &pa); 483 if (cc == 0) 484 return (0); 485 if (cc > len) 486 cc = len; 487 errno = 0; 488 if (lseek(kd->pmfd, (off_t)pa, 0) == -1 && errno != 0) { 489 _kvm_syserr(kd, 0, _PATH_MEM); 490 break; 491 } 492 cc = read(kd->pmfd, cp, cc); 493 if (cc < 0) { 494 _kvm_syserr(kd, kd->program, "kvm_read"); 495 break; 496 } 497 /* 498 * If kvm_kvatop returns a bogus value or our core 499 * file is truncated, we might wind up seeking beyond 500 * the end of the core file in which case the read will 501 * return 0 (EOF). 502 */ 503 if (cc == 0) 504 break; 505 (char *)cp += cc; 506 kva += cc; 507 len -= cc; 508 } 509 return ((char *)cp - (char *)buf); 510 } 511 /* NOTREACHED */ 512 } 513 514 ssize_t 515 kvm_write(kd, kva, buf, len) 516 kvm_t *kd; 517 register u_long kva; 518 register const void *buf; 519 register size_t len; 520 { 521 register int cc; 522 523 if (ISALIVE(kd)) { 524 /* 525 * Just like kvm_read, only we write. 526 */ 527 errno = 0; 528 if (lseek(kd->vmfd, (off_t)kva, 0) == -1 && errno != 0) { 529 _kvm_err(kd, 0, "invalid address (%x)", kva); 530 return (0); 531 } 532 cc = write(kd->vmfd, buf, len); 533 if (cc < 0) { 534 _kvm_syserr(kd, 0, "kvm_write"); 535 return (0); 536 } else if (cc < len) 537 _kvm_err(kd, kd->program, "short write"); 538 return (cc); 539 } else { 540 _kvm_err(kd, kd->program, 541 "kvm_write not implemented for dead kernels"); 542 return (0); 543 } 544 /* NOTREACHED */ 545 } 546