1 /* Timing variables for measuring compiler performance.
2 Copyright (C) 2000-2020 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
)
202 const char *item_name
;
203 fprintf (fp
, "Client items:\n");
204 FOR_EACH_VEC_ELT (m_names
, i
, item_name
)
206 timer::timevar_def
*def
= m_hash_map
.get (item_name
);
208 m_timer
->print_row (fp
, total
, def
->name
, def
->elapsed
);
212 /* Fill the current times into TIME. The definition of this function
213 also defines any or all of the HAVE_USER_TIME, HAVE_SYS_TIME, and
214 HAVE_WALL_TIME macros. */
217 get_time (struct timevar_time_def
*now
)
222 now
->ggc_mem
= timevar_ggc_mem_total
;
227 now
->wall
= times (&tms
) * ticks_to_msec
;
228 now
->user
= tms
.tms_utime
* ticks_to_msec
;
229 now
->sys
= tms
.tms_stime
* ticks_to_msec
;
232 struct rusage rusage
;
233 getrusage (RUSAGE_SELF
, &rusage
);
234 now
->user
= rusage
.ru_utime
.tv_sec
+ rusage
.ru_utime
.tv_usec
* 1e-6;
235 now
->sys
= rusage
.ru_stime
.tv_sec
+ rusage
.ru_stime
.tv_usec
* 1e-6;
238 now
->user
= clock () * clocks_to_msec
;
243 /* Add the difference between STOP_TIME and START_TIME to TIMER. */
246 timevar_accumulate (struct timevar_time_def
*timer
,
247 struct timevar_time_def
*start_time
,
248 struct timevar_time_def
*stop_time
)
250 timer
->user
+= stop_time
->user
- start_time
->user
;
251 timer
->sys
+= stop_time
->sys
- start_time
->sys
;
252 timer
->wall
+= stop_time
->wall
- start_time
->wall
;
253 timer
->ggc_mem
+= stop_time
->ggc_mem
- start_time
->ggc_mem
;
256 /* Class timer's constructor. */
260 m_unused_stack_instances (NULL
),
262 m_jit_client_items (NULL
)
264 /* Zero all elapsed times. */
265 memset (m_timevars
, 0, sizeof (m_timevars
));
267 /* Initialize the names of timing variables. */
268 #define DEFTIMEVAR(identifier__, name__) \
269 m_timevars[identifier__].name = name__;
270 #include "timevar.def"
273 /* Initialize configuration-specific state.
274 Ideally this would be one-time initialization. */
276 ticks_to_msec
= TICKS_TO_MSEC
;
279 clocks_to_msec
= CLOCKS_TO_MSEC
;
283 /* Class timer's destructor. */
287 timevar_stack_def
*iter
, *next
;
289 for (iter
= m_stack
; iter
; iter
= next
)
294 for (iter
= m_unused_stack_instances
; iter
; iter
= next
)
299 for (unsigned i
= 0; i
< TIMEVAR_LAST
; ++i
)
300 delete m_timevars
[i
].children
;
302 delete m_jit_client_items
;
305 /* Initialize timing variables. */
313 g_timer
= new timer ();
316 /* Push TIMEVAR onto the timing stack. No further elapsed time is
317 attributed to the previous topmost timing variable on the stack;
318 subsequent elapsed time is attributed to TIMEVAR, until it is
319 popped or another element is pushed on top.
321 TIMEVAR cannot be running as a standalone timer. */
324 timer::push (timevar_id_t timevar
)
326 struct timevar_def
*tv
= &m_timevars
[timevar
];
330 /* Push TV onto the timing stack, either one of the builtin ones
331 for a timevar_id_t, or one provided by client code to libgccjit. */
334 timer::push_internal (struct timevar_def
*tv
)
336 struct timevar_stack_def
*context
;
337 struct timevar_time_def now
;
341 /* Mark this timing variable as used. */
344 /* Can't push a standalone timer. */
345 gcc_assert (!tv
->standalone
);
347 /* What time is it? */
350 /* If the stack isn't empty, attribute the current elapsed time to
351 the old topmost element. */
353 timevar_accumulate (&m_stack
->timevar
->elapsed
, &m_start_time
, &now
);
355 /* Reset the start time; from now on, time is attributed to
359 /* See if we have a previously-allocated stack instance. If so,
360 take it off the list. If not, malloc a new one. */
361 if (m_unused_stack_instances
!= NULL
)
363 context
= m_unused_stack_instances
;
364 m_unused_stack_instances
= m_unused_stack_instances
->next
;
367 context
= XNEW (struct timevar_stack_def
);
369 /* Fill it in and put it on the stack. */
370 context
->timevar
= tv
;
371 context
->next
= m_stack
;
375 /* Pop the topmost timing variable element off the timing stack. The
376 popped variable must be TIMEVAR. Elapsed time since the that
377 element was pushed on, or since it was last exposed on top of the
378 stack when the element above it was popped off, is credited to that
382 timer::pop (timevar_id_t timevar
)
384 gcc_assert (&m_timevars
[timevar
] == m_stack
->timevar
);
389 /* Pop the topmost item from the stack, either one of the builtin ones
390 for a timevar_id_t, or one provided by client code to libgccjit. */
393 timer::pop_internal ()
395 struct timevar_time_def now
;
396 struct timevar_stack_def
*popped
= m_stack
;
398 /* What time is it? */
401 /* Attribute the elapsed time to the element we're popping. */
402 timevar_accumulate (&popped
->timevar
->elapsed
, &m_start_time
, &now
);
404 /* Take the item off the stack. */
405 m_stack
= m_stack
->next
;
407 /* Record the elapsed sub-time to the parent as well. */
408 if (m_stack
&& time_report_details
)
410 if (! m_stack
->timevar
->children
)
411 m_stack
->timevar
->children
= new child_map_t (5);
413 timevar_time_def
&time
414 = m_stack
->timevar
->children
->get_or_insert (popped
->timevar
, &existed_p
);
416 memset (&time
, 0, sizeof (timevar_time_def
));
417 timevar_accumulate (&time
, &m_start_time
, &now
);
420 /* Reset the start time; from now on, time is attributed to the
421 element just exposed on the stack. */
424 /* Don't delete the stack element; instead, add it to the list of
425 unused elements for later use. */
426 popped
->next
= m_unused_stack_instances
;
427 m_unused_stack_instances
= popped
;
430 /* Start timing TIMEVAR independently of the timing stack. Elapsed
431 time until timevar_stop is called for the same timing variable is
432 attributed to TIMEVAR. */
435 timevar_start (timevar_id_t timevar
)
440 g_timer
->start (timevar
);
443 /* See timevar_start above. */
446 timer::start (timevar_id_t timevar
)
448 struct timevar_def
*tv
= &m_timevars
[timevar
];
450 /* Mark this timing variable as used. */
453 /* Don't allow the same timing variable to be started more than
455 gcc_assert (!tv
->standalone
);
458 get_time (&tv
->start_time
);
461 /* Stop timing TIMEVAR. Time elapsed since timevar_start was called
462 is attributed to it. */
465 timevar_stop (timevar_id_t timevar
)
470 g_timer
->stop (timevar
);
473 /* See timevar_stop above. */
476 timer::stop (timevar_id_t timevar
)
478 struct timevar_def
*tv
= &m_timevars
[timevar
];
479 struct timevar_time_def now
;
481 /* TIMEVAR must have been started via timevar_start. */
482 gcc_assert (tv
->standalone
);
483 tv
->standalone
= 0; /* Enable a restart. */
486 timevar_accumulate (&tv
->elapsed
, &tv
->start_time
, &now
);
490 /* Conditionally start timing TIMEVAR independently of the timing stack.
491 If the timer is already running, leave it running and return true.
492 Otherwise, start the timer and return false.
493 Elapsed time until the corresponding timevar_cond_stop
494 is called for the same timing variable is attributed to TIMEVAR. */
497 timevar_cond_start (timevar_id_t timevar
)
502 return g_timer
->cond_start (timevar
);
505 /* See timevar_cond_start above. */
508 timer::cond_start (timevar_id_t timevar
)
510 struct timevar_def
*tv
= &m_timevars
[timevar
];
512 /* Mark this timing variable as used. */
516 return true; /* The timevar is already running. */
518 /* Don't allow the same timing variable
519 to be unconditionally started more than once. */
522 get_time (&tv
->start_time
);
523 return false; /* The timevar was not already running. */
526 /* Conditionally stop timing TIMEVAR. The RUNNING parameter must come
527 from the return value of a dynamically matching timevar_cond_start.
528 If the timer had already been RUNNING, do nothing. Otherwise, time
529 elapsed since timevar_cond_start was called is attributed to it. */
532 timevar_cond_stop (timevar_id_t timevar
, bool running
)
534 if (!g_timer
|| running
)
537 g_timer
->cond_stop (timevar
);
540 /* See timevar_cond_stop above. */
543 timer::cond_stop (timevar_id_t timevar
)
545 struct timevar_def
*tv
;
546 struct timevar_time_def now
;
548 tv
= &m_timevars
[timevar
];
550 /* TIMEVAR must have been started via timevar_cond_start. */
551 gcc_assert (tv
->standalone
);
552 tv
->standalone
= 0; /* Enable a restart. */
555 timevar_accumulate (&tv
->elapsed
, &tv
->start_time
, &now
);
558 /* Push the named item onto the timing stack. */
561 timer::push_client_item (const char *item_name
)
563 gcc_assert (item_name
);
565 /* Lazily create the named_items instance. */
566 if (!m_jit_client_items
)
567 m_jit_client_items
= new named_items (this);
569 m_jit_client_items
->push (item_name
);
572 /* Pop the top-most client item from the timing stack. */
575 timer::pop_client_item ()
577 gcc_assert (m_jit_client_items
);
578 m_jit_client_items
->pop ();
581 /* Validate that phase times are consistent. */
584 timer::validate_phases (FILE *fp
) const
586 unsigned int /* timevar_id_t */ id
;
587 const timevar_time_def
*total
= &m_timevars
[TV_TOTAL
].elapsed
;
588 double phase_user
= 0.0;
589 double phase_sys
= 0.0;
590 double phase_wall
= 0.0;
591 size_t phase_ggc_mem
= 0;
592 static char phase_prefix
[] = "phase ";
593 const double tolerance
= 1.000001; /* One part in a million. */
595 for (id
= 0; id
< (unsigned int) TIMEVAR_LAST
; ++id
)
597 const timevar_def
*tv
= &m_timevars
[(timevar_id_t
) id
];
599 /* Don't evaluate timing variables that were never used. */
603 if (strncmp (tv
->name
, phase_prefix
, sizeof phase_prefix
- 1) == 0)
605 phase_user
+= tv
->elapsed
.user
;
606 phase_sys
+= tv
->elapsed
.sys
;
607 phase_wall
+= tv
->elapsed
.wall
;
608 phase_ggc_mem
+= tv
->elapsed
.ggc_mem
;
612 if (phase_user
> total
->user
* tolerance
613 || phase_sys
> total
->sys
* tolerance
614 || phase_wall
> total
->wall
* tolerance
615 || phase_ggc_mem
> total
->ggc_mem
* tolerance
)
618 fprintf (fp
, "Timing error: total of phase timers exceeds total time.\n");
619 if (phase_user
> total
->user
)
620 fprintf (fp
, "user %24.18e > %24.18e\n", phase_user
, total
->user
);
621 if (phase_sys
> total
->sys
)
622 fprintf (fp
, "sys %24.18e > %24.18e\n", phase_sys
, total
->sys
);
623 if (phase_wall
> total
->wall
)
624 fprintf (fp
, "wall %24.18e > %24.18e\n", phase_wall
, total
->wall
);
625 if (phase_ggc_mem
> total
->ggc_mem
)
626 fprintf (fp
, "ggc_mem %24lu > %24lu\n", (unsigned long)phase_ggc_mem
,
627 (unsigned long)total
->ggc_mem
);
632 /* Helper function for timer::print. */
635 timer::print_row (FILE *fp
,
636 const timevar_time_def
*total
,
637 const char *name
, const timevar_time_def
&elapsed
)
639 /* The timing variable name. */
640 fprintf (fp
, " %-35s:", name
);
642 #ifdef HAVE_USER_TIME
643 /* Print user-mode time for this process. */
644 fprintf (fp
, "%7.2f (%3.0f%%)",
646 (total
->user
== 0 ? 0 : elapsed
.user
/ total
->user
) * 100);
647 #endif /* HAVE_USER_TIME */
650 /* Print system-mode time for this process. */
651 fprintf (fp
, "%7.2f (%3.0f%%)",
653 (total
->sys
== 0 ? 0 : elapsed
.sys
/ total
->sys
) * 100);
654 #endif /* HAVE_SYS_TIME */
656 #ifdef HAVE_WALL_TIME
657 /* Print wall clock time elapsed. */
658 fprintf (fp
, "%7.2f (%3.0f%%)",
660 (total
->wall
== 0 ? 0 : elapsed
.wall
/ total
->wall
) * 100);
661 #endif /* HAVE_WALL_TIME */
663 /* Print the amount of ggc memory allocated. */
664 fprintf (fp
, "%8u kB (%3.0f%%)",
665 (unsigned) (elapsed
.ggc_mem
>> 10),
668 : (float) elapsed
.ggc_mem
/ total
->ggc_mem
) * 100);
673 /* Return whether ELAPSED is all zero. */
676 timer::all_zero (const timevar_time_def
&elapsed
)
678 const double tiny
= 5e-3;
679 return (elapsed
.user
< tiny
680 && elapsed
.sys
< tiny
681 && elapsed
.wall
< tiny
682 && elapsed
.ggc_mem
< GGC_MEM_BOUND
);
685 /* Summarize timing variables to FP. The timing variable TV_TOTAL has
686 a special meaning -- it's considered to be the total elapsed time,
687 for normalizing the others, and is displayed last. */
690 timer::print (FILE *fp
)
692 /* Only print stuff if we have some sort of time information. */
693 #if defined (HAVE_USER_TIME) || defined (HAVE_SYS_TIME) || defined (HAVE_WALL_TIME)
694 unsigned int /* timevar_id_t */ id
;
695 const timevar_time_def
*total
= &m_timevars
[TV_TOTAL
].elapsed
;
696 struct timevar_time_def now
;
698 /* Update timing information in case we're calling this from GDB. */
703 /* What time is it? */
706 /* If the stack isn't empty, attribute the current elapsed time to
707 the old topmost element. */
709 timevar_accumulate (&m_stack
->timevar
->elapsed
, &m_start_time
, &now
);
711 /* Reset the start time; from now on, time is attributed to
715 fprintf (fp
, "\n%-35s%16s%14s%14s%18s\n", "Time variable", "usr", "sys",
717 if (m_jit_client_items
)
718 fputs ("GCC items:\n", fp
);
719 for (id
= 0; id
< (unsigned int) TIMEVAR_LAST
; ++id
)
721 const timevar_def
*tv
= &m_timevars
[(timevar_id_t
) id
];
723 /* Don't print the total execution time here; that goes at the
725 if ((timevar_id_t
) id
== TV_TOTAL
)
728 /* Don't print timing variables that were never used. */
732 bool any_children_with_time
= false;
734 for (child_map_t::iterator i
= tv
->children
->begin ();
735 i
!= tv
->children
->end (); ++i
)
736 if (! all_zero ((*i
).second
))
738 any_children_with_time
= true;
742 /* Don't print timing variables if we're going to get a row of
743 zeroes. Unless there are children with non-zero time. */
744 if (! any_children_with_time
745 && all_zero (tv
->elapsed
))
748 print_row (fp
, total
, tv
->name
, tv
->elapsed
);
751 for (child_map_t::iterator i
= tv
->children
->begin ();
752 i
!= tv
->children
->end (); ++i
)
754 timevar_def
*tv2
= (*i
).first
;
755 /* Don't print timing variables if we're going to get a row of
757 if (! all_zero ((*i
).second
))
760 snprintf (lname
, 256, "`- %s", tv2
->name
);
761 print_row (fp
, total
, lname
, (*i
).second
);
765 if (m_jit_client_items
)
766 m_jit_client_items
->print (fp
, total
);
768 /* Print total time. */
769 fprintf (fp
, " %-35s:", "TOTAL");
770 #ifdef HAVE_USER_TIME
771 fprintf (fp
, "%7.2f ", total
->user
);
774 fprintf (fp
, "%8.2f ", total
->sys
);
776 #ifdef HAVE_WALL_TIME
777 fprintf (fp
, "%8.2f ", total
->wall
);
779 fprintf (fp
, "%9u kB\n", (unsigned) (total
->ggc_mem
>> 10));
781 if (CHECKING_P
|| flag_checking
)
782 fprintf (fp
, "Extra diagnostic checks enabled; compiler may run slowly.\n");
784 fprintf (fp
, "Configure with --enable-checking=release to disable checks.\n");
785 #ifndef ENABLE_ASSERT_CHECKING
786 fprintf (fp
, "Internal checks disabled; compiler is not suited for release.\n");
787 fprintf (fp
, "Configure with --enable-checking=release to enable checks.\n");
790 #endif /* defined (HAVE_USER_TIME) || defined (HAVE_SYS_TIME)
791 || defined (HAVE_WALL_TIME) */
793 validate_phases (fp
);
796 /* Get the name of the topmost item. For use by jit for validating
797 inputs to gcc_jit_timer_pop. */
799 timer::get_topmost_item_name () const
802 return m_stack
->timevar
->name
;
807 /* Prints a message to stderr stating that time elapsed in STR is
808 TOTAL (given in microseconds). */
811 print_time (const char *str
, long total
)
813 long all_time
= get_run_time ();
815 "time in %s: %ld.%06ld (%ld%%)\n",
816 str
, total
/ 1000000, total
% 1000000,
818 : (long) (((100.0 * (double) total
) / (double) all_time
) + .5));