[thirdparty/gcc.git] / gcc / timevar.c

/* Timing variables for measuring compiler performance.
   Copyright (C) 2000-2014 Free Software Foundation, Inc.
   Contributed by Alex Samuel <samuel@codesourcery.com>

This file is part of GCC.

GCC is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation; either version 3, or (at your option) any later
version.

GCC is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
for more details.

You should have received a copy of the GNU General Public License
along with GCC; see the file COPYING3.  If not see
<http://www.gnu.org/licenses/>.  */

#include "config.h"
#include "system.h"
#include "timevar.h"

#ifndef HAVE_CLOCK_T
typedef int clock_t;
#endif

#ifndef HAVE_STRUCT_TMS
struct tms
{
  clock_t tms_utime;
  clock_t tms_stime;
  clock_t tms_cutime;
  clock_t tms_cstime;
};
#endif

#ifndef RUSAGE_SELF
# define RUSAGE_SELF 0
#endif

/* Calculation of scale factor to convert ticks to microseconds.
   We mustn't use CLOCKS_PER_SEC except with clock().  */
#if HAVE_SYSCONF && defined _SC_CLK_TCK
# define TICKS_PER_SECOND sysconf (_SC_CLK_TCK) /* POSIX 1003.1-1996 */
#else
# ifdef CLK_TCK
#  define TICKS_PER_SECOND CLK_TCK /* POSIX 1003.1-1988; obsolescent */
# else
#  ifdef HZ
#   define TICKS_PER_SECOND HZ  /* traditional UNIX */
#  else
#   define TICKS_PER_SECOND 100 /* often the correct value */
#  endif
# endif
#endif

/* Prefer times to getrusage to clock (each gives successively less
   information).  */
#ifdef HAVE_TIMES
# if defined HAVE_DECL_TIMES && !HAVE_DECL_TIMES
  extern clock_t times (struct tms *);
# endif
# define USE_TIMES
# define HAVE_USER_TIME
# define HAVE_SYS_TIME
# define HAVE_WALL_TIME
#else
#ifdef HAVE_GETRUSAGE
# if defined HAVE_DECL_GETRUSAGE && !HAVE_DECL_GETRUSAGE
  extern int getrusage (int, struct rusage *);
# endif
# define USE_GETRUSAGE
# define HAVE_USER_TIME
# define HAVE_SYS_TIME
#else
#ifdef HAVE_CLOCK
# if defined HAVE_DECL_CLOCK && !HAVE_DECL_CLOCK
  extern clock_t clock (void);
# endif
# define USE_CLOCK
# define HAVE_USER_TIME
#endif
#endif
#endif

/* libc is very likely to have snuck a call to sysconf() into one of
   the underlying constants, and that can be very slow, so we have to
   precompute them.  Whose wonderful idea was it to make all those
   _constants_ variable at run time, anyway?  */
#ifdef USE_TIMES
static double ticks_to_msec;
#define TICKS_TO_MSEC (1 / (double)TICKS_PER_SECOND)
#endif

#ifdef USE_CLOCK
static double clocks_to_msec;
#define CLOCKS_TO_MSEC (1 / (double)CLOCKS_PER_SEC)
#endif

/* True if timevars should be used.  In GCC, this happens with
   the -ftime-report flag.  */

bool timevar_enable;

/* Total amount of memory allocated by garbage collector.  */

size_t timevar_ggc_mem_total;

/* The amount of memory that will cause us to report the timevar even
   if the time spent is not significant.  */

#define GGC_MEM_BOUND (1 << 20)

/* See timevar.h for an explanation of timing variables.  */

/* A timing variable.  */

struct timevar_def
{
  /* Elapsed time for this variable.  */
  struct timevar_time_def elapsed;

  /* If this variable is timed independently of the timing stack,
     using timevar_start, this contains the start time.  */
  struct timevar_time_def start_time;

  /* The name of this timing variable.  */
  const char *name;

  /* Nonzero if this timing variable is running as a standalone
     timer.  */
  unsigned standalone : 1;

  /* Nonzero if this timing variable was ever started or pushed onto
     the timing stack.  */
  unsigned used : 1;
};

/* An element on the timing stack.  Elapsed time is attributed to the
   topmost timing variable on the stack.  */

struct timevar_stack_def
{
  /* The timing variable at this stack level.  */
  struct timevar_def *timevar;

  /* The next lower timing variable context in the stack.  */
  struct timevar_stack_def *next;
};

/* Declared timing variables.  Constructed from the contents of
   timevar.def.  */
static struct timevar_def timevars[TIMEVAR_LAST];

/* The top of the timing stack.  */
static struct timevar_stack_def *stack;

/* A list of unused (i.e. allocated and subsequently popped)
   timevar_stack_def instances.  */
static struct timevar_stack_def *unused_stack_instances;

/* The time at which the topmost element on the timing stack was
   pushed.  Time elapsed since then is attributed to the topmost
   element.  */
static struct timevar_time_def start_time;

static void get_time (struct timevar_time_def *);
static void timevar_accumulate (struct timevar_time_def *,
				struct timevar_time_def *,
				struct timevar_time_def *);

/* Fill the current times into TIME.  The definition of this function
   also defines any or all of the HAVE_USER_TIME, HAVE_SYS_TIME, and
   HAVE_WALL_TIME macros.  */

static void
get_time (struct timevar_time_def *now)
{
  now->user = 0;
  now->sys  = 0;
  now->wall = 0;
  now->ggc_mem = timevar_ggc_mem_total;

  if (!timevar_enable)
    return;

  {
#ifdef USE_TIMES
    struct tms tms;
    now->wall = times (&tms)  * ticks_to_msec;
    now->user = tms.tms_utime * ticks_to_msec;
    now->sys  = tms.tms_stime * ticks_to_msec;
#endif
#ifdef USE_GETRUSAGE
    struct rusage rusage;
    getrusage (RUSAGE_SELF, &rusage);
    now->user = rusage.ru_utime.tv_sec + rusage.ru_utime.tv_usec * 1e-6;
    now->sys  = rusage.ru_stime.tv_sec + rusage.ru_stime.tv_usec * 1e-6;
#endif
#ifdef USE_CLOCK
    now->user = clock () * clocks_to_msec;
#endif
  }
}

/* Add the difference between STOP_TIME and START_TIME to TIMER.  */

static void
timevar_accumulate (struct timevar_time_def *timer,
		    struct timevar_time_def *start_time,
		    struct timevar_time_def *stop_time)
{
  timer->user += stop_time->user - start_time->user;
  timer->sys += stop_time->sys - start_time->sys;
  timer->wall += stop_time->wall - start_time->wall;
  timer->ggc_mem += stop_time->ggc_mem - start_time->ggc_mem;
}

/* Initialize timing variables.  */

void
timevar_init (void)
{
  if (timevar_enable)
    return;

  timevar_enable = true;

  /* Zero all elapsed times.  */
  memset (timevars, 0, sizeof (timevars));

  /* Initialize the names of timing variables.  */
#define DEFTIMEVAR(identifier__, name__) \
  timevars[identifier__].name = name__;
#include "timevar.def"
#undef DEFTIMEVAR

#ifdef USE_TIMES
  ticks_to_msec = TICKS_TO_MSEC;
#endif
#ifdef USE_CLOCK
  clocks_to_msec = CLOCKS_TO_MSEC;
#endif
}

/* Push TIMEVAR onto the timing stack.  No further elapsed time is
   attributed to the previous topmost timing variable on the stack;
   subsequent elapsed time is attributed to TIMEVAR, until it is
   popped or another element is pushed on top.

   TIMEVAR cannot be running as a standalone timer.  */

void
timevar_push_1 (timevar_id_t timevar)
{
  struct timevar_def *tv = &timevars[timevar];
  struct timevar_stack_def *context;
  struct timevar_time_def now;

  /* Mark this timing variable as used.  */
  tv->used = 1;

  /* Can't push a standalone timer.  */
  gcc_assert (!tv->standalone);

  /* What time is it?  */
  get_time (&now);

  /* If the stack isn't empty, attribute the current elapsed time to
     the old topmost element.  */
  if (stack)
    timevar_accumulate (&stack->timevar->elapsed, &start_time, &now);

  /* Reset the start time; from now on, time is attributed to
     TIMEVAR.  */
  start_time = now;

  /* See if we have a previously-allocated stack instance.  If so,
     take it off the list.  If not, malloc a new one.  */
  if (unused_stack_instances != NULL)
    {
      context = unused_stack_instances;
      unused_stack_instances = unused_stack_instances->next;
    }
  else
    context = XNEW (struct timevar_stack_def);

  /* Fill it in and put it on the stack.  */
  context->timevar = tv;
  context->next = stack;
  stack = context;
}

/* Pop the topmost timing variable element off the timing stack.  The
   popped variable must be TIMEVAR.  Elapsed time since the that
   element was pushed on, or since it was last exposed on top of the
   stack when the element above it was popped off, is credited to that
   timing variable.  */

void
timevar_pop_1 (timevar_id_t timevar)
{
  struct timevar_time_def now;
  struct timevar_stack_def *popped = stack;

  gcc_assert (&timevars[timevar] == stack->timevar);

  /* What time is it?  */
  get_time (&now);

  /* Attribute the elapsed time to the element we're popping.  */
  timevar_accumulate (&popped->timevar->elapsed, &start_time, &now);

  /* Reset the start time; from now on, time is attributed to the
     element just exposed on the stack.  */
  start_time = now;

  /* Take the item off the stack.  */
  stack = stack->next;

  /* Don't delete the stack element; instead, add it to the list of
     unused elements for later use.  */
  popped->next = unused_stack_instances;
  unused_stack_instances = popped;
}

/* Start timing TIMEVAR independently of the timing stack.  Elapsed
   time until timevar_stop is called for the same timing variable is
   attributed to TIMEVAR.  */

void
timevar_start (timevar_id_t timevar)
{
  struct timevar_def *tv = &timevars[timevar];

  if (!timevar_enable)
    return;

  /* Mark this timing variable as used.  */
  tv->used = 1;

  /* Don't allow the same timing variable to be started more than
     once.  */
  gcc_assert (!tv->standalone);
  tv->standalone = 1;

  get_time (&tv->start_time);
}

/* Stop timing TIMEVAR.  Time elapsed since timevar_start was called
   is attributed to it.  */

void
timevar_stop (timevar_id_t timevar)
{
  struct timevar_def *tv = &timevars[timevar];
  struct timevar_time_def now;

  if (!timevar_enable)
    return;

  /* TIMEVAR must have been started via timevar_start.  */
  gcc_assert (tv->standalone);
  tv->standalone = 0; /* Enable a restart.  */

  get_time (&now);
  timevar_accumulate (&tv->elapsed, &tv->start_time, &now);
}


/* Conditionally start timing TIMEVAR independently of the timing stack.
   If the timer is already running, leave it running and return true.
   Otherwise, start the timer and return false.
   Elapsed time until the corresponding timevar_cond_stop
   is called for the same timing variable is attributed to TIMEVAR.  */

bool
timevar_cond_start (timevar_id_t timevar)
{
  struct timevar_def *tv = &timevars[timevar];

  if (!timevar_enable)
    return false;

  /* Mark this timing variable as used.  */
  tv->used = 1;

  if (tv->standalone)
    return true;  /* The timevar is already running.  */

  /* Don't allow the same timing variable
     to be unconditionally started more than once.  */
  tv->standalone = 1;

  get_time (&tv->start_time);
  return false;  /* The timevar was not already running.  */
}

/* Conditionally stop timing TIMEVAR.  The RUNNING parameter must come
   from the return value of a dynamically matching timevar_cond_start.
   If the timer had already been RUNNING, do nothing.  Otherwise, time
   elapsed since timevar_cond_start was called is attributed to it.  */

void
timevar_cond_stop (timevar_id_t timevar, bool running)
{
  struct timevar_def *tv;
  struct timevar_time_def now;

  if (!timevar_enable || running)
    return;

  tv = &timevars[timevar];

  /* TIMEVAR must have been started via timevar_cond_start.  */
  gcc_assert (tv->standalone);
  tv->standalone = 0; /* Enable a restart.  */

  get_time (&now);
  timevar_accumulate (&tv->elapsed, &tv->start_time, &now);
}


/* Validate that phase times are consistent.  */

static void
validate_phases (FILE *fp)
{
  unsigned int /* timevar_id_t */ id;
  struct timevar_time_def *total = &timevars[TV_TOTAL].elapsed;
  double phase_user = 0.0;
  double phase_sys = 0.0;
  double phase_wall = 0.0;
  size_t phase_ggc_mem = 0;
  static char phase_prefix[] = "phase ";
  const double tolerance = 1.000001;  /* One part in a million.  */

  for (id = 0; id < (unsigned int) TIMEVAR_LAST; ++id)
    {
      struct timevar_def *tv = &timevars[(timevar_id_t) id];

      /* Don't evaluate timing variables that were never used.  */
      if (!tv->used)
	continue;

      if (strncmp (tv->name, phase_prefix, sizeof phase_prefix - 1) == 0)
	{
	  phase_user += tv->elapsed.user;
	  phase_sys += tv->elapsed.sys;
	  phase_wall += tv->elapsed.wall;
	  phase_ggc_mem += tv->elapsed.ggc_mem;
	}
    }

  if (phase_user > total->user * tolerance
      || phase_sys > total->sys * tolerance
      || phase_wall > total->wall * tolerance
      || phase_ggc_mem > total->ggc_mem * tolerance)
    {

      fprintf (fp, "Timing error: total of phase timers exceeds total time.\n");
      if (phase_user > total->user)
	fprintf (fp, "user    %24.18e > %24.18e\n", phase_user, total->user);
      if (phase_sys > total->sys)
	fprintf (fp, "sys     %24.18e > %24.18e\n", phase_sys, total->sys);
      if (phase_wall > total->wall)
	fprintf (fp, "wall    %24.18e > %24.18e\n", phase_wall, total->wall);
      if (phase_ggc_mem > total->ggc_mem)
	fprintf (fp, "ggc_mem %24lu > %24lu\n", (unsigned long)phase_ggc_mem,
		 (unsigned long)total->ggc_mem);
      gcc_unreachable ();
    }
}


/* Summarize timing variables to FP.  The timing variable TV_TOTAL has
   a special meaning -- it's considered to be the total elapsed time,
   for normalizing the others, and is displayed last.  */

void
timevar_print (FILE *fp)
{
  /* Only print stuff if we have some sort of time information.  */
#if defined (HAVE_USER_TIME) || defined (HAVE_SYS_TIME) || defined (HAVE_WALL_TIME)
  unsigned int /* timevar_id_t */ id;
  struct timevar_time_def *total = &timevars[TV_TOTAL].elapsed;
  struct timevar_time_def now;

  if (!timevar_enable)
    return;

  /* Update timing information in case we're calling this from GDB.  */

  if (fp == 0)
    fp = stderr;

  /* What time is it?  */
  get_time (&now);

  /* If the stack isn't empty, attribute the current elapsed time to
     the old topmost element.  */
  if (stack)
    timevar_accumulate (&stack->timevar->elapsed, &start_time, &now);

  /* Reset the start time; from now on, time is attributed to
     TIMEVAR.  */
  start_time = now;

  fputs ("\nExecution times (seconds)\n", fp);
  for (id = 0; id < (unsigned int) TIMEVAR_LAST; ++id)
    {
      struct timevar_def *tv = &timevars[(timevar_id_t) id];
      const double tiny = 5e-3;

      /* Don't print the total execution time here; that goes at the
	 end.  */
      if ((timevar_id_t) id == TV_TOTAL)
	continue;

      /* Don't print timing variables that were never used.  */
      if (!tv->used)
	continue;

      /* Don't print timing variables if we're going to get a row of
         zeroes.  */
      if (tv->elapsed.user < tiny
	  && tv->elapsed.sys < tiny
	  && tv->elapsed.wall < tiny
	  && tv->elapsed.ggc_mem < GGC_MEM_BOUND)
	continue;

      /* The timing variable name.  */
      fprintf (fp, " %-24s:", tv->name);

#ifdef HAVE_USER_TIME
      /* Print user-mode time for this process.  */
      fprintf (fp, "%7.2f (%2.0f%%) usr",
	       tv->elapsed.user,
	       (total->user == 0 ? 0 : tv->elapsed.user / total->user) * 100);
#endif /* HAVE_USER_TIME */

#ifdef HAVE_SYS_TIME
      /* Print system-mode time for this process.  */
      fprintf (fp, "%7.2f (%2.0f%%) sys",
	       tv->elapsed.sys,
	       (total->sys == 0 ? 0 : tv->elapsed.sys / total->sys) * 100);
#endif /* HAVE_SYS_TIME */

#ifdef HAVE_WALL_TIME
      /* Print wall clock time elapsed.  */
      fprintf (fp, "%7.2f (%2.0f%%) wall",
	       tv->elapsed.wall,
	       (total->wall == 0 ? 0 : tv->elapsed.wall / total->wall) * 100);
#endif /* HAVE_WALL_TIME */

      /* Print the amount of ggc memory allocated.  */
      fprintf (fp, "%8u kB (%2.0f%%) ggc",
	       (unsigned) (tv->elapsed.ggc_mem >> 10),
	       (total->ggc_mem == 0
		? 0
		: (float) tv->elapsed.ggc_mem / total->ggc_mem) * 100);

      putc ('\n', fp);
    }

  /* Print total time.  */
  fputs (" TOTAL                 :", fp);
#ifdef HAVE_USER_TIME
  fprintf (fp, "%7.2f          ", total->user);
#endif
#ifdef HAVE_SYS_TIME
  fprintf (fp, "%7.2f          ", total->sys);
#endif
#ifdef HAVE_WALL_TIME
  fprintf (fp, "%7.2f           ", total->wall);
#endif
  fprintf (fp, "%8u kB\n", (unsigned) (total->ggc_mem >> 10));

#ifdef ENABLE_CHECKING
  fprintf (fp, "Extra diagnostic checks enabled; compiler may run slowly.\n");
  fprintf (fp, "Configure with --enable-checking=release to disable checks.\n");
#endif
#ifndef ENABLE_ASSERT_CHECKING
  fprintf (fp, "Internal checks disabled; compiler is not suited for release.\n");
  fprintf (fp, "Configure with --enable-checking=release to enable checks.\n");
#endif

#endif /* defined (HAVE_USER_TIME) || defined (HAVE_SYS_TIME)
	  || defined (HAVE_WALL_TIME) */

  validate_phases (fp);
}

/* Prints a message to stderr stating that time elapsed in STR is
   TOTAL (given in microseconds).  */

void
print_time (const char *str, long total)
{
  long all_time = get_run_time ();
  fprintf (stderr,
	   "time in %s: %ld.%06ld (%ld%%)\n",
	   str, total / 1000000, total % 1000000,
	   all_time == 0 ? 0
	   : (long) (((100.0 * (double) total) / (double) all_time) + .5));
}
Commit	Line	Data
2a9a326b	1	/* Timing variables for measuring compiler performance.
23a5b65a	2	Copyright (C) 2000-2014 Free Software Foundation, Inc.
2a9a326b AS	3	Contributed by Alex Samuel <samuel@codesourcery.com>
2a9a326b AS	4
5237fc07	5	This file is part of GCC.
2a9a326b	6
5237fc07 RK	7	GCC is free software; you can redistribute it and/or modify it under
5237fc07 RK	8	the terms of the GNU General Public License as published by the Free
9dcd6f09	9	Software Foundation; either version 3, or (at your option) any later
5237fc07	10	version.
2a9a326b	11
5237fc07 RK	12	GCC is distributed in the hope that it will be useful, but WITHOUT ANY
	13	WARRANTY; without even the implied warranty of MERCHANTABILITY or
	14	FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
	15	for more details.
2a9a326b	16
5237fc07	17	You should have received a copy of the GNU General Public License
9dcd6f09 NC	18	along with GCC; see the file COPYING3. If not see
9dcd6f09 NC	19	<http://www.gnu.org/licenses/>. */
2a9a326b AS	20
	21	#include "config.h"
	22	#include "system.h"
613b1547	23	#include "timevar.h"
dd1b7476	24
c1800ec8 ZW	25	#ifndef HAVE_CLOCK_T
	26	typedef int clock_t;
	27	#endif
	28
	29	#ifndef HAVE_STRUCT_TMS
	30	struct tms
	31	{
	32	clock_t tms_utime;
	33	clock_t tms_stime;
	34	clock_t tms_cutime;
	35	clock_t tms_cstime;
	36	};
	37	#endif
	38
c1800ec8 ZW	39	#ifndef RUSAGE_SELF
	40	# define RUSAGE_SELF 0
	41	#endif
	42
	43	/* Calculation of scale factor to convert ticks to microseconds.
	44	We mustn't use CLOCKS_PER_SEC except with clock(). */
	45	#if HAVE_SYSCONF && defined _SC_CLK_TCK
	46	# define TICKS_PER_SECOND sysconf (_SC_CLK_TCK) /* POSIX 1003.1-1996 */
	47	#else
	48	# ifdef CLK_TCK
	49	# define TICKS_PER_SECOND CLK_TCK /* POSIX 1003.1-1988; obsolescent */
	50	# else
	51	# ifdef HZ
	52	# define TICKS_PER_SECOND HZ /* traditional UNIX */
	53	# else
	54	# define TICKS_PER_SECOND 100 /* often the correct value */
	55	# endif
	56	# endif
	57	#endif
	58
c1800ec8 ZW	59	/* Prefer times to getrusage to clock (each gives successively less
	60	information). */
	61	#ifdef HAVE_TIMES
8f9a402c	62	# if defined HAVE_DECL_TIMES && !HAVE_DECL_TIMES
46c5ad27	63	extern clock_t times (struct tms *);
8f9a402c	64	# endif
c1800ec8 ZW	65	# define USE_TIMES
	66	# define HAVE_USER_TIME
	67	# define HAVE_SYS_TIME
	68	# define HAVE_WALL_TIME
	69	#else
	70	#ifdef HAVE_GETRUSAGE
8f9a402c	71	# if defined HAVE_DECL_GETRUSAGE && !HAVE_DECL_GETRUSAGE
f55ade6e	72	extern int getrusage (int, struct rusage *);
8f9a402c	73	# endif
c1800ec8 ZW	74	# define USE_GETRUSAGE
	75	# define HAVE_USER_TIME
	76	# define HAVE_SYS_TIME
	77	#else
	78	#ifdef HAVE_CLOCK
8f9a402c	79	# if defined HAVE_DECL_CLOCK && !HAVE_DECL_CLOCK
f55ade6e	80	extern clock_t clock (void);
8f9a402c	81	# endif
c1800ec8 ZW	82	# define USE_CLOCK
	83	# define HAVE_USER_TIME
	84	#endif
	85	#endif
	86	#endif
f9721d41	87
d9b6874b ZW	88	/* libc is very likely to have snuck a call to sysconf() into one of
	89	the underlying constants, and that can be very slow, so we have to
	90	precompute them. Whose wonderful idea was it to make all those
	91	_constants_ variable at run time, anyway? */
	92	#ifdef USE_TIMES
4977bab6 ZW	93	static double ticks_to_msec;
4977bab6 ZW	94	#define TICKS_TO_MSEC (1 / (double)TICKS_PER_SECOND)
d9b6874b ZW	95	#endif
	96
	97	#ifdef USE_CLOCK
4977bab6 ZW	98	static double clocks_to_msec;
4977bab6 ZW	99	#define CLOCKS_TO_MSEC (1 / (double)CLOCKS_PER_SEC)
d9b6874b ZW	100	#endif
d9b6874b ZW	101
613b1547 SB	102	/* True if timevars should be used. In GCC, this happens with
613b1547 SB	103	the -ftime-report flag. */
2a9a326b	104
89106ed5	105	bool timevar_enable;
2a9a326b	106
8d18c628 ZD	107	/* Total amount of memory allocated by garbage collector. */
	108
	109	size_t timevar_ggc_mem_total;
	110
	111	/* The amount of memory that will cause us to report the timevar even
	112	if the time spent is not significant. */
	113
	114	#define GGC_MEM_BOUND (1 << 20)
	115
09b04f2d	116	/* See timevar.h for an explanation of timing variables. */
26026d38	117
2a9a326b AS	118	/* A timing variable. */
	119
	120	struct timevar_def
	121	{
	122	/* Elapsed time for this variable. */
	123	struct timevar_time_def elapsed;
	124
	125	/* If this variable is timed independently of the timing stack,
	126	using timevar_start, this contains the start time. */
	127	struct timevar_time_def start_time;
	128
26026d38 AS	129	/* The name of this timing variable. */
	130	const char *name;
	131
272d0bee	132	/* Nonzero if this timing variable is running as a standalone
2a9a326b	133	timer. */
26026d38	134	unsigned standalone : 1;
2a9a326b	135
272d0bee	136	/* Nonzero if this timing variable was ever started or pushed onto
26026d38 AS	137	the timing stack. */
26026d38 AS	138	unsigned used : 1;
2a9a326b AS	139	};
	140
	141	/* An element on the timing stack. Elapsed time is attributed to the
	142	topmost timing variable on the stack. */
	143
	144	struct timevar_stack_def
	145	{
	146	/* The timing variable at this stack level. */
	147	struct timevar_def *timevar;
	148
	149	/* The next lower timing variable context in the stack. */
	150	struct timevar_stack_def *next;
	151	};
	152
	153	/* Declared timing variables. Constructed from the contents of
	154	timevar.def. */
	155	static struct timevar_def timevars[TIMEVAR_LAST];
	156
	157	/* The top of the timing stack. */
	158	static struct timevar_stack_def *stack;
	159
26026d38 AS	160	/* A list of unused (i.e. allocated and subsequently popped)
	161	timevar_stack_def instances. */
	162	static struct timevar_stack_def *unused_stack_instances;
	163
2a9a326b AS	164	/* The time at which the topmost element on the timing stack was
	165	pushed. Time elapsed since then is attributed to the topmost
	166	element. */
	167	static struct timevar_time_def start_time;
	168
46c5ad27 AJ	169	static void get_time (struct timevar_time_def *);
	170	static void timevar_accumulate (struct timevar_time_def *,
	171	struct timevar_time_def *,
	172	struct timevar_time_def *);
2a9a326b AS	173
	174	/* Fill the current times into TIME. The definition of this function
	175	also defines any or all of the HAVE_USER_TIME, HAVE_SYS_TIME, and
83a3aefb	176	HAVE_WALL_TIME macros. */
2a9a326b AS	177
2a9a326b AS	178	static void
46c5ad27	179	get_time (struct timevar_time_def *now)
2a9a326b	180	{
26026d38 AS	181	now->user = 0;
	182	now->sys = 0;
	183	now->wall = 0;
8d18c628	184	now->ggc_mem = timevar_ggc_mem_total;
26026d38	185
09b04f2d	186	if (!timevar_enable)
26026d38	187	return;
2a9a326b	188
2a9a326b	189	{
c1800ec8	190	#ifdef USE_TIMES
2a9a326b	191	struct tms tms;
d9b6874b ZW	192	now->wall = times (&tms) * ticks_to_msec;
	193	now->user = tms.tms_utime * ticks_to_msec;
	194	now->sys = tms.tms_stime * ticks_to_msec;
c1800ec8 ZW	195	#endif
c1800ec8 ZW	196	#ifdef USE_GETRUSAGE
2a9a326b	197	struct rusage rusage;
c1800ec8	198	getrusage (RUSAGE_SELF, &rusage);
20cc76d5 RH	199	now->user = rusage.ru_utime.tv_sec + rusage.ru_utime.tv_usec * 1e-6;
20cc76d5 RH	200	now->sys = rusage.ru_stime.tv_sec + rusage.ru_stime.tv_usec * 1e-6;
c1800ec8 ZW	201	#endif
c1800ec8 ZW	202	#ifdef USE_CLOCK
d9b6874b	203	now->user = clock () * clocks_to_msec;
c1800ec8	204	#endif
2a9a326b	205	}
c1800ec8	206	}
2a9a326b	207
2a9a326b AS	208	/* Add the difference between STOP_TIME and START_TIME to TIMER. */
2a9a326b AS	209
d92b4486	210	static void
46c5ad27 AJ	211	timevar_accumulate (struct timevar_time_def *timer,
	212	struct timevar_time_def *start_time,
	213	struct timevar_time_def *stop_time)
2a9a326b AS	214	{
	215	timer->user += stop_time->user - start_time->user;
	216	timer->sys += stop_time->sys - start_time->sys;
	217	timer->wall += stop_time->wall - start_time->wall;
8d18c628	218	timer->ggc_mem += stop_time->ggc_mem - start_time->ggc_mem;
2a9a326b AS	219	}
	220
	221	/* Initialize timing variables. */
	222
	223	void
46c5ad27	224	timevar_init (void)
2a9a326b	225	{
3edf64aa DM	226	if (timevar_enable)
	227	return;
	228
09b04f2d	229	timevar_enable = true;
26026d38	230
2a9a326b	231	/* Zero all elapsed times. */
703ad42b	232	memset (timevars, 0, sizeof (timevars));
2a9a326b AS	233
2a9a326b AS	234	/* Initialize the names of timing variables. */
affd4f33 JM	235	#define DEFTIMEVAR(identifier__, name__) \
affd4f33 JM	236	timevars[identifier__].name = name__;
2a9a326b AS	237	#include "timevar.def"
2a9a326b AS	238	#undef DEFTIMEVAR
d9b6874b ZW	239
	240	#ifdef USE_TIMES
	241	ticks_to_msec = TICKS_TO_MSEC;
	242	#endif
	243	#ifdef USE_CLOCK
	244	clocks_to_msec = CLOCKS_TO_MSEC;
	245	#endif
2a9a326b AS	246	}
	247
	248	/* Push TIMEVAR onto the timing stack. No further elapsed time is
	249	attributed to the previous topmost timing variable on the stack;
	250	subsequent elapsed time is attributed to TIMEVAR, until it is
d92b4486	251	popped or another element is pushed on top.
2a9a326b AS	252
	253	TIMEVAR cannot be running as a standalone timer. */
	254
	255	void
89106ed5	256	timevar_push_1 (timevar_id_t timevar)
2a9a326b AS	257	{
	258	struct timevar_def *tv = &timevars[timevar];
	259	struct timevar_stack_def *context;
	260	struct timevar_time_def now;
	261
26026d38 AS	262	/* Mark this timing variable as used. */
	263	tv->used = 1;
	264
2a9a326b	265	/* Can't push a standalone timer. */
1e128c5f	266	gcc_assert (!tv->standalone);
2a9a326b AS	267
	268	/* What time is it? */
	269	get_time (&now);
	270
	271	/* If the stack isn't empty, attribute the current elapsed time to
	272	the old topmost element. */
	273	if (stack)
	274	timevar_accumulate (&stack->timevar->elapsed, &start_time, &now);
	275
	276	/* Reset the start time; from now on, time is attributed to
2d76cb1a	277	TIMEVAR. */
2a9a326b AS	278	start_time = now;
2a9a326b AS	279
26026d38 AS	280	/* See if we have a previously-allocated stack instance. If so,
26026d38 AS	281	take it off the list. If not, malloc a new one. */
d92b4486	282	if (unused_stack_instances != NULL)
26026d38 AS	283	{
	284	context = unused_stack_instances;
	285	unused_stack_instances = unused_stack_instances->next;
	286	}
	287	else
5ed6ace5	288	context = XNEW (struct timevar_stack_def);
26026d38 AS	289
26026d38 AS	290	/* Fill it in and put it on the stack. */
2a9a326b AS	291	context->timevar = tv;
	292	context->next = stack;
	293	stack = context;
	294	}
	295
	296	/* Pop the topmost timing variable element off the timing stack. The
	297	popped variable must be TIMEVAR. Elapsed time since the that
	298	element was pushed on, or since it was last exposed on top of the
	299	stack when the element above it was popped off, is credited to that
	300	timing variable. */
	301
	302	void
89106ed5	303	timevar_pop_1 (timevar_id_t timevar)
2a9a326b AS	304	{
2a9a326b AS	305	struct timevar_time_def now;
26026d38 AS	306	struct timevar_stack_def *popped = stack;
26026d38 AS	307
1e128c5f	308	gcc_assert (&timevars[timevar] == stack->timevar);
b8698a0f	309
2a9a326b AS	310	/* What time is it? */
	311	get_time (&now);
	312
	313	/* Attribute the elapsed time to the element we're popping. */
26026d38	314	timevar_accumulate (&popped->timevar->elapsed, &start_time, &now);
2a9a326b AS	315
	316	/* Reset the start time; from now on, time is attributed to the
	317	element just exposed on the stack. */
	318	start_time = now;
	319
26026d38 AS	320	/* Take the item off the stack. */
	321	stack = stack->next;
	322
	323	/* Don't delete the stack element; instead, add it to the list of
	324	unused elements for later use. */
	325	popped->next = unused_stack_instances;
	326	unused_stack_instances = popped;
2a9a326b AS	327	}
	328
	329	/* Start timing TIMEVAR independently of the timing stack. Elapsed
	330	time until timevar_stop is called for the same timing variable is
	331	attributed to TIMEVAR. */
	332
	333	void
46c5ad27	334	timevar_start (timevar_id_t timevar)
2a9a326b AS	335	{
	336	struct timevar_def *tv = &timevars[timevar];
	337
09b04f2d	338	if (!timevar_enable)
26026d38 AS	339	return;
	340
	341	/* Mark this timing variable as used. */
	342	tv->used = 1;
	343
2a9a326b AS	344	/* Don't allow the same timing variable to be started more than
2a9a326b AS	345	once. */
1e128c5f	346	gcc_assert (!tv->standalone);
2a9a326b AS	347	tv->standalone = 1;
	348
	349	get_time (&tv->start_time);
	350	}
	351
	352	/* Stop timing TIMEVAR. Time elapsed since timevar_start was called
	353	is attributed to it. */
	354
	355	void
46c5ad27	356	timevar_stop (timevar_id_t timevar)
2a9a326b AS	357	{
	358	struct timevar_def *tv = &timevars[timevar];
	359	struct timevar_time_def now;
	360
09b04f2d	361	if (!timevar_enable)
26026d38 AS	362	return;
26026d38 AS	363
2a9a326b	364	/* TIMEVAR must have been started via timevar_start. */
1e128c5f	365	gcc_assert (tv->standalone);
575bfb00	366	tv->standalone = 0; /* Enable a restart. */
2a9a326b AS	367
	368	get_time (&now);
	369	timevar_accumulate (&tv->elapsed, &tv->start_time, &now);
	370	}
	371
575bfb00 LC	372
	373	/* Conditionally start timing TIMEVAR independently of the timing stack.
	374	If the timer is already running, leave it running and return true.
	375	Otherwise, start the timer and return false.
	376	Elapsed time until the corresponding timevar_cond_stop
	377	is called for the same timing variable is attributed to TIMEVAR. */
	378
	379	bool
	380	timevar_cond_start (timevar_id_t timevar)
	381	{
	382	struct timevar_def *tv = &timevars[timevar];
	383
	384	if (!timevar_enable)
	385	return false;
	386
	387	/* Mark this timing variable as used. */
	388	tv->used = 1;
	389
	390	if (tv->standalone)
	391	return true; /* The timevar is already running. */
	392
	393	/* Don't allow the same timing variable
	394	to be unconditionally started more than once. */
	395	tv->standalone = 1;
	396
	397	get_time (&tv->start_time);
	398	return false; /* The timevar was not already running. */
	399	}
	400
	401	/* Conditionally stop timing TIMEVAR. The RUNNING parameter must come
	402	from the return value of a dynamically matching timevar_cond_start.
	403	If the timer had already been RUNNING, do nothing. Otherwise, time
	404	elapsed since timevar_cond_start was called is attributed to it. */
	405
	406	void
	407	timevar_cond_stop (timevar_id_t timevar, bool running)
	408	{
	409	struct timevar_def *tv;
	410	struct timevar_time_def now;
	411
	412	if (!timevar_enable \|\| running)
	413	return;
	414
	415	tv = &timevars[timevar];
	416
	417	/* TIMEVAR must have been started via timevar_cond_start. */
	418	gcc_assert (tv->standalone);
	419	tv->standalone = 0; /* Enable a restart. */
	420
	421	get_time (&now);
	422	timevar_accumulate (&tv->elapsed, &tv->start_time, &now);
	423	}
	424
	425
a910399d LC	426	/* Validate that phase times are consistent. */
	427
	428	static void
	429	validate_phases (FILE *fp)
	430	{
	431	unsigned int /* timevar_id_t */ id;
	432	struct timevar_time_def *total = &timevars[TV_TOTAL].elapsed;
	433	double phase_user = 0.0;
	434	double phase_sys = 0.0;
	435	double phase_wall = 0.0;
5e302bca	436	size_t phase_ggc_mem = 0;
a910399d LC	437	static char phase_prefix[] = "phase ";
	438	const double tolerance = 1.000001; /* One part in a million. */
	439
	440	for (id = 0; id < (unsigned int) TIMEVAR_LAST; ++id)
	441	{
	442	struct timevar_def *tv = &timevars[(timevar_id_t) id];
	443
	444	/* Don't evaluate timing variables that were never used. */
	445	if (!tv->used)
	446	continue;
	447
	448	if (strncmp (tv->name, phase_prefix, sizeof phase_prefix - 1) == 0)
	449	{
	450	phase_user += tv->elapsed.user;
	451	phase_sys += tv->elapsed.sys;
	452	phase_wall += tv->elapsed.wall;
	453	phase_ggc_mem += tv->elapsed.ggc_mem;
	454	}
	455	}
	456
	457	if (phase_user > total->user * tolerance
	458	\|\| phase_sys > total->sys * tolerance
	459	\|\| phase_wall > total->wall * tolerance
	460	\|\| phase_ggc_mem > total->ggc_mem * tolerance)
	461	{
	462
	463	fprintf (fp, "Timing error: total of phase timers exceeds total time.\n");
	464	if (phase_user > total->user)
	465	fprintf (fp, "user %24.18e > %24.18e\n", phase_user, total->user);
	466	if (phase_sys > total->sys)
	467	fprintf (fp, "sys %24.18e > %24.18e\n", phase_sys, total->sys);
	468	if (phase_wall > total->wall)
	469	fprintf (fp, "wall %24.18e > %24.18e\n", phase_wall, total->wall);
	470	if (phase_ggc_mem > total->ggc_mem)
4c495b0d JH	471	fprintf (fp, "ggc_mem %24lu > %24lu\n", (unsigned long)phase_ggc_mem,
4c495b0d JH	472	(unsigned long)total->ggc_mem);
a910399d LC	473	gcc_unreachable ();
	474	}
	475	}
	476
	477
2a9a326b AS	478	/* Summarize timing variables to FP. The timing variable TV_TOTAL has
	479	a special meaning -- it's considered to be the total elapsed time,
	480	for normalizing the others, and is displayed last. */
	481
	482	void
46c5ad27	483	timevar_print (FILE *fp)
2a9a326b AS	484	{
	485	/* Only print stuff if we have some sort of time information. */
	486	#if defined (HAVE_USER_TIME) \|\| defined (HAVE_SYS_TIME) \|\| defined (HAVE_WALL_TIME)
dbbbbf3b	487	unsigned int /* timevar_id_t */ id;
2a9a326b	488	struct timevar_time_def *total = &timevars[TV_TOTAL].elapsed;
ea11ca7e	489	struct timevar_time_def now;
2a9a326b	490
09b04f2d	491	if (!timevar_enable)
26026d38 AS	492	return;
26026d38 AS	493
ea11ca7e JM	494	/* Update timing information in case we're calling this from GDB. */
	495
	496	if (fp == 0)
	497	fp = stderr;
	498
	499	/* What time is it? */
	500	get_time (&now);
	501
	502	/* If the stack isn't empty, attribute the current elapsed time to
	503	the old topmost element. */
	504	if (stack)
	505	timevar_accumulate (&stack->timevar->elapsed, &start_time, &now);
	506
	507	/* Reset the start time; from now on, time is attributed to
2d76cb1a	508	TIMEVAR. */
ea11ca7e JM	509	start_time = now;
ea11ca7e JM	510
613b1547	511	fputs ("\nExecution times (seconds)\n", fp);
dbbbbf3b	512	for (id = 0; id < (unsigned int) TIMEVAR_LAST; ++id)
2a9a326b	513	{
dbbbbf3b	514	struct timevar_def *tv = &timevars[(timevar_id_t) id];
4977bab6	515	const double tiny = 5e-3;
2a9a326b AS	516
	517	/* Don't print the total execution time here; that goes at the
	518	end. */
dbbbbf3b	519	if ((timevar_id_t) id == TV_TOTAL)
2a9a326b AS	520	continue;
2a9a326b AS	521
26026d38 AS	522	/* Don't print timing variables that were never used. */
	523	if (!tv->used)
	524	continue;
	525
d9b6874b ZW	526	/* Don't print timing variables if we're going to get a row of
d9b6874b ZW	527	zeroes. */
20cc76d5 RH	528	if (tv->elapsed.user < tiny
20cc76d5 RH	529	&& tv->elapsed.sys < tiny
8d18c628 ZD	530	&& tv->elapsed.wall < tiny
8d18c628 ZD	531	&& tv->elapsed.ggc_mem < GGC_MEM_BOUND)
d9b6874b ZW	532	continue;
d9b6874b ZW	533
2a9a326b	534	/* The timing variable name. */
53461199	535	fprintf (fp, " %-24s:", tv->name);
2a9a326b AS	536
	537	#ifdef HAVE_USER_TIME
	538	/* Print user-mode time for this process. */
d92b4486	539	fprintf (fp, "%7.2f (%2.0f%%) usr",
20cc76d5 RH	540	tv->elapsed.user,
20cc76d5 RH	541	(total->user == 0 ? 0 : tv->elapsed.user / total->user) * 100);
2a9a326b AS	542	#endif /* HAVE_USER_TIME */
	543
	544	#ifdef HAVE_SYS_TIME
	545	/* Print system-mode time for this process. */
d92b4486	546	fprintf (fp, "%7.2f (%2.0f%%) sys",
20cc76d5 RH	547	tv->elapsed.sys,
20cc76d5 RH	548	(total->sys == 0 ? 0 : tv->elapsed.sys / total->sys) * 100);
2a9a326b AS	549	#endif /* HAVE_SYS_TIME */
	550
	551	#ifdef HAVE_WALL_TIME
	552	/* Print wall clock time elapsed. */
d92b4486	553	fprintf (fp, "%7.2f (%2.0f%%) wall",
20cc76d5 RH	554	tv->elapsed.wall,
20cc76d5 RH	555	(total->wall == 0 ? 0 : tv->elapsed.wall / total->wall) * 100);
2a9a326b AS	556	#endif /* HAVE_WALL_TIME */
2a9a326b AS	557
8d18c628 ZD	558	/* Print the amount of ggc memory allocated. */
	559	fprintf (fp, "%8u kB (%2.0f%%) ggc",
	560	(unsigned) (tv->elapsed.ggc_mem >> 10),
	561	(total->ggc_mem == 0
	562	? 0
	563	: (float) tv->elapsed.ggc_mem / total->ggc_mem) * 100);
	564
d9b6874b	565	putc ('\n', fp);
2a9a326b AS	566	}
	567
	568	/* Print total time. */
613b1547	569	fputs (" TOTAL :", fp);
2a9a326b	570	#ifdef HAVE_USER_TIME
20cc76d5	571	fprintf (fp, "%7.2f ", total->user);
d92b4486	572	#endif
2a9a326b	573	#ifdef HAVE_SYS_TIME
20cc76d5	574	fprintf (fp, "%7.2f ", total->sys);
2a9a326b AS	575	#endif
2a9a326b AS	576	#ifdef HAVE_WALL_TIME
8d18c628	577	fprintf (fp, "%7.2f ", total->wall);
2a9a326b	578	#endif
8d18c628	579	fprintf (fp, "%8u kB\n", (unsigned) (total->ggc_mem >> 10));
d92b4486	580
75e853f2 DB	581	#ifdef ENABLE_CHECKING
75e853f2 DB	582	fprintf (fp, "Extra diagnostic checks enabled; compiler may run slowly.\n");
7be97ac7 AP	583	fprintf (fp, "Configure with --enable-checking=release to disable checks.\n");
7be97ac7 AP	584	#endif
982533a5 EB	585	#ifndef ENABLE_ASSERT_CHECKING
	586	fprintf (fp, "Internal checks disabled; compiler is not suited for release.\n");
	587	fprintf (fp, "Configure with --enable-checking=release to enable checks.\n");
75e853f2 DB	588	#endif
75e853f2 DB	589
d92b4486	590	#endif /* defined (HAVE_USER_TIME) \|\| defined (HAVE_SYS_TIME)
2a9a326b	591	\|\| defined (HAVE_WALL_TIME) */
a910399d LC	592
a910399d LC	593	validate_phases (fp);
2a9a326b AS	594	}
2a9a326b AS	595
2a9a326b AS	596	/* Prints a message to stderr stating that time elapsed in STR is
	597	TOTAL (given in microseconds). */
	598
	599	void
46c5ad27	600	print_time (const char *str, long total)
2a9a326b AS	601	{
	602	long all_time = get_run_time ();
	603	fprintf (stderr,
613b1547	604	"time in %s: %ld.%06ld (%ld%%)\n",
2a9a326b	605	str, total / 1000000, total % 1000000,
d92b4486 KH	606	all_time == 0 ? 0
d92b4486 KH	607	: (long) (((100.0 * (double) total) / (double) all_time) + .5));
2a9a326b	608	}