gmon/gmon.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  * 4. Neither the name of the University nor the names of its contributors
  14  *    may be used to endorse or promote products derived from this software
  15  *    without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  */
  29 #include <sys/param.h>
  30 #include <sys/time.h>
  31 #include <sys/gmon.h>
  32 #include <sys/gmon_out.h>
  33 #include <sys/uio.h>
  34
  35 #include <errno.h>
  36 #include <stdio.h>
  37 #include <fcntl.h>
  38 #include <unistd.h>
  39
  40 #include <stdio.h>
  41 #include <stdlib.h>
  42 #include <string.h>
  43 #include <unistd.h>
  44 #include <libc-internal.h>
  45
  46 #ifdef USE_IN_LIBIO
  47 # include <wchar.h>
  48 #endif
  49
  50 struct __bb *__bb_head; /*  Head of basic-block list or NULL. */
  51
  52 struct gmonparam _gmonparam = { GMON_PROF_OFF };
  53
  54 /*
  55  * See profil(2) where this is described:
  56  */
  57 static int      s_scale;
  58 #define         SCALE_1_TO_1    0x10000L
  59
  60 #define ERR(s) __write (STDERR_FILENO, s, sizeof (s) - 1)
  61
  62 void moncontrol __P ((int mode));
  63 void __moncontrol __P ((int mode));
  64 static void write_hist __P ((int fd)) internal_function;
  65 static void write_call_graph __P ((int fd)) internal_function;
  66 static void write_bb_counts __P ((int fd)) internal_function;
  67
  68 /*
  69  * Control profiling
  70  *      profiling is what mcount checks to see if
  71  *      all the data structures are ready.
  72  */
  73 void
  74 __moncontrol (mode)
  75      int mode;
  76 {
  77   struct gmonparam *p = &_gmonparam;
  78
  79   /* Don't change the state if we ran into an error.  */
  80   if (p->state == GMON_PROF_ERROR)
  81     return;
  82
  83   if (mode)
  84     {
  85       /* start */
  86       __profil((void *) p->kcount, p->kcountsize, p->lowpc, s_scale);
  87       p->state = GMON_PROF_ON;
  88     }
  89   else
  90     {
  91       /* stop */
  92       __profil(NULL, 0, 0, 0);
  93       p->state = GMON_PROF_OFF;
  94     }
  95 }
  96 weak_alias (__moncontrol, moncontrol)
  97
  98
  99 void
 100 __monstartup (lowpc, highpc)
 101      u_long lowpc;
 102      u_long highpc;
 103 {
 104   register int o;
 105   char *cp;
 106   struct gmonparam *p = &_gmonparam;
 107
 108   /*
 109    * round lowpc and highpc to multiples of the density we're using
 110    * so the rest of the scaling (here and in gprof) stays in ints.
 111    */
 112   p->lowpc = ROUNDDOWN(lowpc, HISTFRACTION * sizeof(HISTCOUNTER));
 113   p->highpc = ROUNDUP(highpc, HISTFRACTION * sizeof(HISTCOUNTER));
 114   p->textsize = p->highpc - p->lowpc;
 115   p->kcountsize = p->textsize / HISTFRACTION;
 116   p->hashfraction = HASHFRACTION;
 117   p->log_hashfraction = -1;
 118   /* The following test must be kept in sync with the corresponding
 119      test in mcount.c.  */
 120   if ((HASHFRACTION & (HASHFRACTION - 1)) == 0) {
 121       /* if HASHFRACTION is a power of two, mcount can use shifting
 122          instead of integer division.  Precompute shift amount. */
 123       p->log_hashfraction = ffs(p->hashfraction * sizeof(*p->froms)) - 1;
 124   }
 125   p->fromssize = p->textsize / HASHFRACTION;
 126   p->tolimit = p->textsize * ARCDENSITY / 100;
 127   if (p->tolimit < MINARCS)
 128     p->tolimit = MINARCS;
 129   else if (p->tolimit > MAXARCS)
 130     p->tolimit = MAXARCS;
 131   p->tossize = p->tolimit * sizeof(struct tostruct);
 132
 133   cp = calloc (p->kcountsize + p->fromssize + p->tossize, 1);
 134   if (! cp)
 135     {
 136       ERR("monstartup: out of memory\n");
 137       p->tos = NULL;
 138       p->state = GMON_PROF_ERROR;
 139       return;
 140     }
 141   p->tos = (struct tostruct *)cp;
 142   cp += p->tossize;
 143   p->kcount = (u_short *)cp;
 144   cp += p->kcountsize;
 145   p->froms = (u_short *)cp;
 146
 147   p->tos[0].link = 0;
 148
 149   o = p->highpc - p->lowpc;
 150   if (p->kcountsize < (u_long) o)
 151     {
 152 #ifndef hp300
 153       s_scale = ((float)p->kcountsize / o ) * SCALE_1_TO_1;
 154 #else
 155       /* avoid floating point operations */
 156       int quot = o / p->kcountsize;
 157
 158       if (quot >= 0x10000)
 159         s_scale = 1;
 160       else if (quot >= 0x100)
 161         s_scale = 0x10000 / quot;
 162       else if (o >= 0x800000)
 163         s_scale = 0x1000000 / (o / (p->kcountsize >> 8));
 164       else
 165         s_scale = 0x1000000 / ((o << 8) / p->kcountsize);
 166 #endif
 167     } else
 168       s_scale = SCALE_1_TO_1;
 169
 170   __moncontrol(1);
 171 }
 172 weak_alias(__monstartup, monstartup)
 173
 174
 175 static void
 176 internal_function
 177 write_hist (fd)
 178      int fd;
 179 {
 180   u_char tag = GMON_TAG_TIME_HIST;
 181   struct gmon_hist_hdr thdr __attribute__ ((aligned (__alignof__ (char *))));
 182
 183   if (_gmonparam.kcountsize > 0)
 184     {
 185       struct iovec iov[3] =
 186         {
 187           { &tag, sizeof (tag) },
 188           { &thdr, sizeof (struct gmon_hist_hdr) },
 189           { _gmonparam.kcount, _gmonparam.kcountsize }
 190         };
 191
 192       *(char **) thdr.low_pc = (char *) _gmonparam.lowpc;
 193       *(char **) thdr.high_pc = (char *) _gmonparam.highpc;
 194       *(int32_t *) thdr.hist_size = (_gmonparam.kcountsize
 195                                      / sizeof (HISTCOUNTER));
 196       *(int32_t *) thdr.prof_rate = __profile_frequency ();
 197       strncpy (thdr.dimen, "seconds", sizeof (thdr.dimen));
 198       thdr.dimen_abbrev = 's';
 199
 200       __writev (fd, iov, 3);
 201     }
 202 }
 203
 204
 205 static void
 206 internal_function
 207 write_call_graph (fd)
 208      int fd;
 209 {
 210 #define NARCS_PER_WRITEV        32
 211   u_char tag = GMON_TAG_CG_ARC;
 212   struct gmon_cg_arc_record raw_arc[NARCS_PER_WRITEV]
 213     __attribute__ ((aligned (__alignof__ (char*))));
 214   int from_index, to_index, from_len;
 215   u_long frompc;
 216   struct iovec iov[2 * NARCS_PER_WRITEV];
 217   int nfilled;
 218
 219   for (nfilled = 0; nfilled < NARCS_PER_WRITEV; ++nfilled)
 220     {
 221       iov[2 * nfilled].iov_base = &tag;
 222       iov[2 * nfilled].iov_len = sizeof (tag);
 223
 224       iov[2 * nfilled + 1].iov_base = &raw_arc[nfilled];
 225       iov[2 * nfilled + 1].iov_len = sizeof (struct gmon_cg_arc_record);
 226     }
 227
 228   nfilled = 0;
 229   from_len = _gmonparam.fromssize / sizeof (*_gmonparam.froms);
 230   for (from_index = 0; from_index < from_len; ++from_index)
 231     {
 232       if (_gmonparam.froms[from_index] == 0)
 233         continue;
 234
 235       frompc = _gmonparam.lowpc;
 236       frompc += (from_index * _gmonparam.hashfraction
 237                  * sizeof (*_gmonparam.froms));
 238       for (to_index = _gmonparam.froms[from_index];
 239            to_index != 0;
 240            to_index = _gmonparam.tos[to_index].link)
 241         {
 242           struct arc
 243             {
 244               char *frompc;
 245               char *selfpc;
 246               int32_t count;
 247             }
 248           arc;
 249
 250           arc.frompc = (char *) frompc;
 251           arc.selfpc = (char *) _gmonparam.tos[to_index].selfpc;
 252           arc.count  = _gmonparam.tos[to_index].count;
 253           memcpy (raw_arc + nfilled, &arc, sizeof (raw_arc [0]));
 254
 255           if (++nfilled == NARCS_PER_WRITEV)
 256             {
 257               __writev (fd, iov, 2 * nfilled);
 258               nfilled = 0;
 259             }
 260         }
 261     }
 262   if (nfilled > 0)
 263     __writev (fd, iov, 2 * nfilled);
 264 }
 265
 266
 267 static void
 268 internal_function
 269 write_bb_counts (fd)
 270      int fd;
 271 {
 272   struct __bb *grp;
 273   u_char tag = GMON_TAG_BB_COUNT;
 274   size_t ncounts;
 275   size_t i;
 276
 277   struct iovec bbhead[2] =
 278     {
 279       { &tag, sizeof (tag) },
 280       { &ncounts, sizeof (ncounts) }
 281     };
 282   struct iovec bbbody[8];
 283   size_t nfilled;
 284
 285   for (i = 0; i < (sizeof (bbbody) / sizeof (bbbody[0])); i += 2)
 286     {
 287       bbbody[i].iov_len = sizeof (grp->addresses[0]);
 288       bbbody[i + 1].iov_len = sizeof (grp->counts[0]);
 289     }
 290
 291   /* Write each group of basic-block info (all basic-blocks in a
 292      compilation unit form a single group). */
 293
 294   for (grp = __bb_head; grp; grp = grp->next)
 295     {
 296       ncounts = grp->ncounts;
 297       __writev (fd, bbhead, 2);
 298       for (nfilled = i = 0; i < ncounts; ++i)
 299         {
 300           if (nfilled > (sizeof (bbbody) / sizeof (bbbody[0])) - 2)
 301             {
 302               __writev (fd, bbbody, nfilled);
 303               nfilled = 0;
 304             }
 305
 306           bbbody[nfilled++].iov_base = (char *) &grp->addresses[i];
 307           bbbody[nfilled++].iov_base = &grp->counts[i];
 308         }
 309       if (nfilled > 0)
 310         __writev (fd, bbbody, nfilled);
 311     }
 312 }
 313
 314
 315 static void
 316 write_gmon (void)
 317 {
 318     struct gmon_hdr ghdr __attribute__ ((aligned (__alignof__ (int))));
 319     int fd = -1;
 320     char *env;
 321
 322     env = getenv ("GMON_OUT_PREFIX");
 323     if (env != NULL && !__libc_enable_secure)
 324       {
 325         size_t len = strlen (env);
 326         char buf[len + 20];
 327         sprintf (buf, "%s.%u", env, __getpid ());
 328         fd = __open (buf, O_CREAT|O_TRUNC|O_WRONLY, 0666);
 329       }
 330
 331     if (fd == -1)
 332       {
 333         fd = __open ("gmon.out", O_CREAT|O_TRUNC|O_WRONLY, 0666);
 334         if (fd < 0)
 335           {
 336             char buf[300];
 337             int errnum = errno;
 338 #ifdef USE_IN_LIBIO
 339             if (_IO_fwide (stderr, 0) > 0)
 340               __fwprintf (stderr, L"_mcleanup: gmon.out: %s\n",
 341                           __strerror_r (errnum, buf, sizeof buf));
 342             else
 343 #endif
 344               fprintf (stderr, "_mcleanup: gmon.out: %s\n",
 345                        __strerror_r (errnum, buf, sizeof buf));
 346             return;
 347           }
 348       }
 349
 350     /* write gmon.out header: */
 351     memset (&ghdr, '\0', sizeof (struct gmon_hdr));
 352     memcpy (&ghdr.cookie[0], GMON_MAGIC, sizeof (ghdr.cookie));
 353     *(int32_t *) ghdr.version = GMON_VERSION;
 354     __write (fd, &ghdr, sizeof (struct gmon_hdr));
 355
 356     /* write PC histogram: */
 357     write_hist (fd);
 358
 359     /* write call-graph: */
 360     write_call_graph (fd);
 361
 362     /* write basic-block execution counts: */
 363     write_bb_counts (fd);
 364
 365     __close (fd);
 366 }
 367
 368
 369 void
 370 __write_profiling (void)
 371 {
 372   int save = _gmonparam.state;
 373   _gmonparam.state = GMON_PROF_OFF;
 374   if (save == GMON_PROF_ON)
 375     write_gmon ();
 376   _gmonparam.state = save;
 377 }
 378 weak_alias (__write_profiling, write_profiling)
 379
 380
 381 void
 382 _mcleanup (void)
 383 {
 384   __moncontrol (0);
 385
 386   if (_gmonparam.state != GMON_PROF_ERROR)
 387     write_gmon ();
 388
 389   /* free the memory. */
 390   if (_gmonparam.tos != NULL)
 391     free (_gmonparam.tos);
 392 }