c02362ba47fc2856af383124f306c34e7e5c31b9
[kopensolaris-gnu/glibc.git] / gmon / sys / gmon_out.h
1 /* Copyright (C) 1996 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 Library General Public License as
7    published by the Free Software Foundation; either version 2 of the
8    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    Library General Public License for more details.
14
15    You should have received a copy of the GNU Library General Public
16    License along with the GNU C Library; see the file COPYING.LIB.  If not,
17    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18    Boston, MA 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_
30
31 #define GMON_MAGIC      "gmon"  /* magic cookie */
32 #define GMON_VERSION    1       /* version number */
33
34 /*
35  * Raw header as it appears on file (without padding).  This header
36  * always comes first in gmon.out and is then followed by a series
37  * records defined below.
38  */
39 struct gmon_hdr {
40   char cookie[4];
41   int version;
42   int spare[3];
43 };
44
45 /* types of records in this file: */
46 typedef enum {
47   GMON_TAG_TIME_HIST = 0, GMON_TAG_CG_ARC = 1, GMON_TAG_BB_COUNT = 2
48 } GMON_Record_Tag;
49
50 struct gmon_hist_hdr {
51   unsigned long low_pc;                 /* base pc address of sample buffer */
52   unsigned long high_pc;                /* max pc address of sampled buffer */
53   int hist_size;                        /* size of sample buffer */
54   int prof_rate;                        /* profiling clock rate */
55   char dimen[15];                       /* phys. dim., usually "seconds" */
56   char dimen_abbrev;                    /* usually 's' for "seconds" */
57 };
58
59 struct gmon_cg_arc_record {
60   unsigned long from_pc;                /* address within caller's body */
61   unsigned long self_pc;                /* address within callee's body */
62   int count;                            /* number of arc traversals */
63 };
64
65 #endif /* !_SYS_GMON_OUT_H_ */