gmon/sys/gmon_out.h

   1 /* Copyright (C) 1996, 1997 Free Software Foundation, Inc.
   2    This file is part of the GNU C Library.
   3    Contributed by David Mosberger <davidm@cs.arizona.edu>.
   4
   5    The GNU C Library is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU Lesser General Public
   7    License as published by the Free Software Foundation; either
   8    version 2.1 of the License, or (at your option) any later version.
   9
  10    The GNU C Library is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13    Lesser General Public License for more details.
  14
  15    You should have received a copy of the GNU Lesser General Public
  16    License along with the GNU C Library; if not, write to the Free
  17    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  18    02111-1307 USA.  */
  19
  20 /* This file specifies the format of gmon.out files.  It should have
  21    as few external dependencies as possible as it is going to be included
  22    in many different programs.  That is, minimize the number of #include's.
  23
  24    A gmon.out file consists of a header (defined by gmon_hdr) followed by
  25    a sequence of records.  Each record starts with a one-byte tag
  26    identifying the type of records, followed by records specific data. */
  27
  28 #ifndef _SYS_GMON_OUT_H
  29 #define _SYS_GMON_OUT_H 1
  30
  31 #include <features.h>
  32
  33 #define GMON_MAGIC      "gmon"  /* magic cookie */
  34 #define GMON_VERSION    1       /* version number */
  35
  36 /* For profiling shared object we need a new format.  */
  37 #define GMON_SHOBJ_VERSION      0x1ffff
  38
  39 __BEGIN_DECLS
  40
  41 /*
  42  * Raw header as it appears on file (without padding).  This header
  43  * always comes first in gmon.out and is then followed by a series
  44  * records defined below.
  45  */
  46 struct gmon_hdr
  47   {
  48     char cookie[4];
  49     char version[4];
  50     char spare[3 * 4];
  51   };
  52
  53 /* types of records in this file: */
  54 typedef enum
  55   {
  56     GMON_TAG_TIME_HIST = 0,
  57     GMON_TAG_CG_ARC = 1,
  58     GMON_TAG_BB_COUNT = 2
  59   } GMON_Record_Tag;
  60
  61 struct gmon_hist_hdr
  62   {
  63     char low_pc[sizeof (char *)];       /* base pc address of sample buffer */
  64     char high_pc[sizeof (char *)];      /* max pc address of sampled buffer */
  65     char hist_size[4];                  /* size of sample buffer */
  66     char prof_rate[4];                  /* profiling clock rate */
  67     char dimen[15];                     /* phys. dim., usually "seconds" */
  68     char dimen_abbrev;                  /* usually 's' for "seconds" */
  69   };
  70
  71 struct gmon_cg_arc_record
  72   {
  73     char from_pc[sizeof (char *)];      /* address within caller's body */
  74     char self_pc[sizeof (char *)];      /* address within callee's body */
  75     char count[4];                      /* number of arc traversals */
  76   };
  77
  78 __END_DECLS
  79
  80 #endif /* sys/gmon_out.h */