Update version
[official-gcc.git] / gcc / timevar.h
blobe20a26e5293c391c5d611c8dd377b0279e2f1945
1 /* Timing variables for measuring compiler performance.
2 Copyright (C) 2000 Free Software Foundation, Inc.
3 Contributed by Alex Samuel <samuel@codesourcery.com>
5 This file is part of GNU CC.
7 GNU CC is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
10 any later version.
12 GNU CC is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU CC; see the file COPYING. If not, write to
19 the Free Software Foundation, 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
22 #ifndef GCC_TIMEVAR_H
23 #define GCC_TIMEVAR_H
25 /* Timing variables are used to measure elapsed time in various
26 portions of the compiler. Each measures elapsed user, system, and
27 wall-clock time, as appropriate to and supported by the host
28 system.
30 Timing variables are defined using the DEFTIMEVAR macro in
31 timevar.def. Each has an enumeral identifier, used when referring
32 to the timing variable in code, and a character string name.
34 Timing variables can be used in two ways:
36 - On the timing stack, using timevar_push and timevar_pop.
37 Timing variables may be pushed onto the stack; elapsed time is
38 attributed to the topmost timing variable on the stack. When
39 another variable is pushed on, the previous topmost variable is
40 `paused' until the pushed variable is popped back off.
42 - As a standalone timer, using timevar_start and timevar_stop.
43 All time elapsed between the two calls is attributed to the
44 variable.
47 /* This structure stores the various varieties of time that can be
48 measured. Times are stored in microseconds. The time may be an
49 absolute time or a time difference; in the former case, the time
50 base is undefined, except that the difference between two times
51 produces a valid time difference. */
53 struct timevar_time_def
55 /* User time in this process. */
56 long user;
58 /* System time (if applicable for this host platform) in this
59 process. */
60 long sys;
62 /* Wall clock time. */
63 long wall;
66 /* An enumeration of timing variable indentifiers. Constructed from
67 the contents of timevar.def. */
69 #define DEFTIMEVAR(identifier__, name__) \
70 identifier__,
71 typedef enum
73 #include "timevar.def"
74 TIMEVAR_LAST
76 timevar_id_t;
77 #undef DEFTIMEVAR
79 extern void init_timevar PARAMS ((void));
80 extern void timevar_push PARAMS ((timevar_id_t));
81 extern void timevar_pop PARAMS ((timevar_id_t));
82 extern void timevar_start PARAMS ((timevar_id_t));
83 extern void timevar_stop PARAMS ((timevar_id_t));
84 extern void timevar_get PARAMS ((timevar_id_t, struct timevar_time_def *));
85 extern void timevar_print PARAMS ((FILE *));
87 /* Provided for backward compatibility. */
88 extern long get_run_time PARAMS ((void));
89 extern void print_time PARAMS ((const char *, long));
91 #endif