1 /* Timing variables for measuring compiler performance.
2 Copyright (C) 2000-2023 Free Software Foundation, Inc.
3 Contributed by Alex Samuel <samuel@codesourcery.com>
5 This file is part of GCC.
7 GCC is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 3, or (at your option) any later
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
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING3. If not see
19 <http://www.gnu.org/licenses/>. */
23 #include "coretypes.h"
31 #ifndef HAVE_STRUCT_TMS
42 # define RUSAGE_SELF 0
45 /* Calculation of scale factor to convert ticks to microseconds.
46 We mustn't use CLOCKS_PER_SEC except with clock(). */
47 #if HAVE_SYSCONF && defined _SC_CLK_TCK
48 # define TICKS_PER_SECOND sysconf (_SC_CLK_TCK) /* POSIX 1003.1-1996 */
51 # define TICKS_PER_SECOND CLK_TCK /* POSIX 1003.1-1988; obsolescent */
54 # define TICKS_PER_SECOND HZ /* traditional UNIX */
56 # define TICKS_PER_SECOND 100 /* often the correct value */
61 /* Prefer times to getrusage to clock (each gives successively less
64 # if defined HAVE_DECL_TIMES && !HAVE_DECL_TIMES
65 extern clock_t times (struct tms
*);
68 # define HAVE_USER_TIME
69 # define HAVE_SYS_TIME
70 # define HAVE_WALL_TIME
73 # if defined HAVE_DECL_GETRUSAGE && !HAVE_DECL_GETRUSAGE
74 extern int getrusage (int, struct rusage
*);
76 # define USE_GETRUSAGE
77 # define HAVE_USER_TIME
78 # define HAVE_SYS_TIME
81 # if defined HAVE_DECL_CLOCK && !HAVE_DECL_CLOCK
82 extern clock_t clock (void);
85 # define HAVE_USER_TIME
90 /* libc is very likely to have snuck a call to sysconf() into one of
91 the underlying constants, and that can be very slow, so we have to
92 precompute them. Whose wonderful idea was it to make all those
93 _constants_ variable at run time, anyway? */
95 static double ticks_to_msec
;
96 #define TICKS_TO_MSEC (1 / (double)TICKS_PER_SECOND)
100 static double clocks_to_msec
;
101 #define CLOCKS_TO_MSEC (1 / (double)CLOCKS_PER_SEC)
104 /* Non-NULL if timevars should be used. In GCC, this happens with
105 the -ftime-report flag. */
109 /* Total amount of memory allocated by garbage collector. */
111 size_t timevar_ggc_mem_total
;
113 /* The amount of memory that will cause us to report the timevar even
114 if the time spent is not significant. */
116 #define GGC_MEM_BOUND (1 << 20)
118 /* See timevar.h for an explanation of timing variables. */
120 static void get_time (struct timevar_time_def
*);
121 static void timevar_accumulate (struct timevar_time_def
*,
122 struct timevar_time_def
*,
123 struct timevar_time_def
*);
125 /* The implementation of timing events for jit client code, allowing
126 arbitrary named items to appear on the timing stack. */
128 class timer::named_items
131 named_items (timer
*t
);
134 void push (const char *item_name
);
136 void print (FILE *fp
, const timevar_time_def
*total
);
139 /* Which timer instance does this relate to? */
142 /* Dictionary, mapping from item names to timevar_def.
143 Note that currently we merely store/compare the raw string
144 pointers provided by client code; we don't take a copy,
146 hash_map
<const char *, timer::timevar_def
> m_hash_map
;
148 /* The order in which items were originally inserted. */
149 auto_vec
<const char *> m_names
;
152 /* The constructor for class timer::named_items. */
154 timer::named_items::named_items (timer
*t
)
161 /* The destructor for class timer::named_items. */
163 timer::named_items::~named_items ()
167 /* Push the named item onto the timer stack. */
170 timer::named_items::push (const char *item_name
)
172 gcc_assert (item_name
);
175 timer::timevar_def
*def
= &m_hash_map
.get_or_insert (item_name
, &existed
);
178 def
->elapsed
.user
= 0;
179 def
->elapsed
.sys
= 0;
180 def
->elapsed
.wall
= 0;
181 def
->name
= item_name
;
183 m_names
.safe_push (item_name
);
185 m_timer
->push_internal (def
);
188 /* Pop the top item from the timer stack. */
191 timer::named_items::pop ()
193 m_timer
->pop_internal ();
196 /* Print the given client item. Helper function for timer::print. */
199 timer::named_items::print (FILE *fp
, const timevar_time_def
*total
)
201 fprintf (fp
, "Client items:\n");
202 for (const char *item_name
: m_names
)
204 timer::timevar_def
*def
= m_hash_map
.get (item_name
);
206 m_timer
->print_row (fp
, total
, def
->name
, def
->elapsed
);
210 /* Fill the current times into TIME. The definition of this function
211 also defines any or all of the HAVE_USER_TIME, HAVE_SYS_TIME, and
212 HAVE_WALL_TIME macros. */
215 get_time (struct timevar_time_def
*now
)
220 now
->ggc_mem
= timevar_ggc_mem_total
;
225 now
->wall
= times (&tms
) * ticks_to_msec
;
226 now
->user
= tms
.tms_utime
* ticks_to_msec
;
227 now
->sys
= tms
.tms_stime
* ticks_to_msec
;
230 struct rusage rusage
;
231 getrusage (RUSAGE_SELF
, &rusage
);
232 now
->user
= rusage
.ru_utime
.tv_sec
+ rusage
.ru_utime
.tv_usec
* 1e-6;
233 now
->sys
= rusage
.ru_stime
.tv_sec
+ rusage
.ru_stime
.tv_usec
* 1e-6;
236 now
->user
= clock () * clocks_to_msec
;
241 /* Add the difference between STOP_TIME and START_TIME to TIMER. */
244 timevar_accumulate (struct timevar_time_def
*timer
,
245 struct timevar_time_def
*start_time
,
246 struct timevar_time_def
*stop_time
)
248 timer
->user
+= stop_time
->user
- start_time
->user
;
249 timer
->sys
+= stop_time
->sys
- start_time
->sys
;
250 timer
->wall
+= stop_time
->wall
- start_time
->wall
;
251 timer
->ggc_mem
+= stop_time
->ggc_mem
- start_time
->ggc_mem
;
254 /* Class timer's constructor. */
258 m_unused_stack_instances (NULL
),
260 m_jit_client_items (NULL
)
262 /* Zero all elapsed times. */
263 memset (m_timevars
, 0, sizeof (m_timevars
));
265 /* Initialize the names of timing variables. */
266 #define DEFTIMEVAR(identifier__, name__) \
267 m_timevars[identifier__].name = name__;
268 #include "timevar.def"
271 /* Initialize configuration-specific state.
272 Ideally this would be one-time initialization. */
274 ticks_to_msec
= TICKS_TO_MSEC
;
277 clocks_to_msec
= CLOCKS_TO_MSEC
;
281 /* Class timer's destructor. */
285 timevar_stack_def
*iter
, *next
;
287 for (iter
= m_stack
; iter
; iter
= next
)
292 for (iter
= m_unused_stack_instances
; iter
; iter
= next
)
297 for (unsigned i
= 0; i
< TIMEVAR_LAST
; ++i
)
298 delete m_timevars
[i
].children
;
300 delete m_jit_client_items
;
303 /* Initialize timing variables. */
311 g_timer
= new timer ();
314 /* Push TIMEVAR onto the timing stack. No further elapsed time is
315 attributed to the previous topmost timing variable on the stack;
316 subsequent elapsed time is attributed to TIMEVAR, until it is
317 popped or another element is pushed on top.
319 TIMEVAR cannot be running as a standalone timer. */
322 timer::push (timevar_id_t timevar
)
324 struct timevar_def
*tv
= &m_timevars
[timevar
];
328 /* Push TV onto the timing stack, either one of the builtin ones
329 for a timevar_id_t, or one provided by client code to libgccjit. */
332 timer::push_internal (struct timevar_def
*tv
)
334 struct timevar_stack_def
*context
;
335 struct timevar_time_def now
;
339 /* Mark this timing variable as used. */
342 /* Can't push a standalone timer. */
343 gcc_assert (!tv
->standalone
);
345 /* What time is it? */
348 /* If the stack isn't empty, attribute the current elapsed time to
349 the old topmost element. */
351 timevar_accumulate (&m_stack
->timevar
->elapsed
, &m_start_time
, &now
);
353 /* Reset the start time; from now on, time is attributed to
357 /* See if we have a previously-allocated stack instance. If so,
358 take it off the list. If not, malloc a new one. */
359 if (m_unused_stack_instances
!= NULL
)
361 context
= m_unused_stack_instances
;
362 m_unused_stack_instances
= m_unused_stack_instances
->next
;
365 context
= XNEW (struct timevar_stack_def
);
367 /* Fill it in and put it on the stack. */
368 context
->timevar
= tv
;
369 context
->next
= m_stack
;
373 /* Pop the topmost timing variable element off the timing stack. The
374 popped variable must be TIMEVAR. Elapsed time since the that
375 element was pushed on, or since it was last exposed on top of the
376 stack when the element above it was popped off, is credited to that
380 timer::pop (timevar_id_t timevar
)
382 gcc_assert (&m_timevars
[timevar
] == m_stack
->timevar
);
387 /* Pop the topmost item from the stack, either one of the builtin ones
388 for a timevar_id_t, or one provided by client code to libgccjit. */
391 timer::pop_internal ()
393 struct timevar_time_def now
;
394 struct timevar_stack_def
*popped
= m_stack
;
396 /* What time is it? */
399 /* Attribute the elapsed time to the element we're popping. */
400 timevar_accumulate (&popped
->timevar
->elapsed
, &m_start_time
, &now
);
402 /* Take the item off the stack. */
403 m_stack
= m_stack
->next
;
405 /* Record the elapsed sub-time to the parent as well. */
406 if (m_stack
&& time_report_details
)
408 if (! m_stack
->timevar
->children
)
409 m_stack
->timevar
->children
= new child_map_t (5);
411 timevar_time_def
&time
412 = m_stack
->timevar
->children
->get_or_insert (popped
->timevar
, &existed_p
);
414 memset (&time
, 0, sizeof (timevar_time_def
));
415 timevar_accumulate (&time
, &m_start_time
, &now
);
418 /* Reset the start time; from now on, time is attributed to the
419 element just exposed on the stack. */
422 /* Don't delete the stack element; instead, add it to the list of
423 unused elements for later use. */
424 popped
->next
= m_unused_stack_instances
;
425 m_unused_stack_instances
= popped
;
428 /* Start timing TIMEVAR independently of the timing stack. Elapsed
429 time until timevar_stop is called for the same timing variable is
430 attributed to TIMEVAR. */
433 timevar_start (timevar_id_t timevar
)
438 g_timer
->start (timevar
);
441 /* See timevar_start above. */
444 timer::start (timevar_id_t timevar
)
446 struct timevar_def
*tv
= &m_timevars
[timevar
];
448 /* Mark this timing variable as used. */
451 /* Don't allow the same timing variable to be started more than
453 gcc_assert (!tv
->standalone
);
456 get_time (&tv
->start_time
);
459 /* Stop timing TIMEVAR. Time elapsed since timevar_start was called
460 is attributed to it. */
463 timevar_stop (timevar_id_t timevar
)
468 g_timer
->stop (timevar
);
471 /* See timevar_stop above. */
474 timer::stop (timevar_id_t timevar
)
476 struct timevar_def
*tv
= &m_timevars
[timevar
];
477 struct timevar_time_def now
;
479 /* TIMEVAR must have been started via timevar_start. */
480 gcc_assert (tv
->standalone
);
481 tv
->standalone
= 0; /* Enable a restart. */
484 timevar_accumulate (&tv
->elapsed
, &tv
->start_time
, &now
);
488 /* Conditionally start timing TIMEVAR independently of the timing stack.
489 If the timer is already running, leave it running and return true.
490 Otherwise, start the timer and return false.
491 Elapsed time until the corresponding timevar_cond_stop
492 is called for the same timing variable is attributed to TIMEVAR. */
495 timevar_cond_start (timevar_id_t timevar
)
500 return g_timer
->cond_start (timevar
);
503 /* See timevar_cond_start above. */
506 timer::cond_start (timevar_id_t timevar
)
508 struct timevar_def
*tv
= &m_timevars
[timevar
];
510 /* Mark this timing variable as used. */
514 return true; /* The timevar is already running. */
516 /* Don't allow the same timing variable
517 to be unconditionally started more than once. */
520 get_time (&tv
->start_time
);
521 return false; /* The timevar was not already running. */
524 /* Conditionally stop timing TIMEVAR. The RUNNING parameter must come
525 from the return value of a dynamically matching timevar_cond_start.
526 If the timer had already been RUNNING, do nothing. Otherwise, time
527 elapsed since timevar_cond_start was called is attributed to it. */
530 timevar_cond_stop (timevar_id_t timevar
, bool running
)
532 if (!g_timer
|| running
)
535 g_timer
->cond_stop (timevar
);
538 /* See timevar_cond_stop above. */
541 timer::cond_stop (timevar_id_t timevar
)
543 struct timevar_def
*tv
;
544 struct timevar_time_def now
;
546 tv
= &m_timevars
[timevar
];
548 /* TIMEVAR must have been started via timevar_cond_start. */
549 gcc_assert (tv
->standalone
);
550 tv
->standalone
= 0; /* Enable a restart. */
553 timevar_accumulate (&tv
->elapsed
, &tv
->start_time
, &now
);
556 /* Push the named item onto the timing stack. */
559 timer::push_client_item (const char *item_name
)
561 gcc_assert (item_name
);
563 /* Lazily create the named_items instance. */
564 if (!m_jit_client_items
)
565 m_jit_client_items
= new named_items (this);
567 m_jit_client_items
->push (item_name
);
570 /* Pop the top-most client item from the timing stack. */
573 timer::pop_client_item ()
575 gcc_assert (m_jit_client_items
);
576 m_jit_client_items
->pop ();
579 /* Validate that phase times are consistent. */
582 timer::validate_phases (FILE *fp
) const
584 unsigned int /* timevar_id_t */ id
;
585 const timevar_time_def
*total
= &m_timevars
[TV_TOTAL
].elapsed
;
586 double phase_user
= 0.0;
587 double phase_sys
= 0.0;
588 double phase_wall
= 0.0;
589 size_t phase_ggc_mem
= 0;
590 static char phase_prefix
[] = "phase ";
591 const double tolerance
= 1.000001; /* One part in a million. */
593 for (id
= 0; id
< (unsigned int) TIMEVAR_LAST
; ++id
)
595 const timevar_def
*tv
= &m_timevars
[(timevar_id_t
) id
];
597 /* Don't evaluate timing variables that were never used. */
601 if (startswith (tv
->name
, phase_prefix
))
603 phase_user
+= tv
->elapsed
.user
;
604 phase_sys
+= tv
->elapsed
.sys
;
605 phase_wall
+= tv
->elapsed
.wall
;
606 phase_ggc_mem
+= tv
->elapsed
.ggc_mem
;
610 if (phase_user
> total
->user
* tolerance
611 || phase_sys
> total
->sys
* tolerance
612 || phase_wall
> total
->wall
* tolerance
613 || phase_ggc_mem
> total
->ggc_mem
* tolerance
)
616 fprintf (fp
, "Timing error: total of phase timers exceeds total time.\n");
617 if (phase_user
> total
->user
)
618 fprintf (fp
, "user %24.18e > %24.18e\n", phase_user
, total
->user
);
619 if (phase_sys
> total
->sys
)
620 fprintf (fp
, "sys %24.18e > %24.18e\n", phase_sys
, total
->sys
);
621 if (phase_wall
> total
->wall
)
622 fprintf (fp
, "wall %24.18e > %24.18e\n", phase_wall
, total
->wall
);
623 if (phase_ggc_mem
> total
->ggc_mem
)
624 fprintf (fp
, "ggc_mem %24lu > %24lu\n", (unsigned long)phase_ggc_mem
,
625 (unsigned long)total
->ggc_mem
);
630 /* Helper function for timer::print. */
633 timer::print_row (FILE *fp
,
634 const timevar_time_def
*total
,
635 const char *name
, const timevar_time_def
&elapsed
)
637 /* The timing variable name. */
638 fprintf (fp
, " %-35s:", name
);
640 #ifdef HAVE_USER_TIME
641 /* Print user-mode time for this process. */
642 fprintf (fp
, "%7.2f (%3.0f%%)",
644 (total
->user
== 0 ? 0 : elapsed
.user
/ total
->user
) * 100);
645 #endif /* HAVE_USER_TIME */
648 /* Print system-mode time for this process. */
649 fprintf (fp
, "%7.2f (%3.0f%%)",
651 (total
->sys
== 0 ? 0 : elapsed
.sys
/ total
->sys
) * 100);
652 #endif /* HAVE_SYS_TIME */
654 #ifdef HAVE_WALL_TIME
655 /* Print wall clock time elapsed. */
656 fprintf (fp
, "%7.2f (%3.0f%%)",
658 (total
->wall
== 0 ? 0 : elapsed
.wall
/ total
->wall
) * 100);
659 #endif /* HAVE_WALL_TIME */
661 /* Print the amount of ggc memory allocated. */
662 fprintf (fp
, PRsa (6) " (%3.0f%%)",
663 SIZE_AMOUNT (elapsed
.ggc_mem
),
666 : (float) elapsed
.ggc_mem
/ total
->ggc_mem
) * 100);
671 /* Return whether ELAPSED is all zero. */
674 timer::all_zero (const timevar_time_def
&elapsed
)
676 const double tiny
= 5e-3;
677 return (elapsed
.user
< tiny
678 && elapsed
.sys
< tiny
679 && elapsed
.wall
< tiny
680 && elapsed
.ggc_mem
< GGC_MEM_BOUND
);
683 /* Summarize timing variables to FP. The timing variable TV_TOTAL has
684 a special meaning -- it's considered to be the total elapsed time,
685 for normalizing the others, and is displayed last. */
688 timer::print (FILE *fp
)
690 /* Only print stuff if we have some sort of time information. */
691 #if defined (HAVE_USER_TIME) || defined (HAVE_SYS_TIME) || defined (HAVE_WALL_TIME)
692 unsigned int /* timevar_id_t */ id
;
693 const timevar_time_def
*total
= &m_timevars
[TV_TOTAL
].elapsed
;
694 struct timevar_time_def now
;
696 /* Update timing information in case we're calling this from GDB. */
701 /* What time is it? */
704 /* If the stack isn't empty, attribute the current elapsed time to
705 the old topmost element. */
707 timevar_accumulate (&m_stack
->timevar
->elapsed
, &m_start_time
, &now
);
709 /* Reset the start time; from now on, time is attributed to
713 fprintf (fp
, "\n%-35s%16s%14s%14s%14s\n", "Time variable", "usr", "sys",
715 if (m_jit_client_items
)
716 fputs ("GCC items:\n", fp
);
717 for (id
= 0; id
< (unsigned int) TIMEVAR_LAST
; ++id
)
719 const timevar_def
*tv
= &m_timevars
[(timevar_id_t
) id
];
721 /* Don't print the total execution time here; that goes at the
723 if ((timevar_id_t
) id
== TV_TOTAL
)
726 /* Don't print timing variables that were never used. */
730 bool any_children_with_time
= false;
732 for (child_map_t::iterator i
= tv
->children
->begin ();
733 i
!= tv
->children
->end (); ++i
)
734 if (! all_zero ((*i
).second
))
736 any_children_with_time
= true;
740 /* Don't print timing variables if we're going to get a row of
741 zeroes. Unless there are children with non-zero time. */
742 if (! any_children_with_time
743 && all_zero (tv
->elapsed
))
746 print_row (fp
, total
, tv
->name
, tv
->elapsed
);
749 for (child_map_t::iterator i
= tv
->children
->begin ();
750 i
!= tv
->children
->end (); ++i
)
752 timevar_def
*tv2
= (*i
).first
;
753 /* Don't print timing variables if we're going to get a row of
755 if (! all_zero ((*i
).second
))
758 snprintf (lname
, 256, "`- %s", tv2
->name
);
759 print_row (fp
, total
, lname
, (*i
).second
);
763 if (m_jit_client_items
)
764 m_jit_client_items
->print (fp
, total
);
766 /* Print total time. */
767 fprintf (fp
, " %-35s:", "TOTAL");
768 #ifdef HAVE_USER_TIME
769 fprintf (fp
, "%7.2f ", total
->user
);
772 fprintf (fp
, "%8.2f ", total
->sys
);
774 #ifdef HAVE_WALL_TIME
775 fprintf (fp
, "%8.2f ", total
->wall
);
777 fprintf (fp
, PRsa (7) "\n", SIZE_AMOUNT (total
->ggc_mem
));
779 if (CHECKING_P
|| flag_checking
)
780 fprintf (fp
, "Extra diagnostic checks enabled; compiler may run slowly.\n");
782 fprintf (fp
, "Configure with --enable-checking=release to disable checks.\n");
783 #ifndef ENABLE_ASSERT_CHECKING
784 fprintf (fp
, "Internal checks disabled; compiler is not suited for release.\n");
785 fprintf (fp
, "Configure with --enable-checking=release to enable checks.\n");
788 #endif /* defined (HAVE_USER_TIME) || defined (HAVE_SYS_TIME)
789 || defined (HAVE_WALL_TIME) */
791 validate_phases (fp
);
794 /* Get the name of the topmost item. For use by jit for validating
795 inputs to gcc_jit_timer_pop. */
797 timer::get_topmost_item_name () const
800 return m_stack
->timevar
->name
;
805 /* Prints a message to stderr stating that time elapsed in STR is
806 TOTAL (given in microseconds). */
809 print_time (const char *str
, long total
)
811 long all_time
= get_run_time ();
813 "time in %s: %ld.%06ld (%ld%%)\n",
814 str
, total
/ 1000000, total
% 1000000,
816 : (long) (((100.0 * (double) total
) / (double) all_time
) + .5));