usr.sbin/kgmon/kgmon.c

   1 /*
   2  * Copyright (c) 1983, 1992, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *      This product includes software developed by the University of
  16  *      California, Berkeley and its contributors.
  17  * 4. 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  * @(#) Copyright (c) 1983, 1992, 1993 The Regents of the University of California.  All rights reserved.
  34  * @(#)kgmon.c  8.1 (Berkeley) 6/6/93
  35  * $FreeBSD: src/usr.sbin/kgmon/kgmon.c,v 1.9 1999/08/28 01:16:42 peter Exp $
  36  * $DragonFly: src/usr.sbin/kgmon/kgmon.c,v 1.5 2004/04/21 21:29:55 cpressey Exp $
  37  */
  38
  39 #include <sys/param.h>
  40 #include <sys/file.h>
  41 #include <sys/time.h>
  42 #include <sys/sysctl.h>
  43 #include <sys/gmon.h>
  44 #include <ctype.h>
  45 #include <err.h>
  46 #include <errno.h>
  47 #include <kvm.h>
  48 #include <limits.h>
  49 #include <nlist.h>
  50 #include <paths.h>
  51 #include <stdio.h>
  52 #include <stdlib.h>
  53 #include <string.h>
  54 #include <unistd.h>
  55
  56 struct nlist nl[] = {
  57 #define N_GMONPARAM     0
  58         { "__gmonparam" },
  59 #define N_PROFHZ        1
  60         { "_profhz" },
  61         { NULL },
  62 };
  63
  64 struct kvmvars {
  65         kvm_t   *kd;
  66         struct gmonparam gpm;
  67 };
  68
  69 int     Bflag, bflag, hflag, kflag, rflag, pflag;
  70 int     debug = 0;
  71 int     getprof(struct kvmvars *);
  72 int     getprofhz(struct kvmvars *);
  73 void    kern_readonly(int);
  74 int     openfiles(char *, char *, struct kvmvars *);
  75 void    setprof(struct kvmvars *kvp, int state);
  76 void    dumpstate(struct kvmvars *kvp);
  77 void    reset(struct kvmvars *kvp);
  78 static void usage(void);
  79
  80 int
  81 main(int argc, char **argv)
  82 {
  83         int ch, mode, disp, accessmode;
  84         struct kvmvars kvmvars;
  85         char *system, *kmemf;
  86
  87         seteuid(getuid());
  88         kmemf = NULL;
  89         system = NULL;
  90         while ((ch = getopt(argc, argv, "M:N:Bbhpr")) != -1) {
  91                 switch((char)ch) {
  92
  93                 case 'M':
  94                         kmemf = optarg;
  95                         kflag = 1;
  96                         break;
  97
  98                 case 'N':
  99                         system = optarg;
 100                         break;
 101
 102                 case 'B':
 103                         Bflag = 1;
 104                         break;
 105
 106                 case 'b':
 107                         bflag = 1;
 108                         break;
 109
 110                 case 'h':
 111                         hflag = 1;
 112                         break;
 113
 114                 case 'p':
 115                         pflag = 1;
 116                         break;
 117
 118                 case 'r':
 119                         rflag = 1;
 120                         break;
 121
 122                 default:
 123                         usage();
 124                 }
 125         }
 126         argc -= optind;
 127         argv += optind;
 128
 129 #define BACKWARD_COMPATIBILITY
 130 #ifdef  BACKWARD_COMPATIBILITY
 131         if (*argv) {
 132                 system = *argv;
 133                 if (*++argv) {
 134                         kmemf = *argv;
 135                         ++kflag;
 136                 }
 137         }
 138 #endif
 139         if (system == NULL)
 140                 system = (char *)getbootfile();
 141         accessmode = openfiles(system, kmemf, &kvmvars);
 142         mode = getprof(&kvmvars);
 143         if (hflag)
 144                 disp = GMON_PROF_OFF;
 145         else if (Bflag)
 146                 disp = GMON_PROF_HIRES;
 147         else if (bflag)
 148                 disp = GMON_PROF_ON;
 149         else
 150                 disp = mode;
 151         if (pflag)
 152                 dumpstate(&kvmvars);
 153         if (rflag)
 154                 reset(&kvmvars);
 155         if (accessmode == O_RDWR)
 156                 setprof(&kvmvars, disp);
 157         fprintf(stdout, "kgmon: kernel profiling is %s.\n",
 158                       disp == GMON_PROF_OFF ? "off" :
 159                       disp == GMON_PROF_HIRES ? "running (high resolution)" :
 160                       disp == GMON_PROF_ON ? "running" :
 161                       disp == GMON_PROF_BUSY ? "busy" :
 162                       disp == GMON_PROF_ERROR ? "off (error)" :
 163                       "in an unknown state");
 164         return (0);
 165 }
 166
 167 static void
 168 usage(void)
 169 {
 170         fprintf(stderr, "usage: kgmon [-Bbhrp] [-M core] [-N system]\n");
 171         exit(1);
 172 }
 173
 174 /*
 175  * Check that profiling is enabled and open any ncessary files.
 176  */
 177 int
 178 openfiles(char *system, char *kmemf, struct kvmvars *kvp)
 179 {
 180         int mib[3], state, size, openmode;
 181         char errbuf[_POSIX2_LINE_MAX];
 182
 183         if (!kflag) {
 184                 mib[0] = CTL_KERN;
 185                 mib[1] = KERN_PROF;
 186                 mib[2] = GPROF_STATE;
 187                 size = sizeof state;
 188                 if (sysctl(mib, 3, &state, &size, NULL, 0) < 0)
 189                         errx(20, "profiling not defined in kernel");
 190                 if (!(Bflag || bflag || hflag || rflag ||
 191                     (pflag &&
 192                      (state == GMON_PROF_HIRES || state == GMON_PROF_ON))))
 193                         return (O_RDONLY);
 194                 seteuid(0);
 195                 if (sysctl(mib, 3, NULL, NULL, &state, size) >= 0)
 196                         return (O_RDWR);
 197                 seteuid(getuid());
 198                 kern_readonly(state);
 199                 return (O_RDONLY);
 200         }
 201         openmode = (Bflag || bflag || hflag || pflag || rflag)
 202                    ? O_RDWR : O_RDONLY;
 203         kvp->kd = kvm_openfiles(system, kmemf, NULL, openmode, errbuf);
 204         if (kvp->kd == NULL) {
 205                 if (openmode == O_RDWR) {
 206                         openmode = O_RDONLY;
 207                         kvp->kd = kvm_openfiles(system, kmemf, NULL, O_RDONLY,
 208                             errbuf);
 209                 }
 210                 if (kvp->kd == NULL)
 211                         errx(2, "kvm_openfiles: %s", errbuf);
 212                 kern_readonly(GMON_PROF_ON);
 213         }
 214         if (kvm_nlist(kvp->kd, nl) < 0)
 215                 errx(3, "%s: no namelist", system);
 216         if (!nl[N_GMONPARAM].n_value)
 217                 errx(20, "profiling not defined in kernel");
 218         return (openmode);
 219 }
 220
 221 /*
 222  * Suppress options that require a writable kernel.
 223  */
 224 void
 225 kern_readonly(int mode)
 226 {
 227         fprintf(stderr, "kgmon: kernel read-only: ");
 228         if (pflag && (mode == GMON_PROF_HIRES || mode == GMON_PROF_ON))
 229                 fprintf(stderr, "data may be inconsistent\n");
 230         if (rflag)
 231                 fprintf(stderr, "-r supressed\n");
 232         if (Bflag)
 233                 fprintf(stderr, "-B supressed\n");
 234         if (bflag)
 235                 fprintf(stderr, "-b supressed\n");
 236         if (hflag)
 237                 fprintf(stderr, "-h supressed\n");
 238         rflag = Bflag = bflag = hflag = 0;
 239 }
 240
 241 /*
 242  * Get the state of kernel profiling.
 243  */
 244 int
 245 getprof(struct kvmvars *kvp)
 246 {
 247         int mib[3], size;
 248
 249         if (kflag) {
 250                 size = kvm_read(kvp->kd, nl[N_GMONPARAM].n_value, &kvp->gpm,
 251                     sizeof kvp->gpm);
 252         } else {
 253                 mib[0] = CTL_KERN;
 254                 mib[1] = KERN_PROF;
 255                 mib[2] = GPROF_GMONPARAM;
 256                 size = sizeof kvp->gpm;
 257                 if (sysctl(mib, 3, &kvp->gpm, &size, NULL, 0) < 0)
 258                         size = 0;
 259         }
 260         if (size != sizeof kvp->gpm)
 261                 errx(4, "cannot get gmonparam: %s",
 262                     kflag ? kvm_geterr(kvp->kd) : strerror(errno));
 263         return (kvp->gpm.state);
 264 }
 265
 266 /*
 267  * Enable or disable kernel profiling according to the state variable.
 268  */
 269 void
 270 setprof(struct kvmvars *kvp, int state)
 271 {
 272         struct gmonparam *p = (struct gmonparam *)nl[N_GMONPARAM].n_value;
 273         int mib[3], sz, oldstate;
 274
 275         sz = sizeof(state);
 276         if (!kflag) {
 277                 mib[0] = CTL_KERN;
 278                 mib[1] = KERN_PROF;
 279                 mib[2] = GPROF_STATE;
 280                 if (sysctl(mib, 3, &oldstate, &sz, NULL, 0) < 0)
 281                         goto bad;
 282                 if (oldstate == state)
 283                         return;
 284                 seteuid(0);
 285                 if (sysctl(mib, 3, NULL, NULL, &state, sz) >= 0) {
 286                         seteuid(getuid());
 287                         return;
 288                 }
 289                 seteuid(getuid());
 290         } else if (kvm_write(kvp->kd, (u_long)&p->state, (void *)&state, sz)
 291             == sz)
 292                 return;
 293 bad:
 294         warnx("warning: cannot turn profiling %s",
 295             state == GMON_PROF_OFF ? "off" : "on");
 296 }
 297
 298 /*
 299  * Build the gmon.out file.
 300  */
 301 void
 302 dumpstate(struct kvmvars *kvp)
 303 {
 304         FILE *fp;
 305         struct rawarc rawarc;
 306         struct tostruct *tos;
 307         u_long frompc;
 308         u_short *froms, *tickbuf;
 309         int mib[3], i;
 310         struct gmonhdr h;
 311         int fromindex, endfrom, toindex;
 312
 313         setprof(kvp, GMON_PROF_OFF);
 314         fp = fopen("gmon.out", "w");
 315         if (fp == 0) {
 316                 warn("gmon.out");
 317                 return;
 318         }
 319
 320         /*
 321          * Build the gmon header and write it to a file.
 322          */
 323         bzero(&h, sizeof(h));
 324         h.lpc = kvp->gpm.lowpc;
 325         h.hpc = kvp->gpm.highpc;
 326         h.ncnt = kvp->gpm.kcountsize + sizeof(h);
 327         h.version = GMONVERSION;
 328         h.profrate = kvp->gpm.profrate;
 329         if (h.profrate == 0)
 330                 h.profrate = getprofhz(kvp);    /* ancient kernel */
 331         fwrite((char *)&h, sizeof(h), 1, fp);
 332
 333         /*
 334          * Write out the tick buffer.
 335          */
 336         mib[0] = CTL_KERN;
 337         mib[1] = KERN_PROF;
 338         if ((tickbuf = (u_short *)malloc(kvp->gpm.kcountsize)) == NULL)
 339                 errx(5, "cannot allocate kcount space");
 340         if (kflag) {
 341                 i = kvm_read(kvp->kd, (u_long)kvp->gpm.kcount, (void *)tickbuf,
 342                     kvp->gpm.kcountsize);
 343         } else {
 344                 mib[2] = GPROF_COUNT;
 345                 i = kvp->gpm.kcountsize;
 346                 if (sysctl(mib, 3, tickbuf, &i, NULL, 0) < 0)
 347                         i = 0;
 348         }
 349         if (i != kvp->gpm.kcountsize)
 350                 errx(6, "read ticks: read %u, got %d: %s",
 351                     kvp->gpm.kcountsize, i,
 352                     kflag ? kvm_geterr(kvp->kd) : strerror(errno));
 353         if ((fwrite(tickbuf, kvp->gpm.kcountsize, 1, fp)) != 1)
 354                 err(7, "writing tocks to gmon.out");
 355         free(tickbuf);
 356
 357         /*
 358          * Write out the arc info.
 359          */
 360         if ((froms = (u_short *)malloc(kvp->gpm.fromssize)) == NULL)
 361                 errx(8, "cannot allocate froms space");
 362         if (kflag) {
 363                 i = kvm_read(kvp->kd, (u_long)kvp->gpm.froms, (void *)froms,
 364                     kvp->gpm.fromssize);
 365         } else {
 366                 mib[2] = GPROF_FROMS;
 367                 i = kvp->gpm.fromssize;
 368                 if (sysctl(mib, 3, froms, &i, NULL, 0) < 0)
 369                         i = 0;
 370         }
 371         if (i != kvp->gpm.fromssize)
 372                 errx(9, "read froms: read %u, got %d: %s",
 373                     kvp->gpm.fromssize, i,
 374                     kflag ? kvm_geterr(kvp->kd) : strerror(errno));
 375         if ((tos = (struct tostruct *)malloc(kvp->gpm.tossize)) == NULL)
 376                 errx(10, "cannot allocate tos space");
 377         if (kflag) {
 378                 i = kvm_read(kvp->kd, (u_long)kvp->gpm.tos, (void *)tos,
 379                     kvp->gpm.tossize);
 380         } else {
 381                 mib[2] = GPROF_TOS;
 382                 i = kvp->gpm.tossize;
 383                 if (sysctl(mib, 3, tos, &i, NULL, 0) < 0)
 384                         i = 0;
 385         }
 386         if (i != kvp->gpm.tossize)
 387                 errx(11, "read tos: read %u, got %d: %s",
 388                     kvp->gpm.tossize, i,
 389                     kflag ? kvm_geterr(kvp->kd) : strerror(errno));
 390         if (debug)
 391                 warnx("lowpc 0x%x, textsize 0x%x",
 392                               kvp->gpm.lowpc, kvp->gpm.textsize);
 393         endfrom = kvp->gpm.fromssize / sizeof(*froms);
 394         for (fromindex = 0; fromindex < endfrom; ++fromindex) {
 395                 if (froms[fromindex] == 0)
 396                         continue;
 397                 frompc = (u_long)kvp->gpm.lowpc +
 398                     (fromindex * kvp->gpm.hashfraction * sizeof(*froms));
 399                 for (toindex = froms[fromindex]; toindex != 0;
 400                    toindex = tos[toindex].link) {
 401                         if (debug)
 402                             warnx("[mcleanup] frompc 0x%x selfpc 0x%x count %d",
 403                             frompc, tos[toindex].selfpc,
 404                             tos[toindex].count);
 405                         rawarc.raw_frompc = frompc;
 406                         rawarc.raw_selfpc = (u_long)tos[toindex].selfpc;
 407                         rawarc.raw_count = tos[toindex].count;
 408                         fwrite((char *)&rawarc, sizeof(rawarc), 1, fp);
 409                 }
 410         }
 411         fclose(fp);
 412 }
 413
 414 /*
 415  * Get the profiling rate.
 416  */
 417 int
 418 getprofhz(struct kvmvars *kvp)
 419 {
 420         int mib[2], size, profrate;
 421         struct clockinfo clockrate;
 422
 423         if (kflag) {
 424                 profrate = 1;
 425                 if (kvm_read(kvp->kd, nl[N_PROFHZ].n_value, &profrate,
 426                     sizeof profrate) != sizeof profrate)
 427                         warnx("get clockrate: %s", kvm_geterr(kvp->kd));
 428                 return (profrate);
 429         }
 430         mib[0] = CTL_KERN;
 431         mib[1] = KERN_CLOCKRATE;
 432         clockrate.profhz = 1;
 433         size = sizeof clockrate;
 434         if (sysctl(mib, 2, &clockrate, &size, NULL, 0) < 0)
 435                 warn("get clockrate");
 436         return (clockrate.profhz);
 437 }
 438
 439 /*
 440  * Reset the kernel profiling date structures.
 441  */
 442 void
 443 reset(struct kvmvars *kvp)
 444 {
 445         char *zbuf;
 446         u_long biggest;
 447         int mib[3];
 448
 449         setprof(kvp, GMON_PROF_OFF);
 450
 451         biggest = kvp->gpm.kcountsize;
 452         if (kvp->gpm.fromssize > biggest)
 453                 biggest = kvp->gpm.fromssize;
 454         if (kvp->gpm.tossize > biggest)
 455                 biggest = kvp->gpm.tossize;
 456         if ((zbuf = (char *)malloc(biggest)) == NULL)
 457                 errx(12, "cannot allocate zbuf space");
 458         bzero(zbuf, biggest);
 459         if (kflag) {
 460                 if (kvm_write(kvp->kd, (u_long)kvp->gpm.kcount, zbuf,
 461                     kvp->gpm.kcountsize) != kvp->gpm.kcountsize)
 462                         errx(13, "tickbuf zero: %s", kvm_geterr(kvp->kd));
 463                 if (kvm_write(kvp->kd, (u_long)kvp->gpm.froms, zbuf,
 464                     kvp->gpm.fromssize) != kvp->gpm.fromssize)
 465                         errx(14, "froms zero: %s", kvm_geterr(kvp->kd));
 466                 if (kvm_write(kvp->kd, (u_long)kvp->gpm.tos, zbuf,
 467                     kvp->gpm.tossize) != kvp->gpm.tossize)
 468                         errx(15, "tos zero: %s", kvm_geterr(kvp->kd));
 469                 return;
 470         }
 471         seteuid(0);
 472         mib[0] = CTL_KERN;
 473         mib[1] = KERN_PROF;
 474         mib[2] = GPROF_COUNT;
 475         if (sysctl(mib, 3, NULL, NULL, zbuf, kvp->gpm.kcountsize) < 0)
 476                 err(13, "tickbuf zero");
 477         mib[2] = GPROF_FROMS;
 478         if (sysctl(mib, 3, NULL, NULL, zbuf, kvp->gpm.fromssize) < 0)
 479                 err(14, "froms zero");
 480         mib[2] = GPROF_TOS;
 481         if (sysctl(mib, 3, NULL, NULL, zbuf, kvp->gpm.tossize) < 0)
 482                 err(15, "tos zero");
 483         seteuid(getuid());
 484         free(zbuf);
 485 }