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  * 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 #include <sys/param.h>
  34 #include <sys/time.h>
  35 #include <sys/gmon.h>
  36 #include <sys/gmon_out.h>
  37 #include <sys/uio.h>
  38
  39 #include <stdio.h>
  40 #include <fcntl.h>
  41 #include <unistd.h>
  42
  43 #include <stdio.h>
  44 #include <stdlib.h>
  45 #include <string.h>
  46 #include <unistd.h>
  47
  48 extern int __profile_frequency __P ((void));
  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(2, s, sizeof(s) - 1)
  61
  62 void moncontrol __P ((int mode));
  63 static void write_hist __P ((int fd));
  64 static void write_call_graph __P ((int fd));
  65 static void write_bb_counts __P ((int fd));
  66 static void write_gmon __P ((void));
  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   if (mode)
  80     {
  81       /* start */
  82       profil((void *) p->kcount, p->kcountsize, p->lowpc, s_scale);
  83       p->state = GMON_PROF_ON;
  84     }
  85   else
  86     {
  87       /* stop */
  88       profil((void *) 0, 0, 0, 0);
  89       p->state = GMON_PROF_OFF;
  90     }
  91 }
  92
  93
  94 void
  95 monstartup (lowpc, highpc)
  96      u_long lowpc;
  97      u_long highpc;
  98 {
  99   register int o;
 100   char *cp;
 101   struct gmonparam *p = &_gmonparam;
 102
 103   /*
 104    * round lowpc and highpc to multiples of the density we're using
 105    * so the rest of the scaling (here and in gprof) stays in ints.
 106    */
 107   p->lowpc = ROUNDDOWN(lowpc, HISTFRACTION * sizeof(HISTCOUNTER));
 108   p->highpc = ROUNDUP(highpc, HISTFRACTION * sizeof(HISTCOUNTER));
 109   p->textsize = p->highpc - p->lowpc;
 110   p->kcountsize = p->textsize / HISTFRACTION;
 111   p->hashfraction = HASHFRACTION;
 112   p->log_hashfraction = -1;
 113   if ((HASHFRACTION & (HASHFRACTION - 1)) == 0) {
 114       /* if HASHFRACTION is a power of two, mcount can use shifting
 115          instead of integer division.  Precompute shift amount. */
 116       p->log_hashfraction = ffs(p->hashfraction * sizeof(*p->froms)) - 1;
 117   }
 118   p->fromssize = p->textsize / HASHFRACTION;
 119   p->tolimit = p->textsize * ARCDENSITY / 100;
 120   if (p->tolimit < MINARCS)
 121     p->tolimit = MINARCS;
 122   else if (p->tolimit > MAXARCS)
 123     p->tolimit = MAXARCS;
 124   p->tossize = p->tolimit * sizeof(struct tostruct);
 125
 126   cp = malloc (p->kcountsize + p->fromssize + p->tossize);
 127   if (! cp)
 128     {
 129       ERR("monstartup: out of memory\n");
 130       return;
 131     }
 132   bzero(cp, p->kcountsize + p->fromssize + p->tossize);
 133   p->tos = (struct tostruct *)cp;
 134   cp += p->tossize;
 135   p->kcount = (u_short *)cp;
 136   cp += p->kcountsize;
 137   p->froms = (u_short *)cp;
 138
 139   p->tos[0].link = 0;
 140
 141   o = p->highpc - p->lowpc;
 142   if (p->kcountsize < (u_long) o)
 143     {
 144 #ifndef hp300
 145       s_scale = ((float)p->kcountsize / o ) * SCALE_1_TO_1;
 146 #else
 147       /* avoid floating point operations */
 148       int quot = o / p->kcountsize;
 149
 150       if (quot >= 0x10000)
 151         s_scale = 1;
 152       else if (quot >= 0x100)
 153         s_scale = 0x10000 / quot;
 154       else if (o >= 0x800000)
 155         s_scale = 0x1000000 / (o / (p->kcountsize >> 8));
 156       else
 157         s_scale = 0x1000000 / ((o << 8) / p->kcountsize);
 158 #endif
 159     } else
 160       s_scale = SCALE_1_TO_1;
 161
 162   moncontrol(1);
 163 }
 164
 165
 166 static void
 167 write_hist (fd)
 168      int fd;
 169 {
 170   u_char tag = GMON_TAG_TIME_HIST;
 171   struct gmon_hist_hdr thdr __attribute__ ((aligned (__alignof__ (char *))));
 172
 173   if (_gmonparam.kcountsize > 0)
 174     {
 175       struct iovec iov[3] =
 176         {
 177           { &tag, sizeof (tag) },
 178           { &thdr, sizeof (struct gmon_hist_hdr) },
 179           { _gmonparam.kcount, _gmonparam.kcountsize }
 180         };
 181
 182       *(char **) thdr.low_pc = (char *) _gmonparam.lowpc;
 183       *(char **) thdr.high_pc = (char *) _gmonparam.highpc;
 184       *(int *) thdr.hist_size = _gmonparam.kcountsize / sizeof (HISTCOUNTER);
 185       *(int *) thdr.prof_rate = __profile_frequency ();
 186       strncpy (thdr.dimen, "seconds", sizeof (thdr.dimen));
 187       thdr.dimen_abbrev = 's';
 188
 189       __writev (fd, iov, 3);
 190     }
 191 }
 192
 193
 194 static void
 195 write_call_graph (fd)
 196      int fd;
 197 {
 198   u_char tag = GMON_TAG_CG_ARC;
 199   struct gmon_cg_arc_record raw_arc[4]
 200     __attribute__ ((aligned (__alignof__ (char*))));
 201   int from_index, to_index, from_len;
 202   u_long frompc;
 203
 204   struct iovec iov[8] =
 205     {
 206       { &tag, sizeof (tag) },
 207       { &raw_arc[0], sizeof (struct gmon_cg_arc_record) },
 208       { &tag, sizeof (tag) },
 209       { &raw_arc[1], sizeof (struct gmon_cg_arc_record) },
 210       { &tag, sizeof (tag) },
 211       { &raw_arc[2], sizeof (struct gmon_cg_arc_record) },
 212       { &tag, sizeof (tag) },
 213       { &raw_arc[3], sizeof (struct gmon_cg_arc_record) },
 214     };
 215   int nfilled = 0;
 216
 217   from_len = _gmonparam.fromssize / sizeof (*_gmonparam.froms);
 218   for (from_index = 0; from_index < from_len; ++from_index)
 219     {
 220       if (_gmonparam.froms[from_index] == 0)
 221         continue;
 222
 223       frompc = _gmonparam.lowpc;
 224       frompc += (from_index * _gmonparam.hashfraction
 225                  * sizeof (*_gmonparam.froms));
 226       for (to_index = _gmonparam.froms[from_index];
 227            to_index != 0;
 228            to_index = _gmonparam.tos[to_index].link)
 229         {
 230           if (nfilled > 3)
 231             {
 232               __writev (fd, iov, 2 * nfilled);
 233               nfilled = 0;
 234             }
 235           *(char **) raw_arc[nfilled].from_pc = (char *)frompc;
 236           *(char **) raw_arc[nfilled].self_pc =
 237             (char *)_gmonparam.tos[to_index].selfpc;
 238           *(int *) raw_arc[nfilled].count = _gmonparam.tos[to_index].count;
 239           ++nfilled;
 240         }
 241     }
 242   __writev (fd, iov, 2 * nfilled);
 243 }
 244
 245
 246 static void
 247 write_bb_counts (fd)
 248      int fd;
 249 {
 250   struct __bb *grp;
 251   u_char tag = GMON_TAG_BB_COUNT;
 252   int ncounts;
 253   int i;
 254
 255   struct iovec bbhead[2] =
 256     {
 257       { &tag, sizeof (tag) },
 258       { &ncounts, sizeof (ncounts) }
 259     };
 260   struct iovec bbbody[8];
 261   int nfilled;
 262
 263   for (i = 0; i < (sizeof (bbbody) / sizeof (bbbody[0])); i += 2)
 264     {
 265       bbbody[i].iov_len = sizeof (grp->addresses[0]);
 266       bbbody[i + 1].iov_len = sizeof (grp->counts[0]);
 267     }
 268
 269   /* Write each group of basic-block info (all basic-blocks in a
 270      compilation unit form a single group). */
 271
 272   nfilled = 0;
 273   for (grp = __bb_head; grp; grp = grp->next)
 274     {
 275       ncounts = grp->ncounts;
 276       __writev (fd, bbhead, 2);
 277       for (i = 0; i < ncounts; ++i)
 278         {
 279           if (nfilled > (sizeof (bbbody) / sizeof (bbbody[0])) - 2)
 280             {
 281               __writev (fd, bbbody, nfilled);
 282               nfilled = 0;
 283             }
 284
 285           bbbody[nfilled++].iov_base = (char *) &grp->addresses[i];
 286           bbbody[nfilled++].iov_base = &grp->counts[i];
 287         }
 288       if (nfilled > 0)
 289         __writev (fd, bbbody, nfilled);
 290     }
 291 }
 292
 293
 294 static void
 295 write_gmon ()
 296 {
 297     struct gmon_hdr ghdr __attribute__ ((aligned (__alignof__ (int))));
 298     int fd;
 299
 300     fd = __open ("gmon.out", O_CREAT|O_TRUNC|O_WRONLY, 0666);
 301     if (fd < 0)
 302       {
 303         perror ("_mcleanup: gmon.out");
 304         return;
 305       }
 306
 307     /* write gmon.out header: */
 308     memset (&ghdr, 0, sizeof (struct gmon_hdr));
 309     memcpy (&ghdr.cookie[0], GMON_MAGIC, sizeof (ghdr.cookie));
 310     *(int *) ghdr.version = GMON_VERSION;
 311     __write (fd, &ghdr, sizeof (struct gmon_hdr));
 312
 313     /* write PC histogram: */
 314     write_hist (fd);
 315
 316     /* write call-graph: */
 317     write_call_graph (fd);
 318
 319     /* write basic-block execution counts: */
 320     write_bb_counts (fd);
 321
 322     __close (fd);
 323 }
 324
 325 void
 326 __write_profiling ()
 327 {
 328   int save = _gmonparam.state;
 329   _gmonparam.state = GMON_PROF_OFF;
 330   if (save == GMON_PROF_ON)
 331     write_gmon ();
 332   _gmonparam.state = save;
 333 }
 334 weak_alias (__write_profiling, write_profiling)
 335
 336 void
 337 _mcleanup ()
 338 {
 339     moncontrol (0);
 340
 341     write_gmon ();
 342
 343     /* free the memory. */
 344     free (_gmonparam.tos);
 345 }