[thirdparty/gcc.git] / gcc / doc / gccint / plugins / recording-information-about-pass-execution.rst

..
  Copyright 1988-2022 Free Software Foundation, Inc.
  This is part of the GCC manual.
  For copying conditions, see the copyright.rst file.

.. _plugins-recording:

Recording information about pass execution
******************************************

The event PLUGIN_PASS_EXECUTION passes the pointer to the executed pass
(the same as current_pass) as ``gcc_data`` to the callback.  You can also
inspect cfun to find out about which function this pass is executed for.
Note that this event will only be invoked if the gate check (if
applicable, modified by PLUGIN_OVERRIDE_GATE) succeeds.
You can use other hooks, like ``PLUGIN_ALL_PASSES_START``,
``PLUGIN_ALL_PASSES_END``, ``PLUGIN_ALL_IPA_PASSES_START``,
``PLUGIN_ALL_IPA_PASSES_END``, ``PLUGIN_EARLY_GIMPLE_PASSES_START``,
and/or ``PLUGIN_EARLY_GIMPLE_PASSES_END`` to manipulate global state
in your plugin(s) in order to get context for the pass execution.
Commit	Line	Data
c63539ff ML	1	..
	2	Copyright 1988-2022 Free Software Foundation, Inc.
	3	This is part of the GCC manual.
	4	For copying conditions, see the copyright.rst file.
	5
	6	.. _plugins-recording:
	7
	8	Recording information about pass execution
	9	******************************************
	10
	11	The event PLUGIN_PASS_EXECUTION passes the pointer to the executed pass
	12	(the same as current_pass) as ``gcc_data`` to the callback. You can also
	13	inspect cfun to find out about which function this pass is executed for.
	14	Note that this event will only be invoked if the gate check (if
	15	applicable, modified by PLUGIN_OVERRIDE_GATE) succeeds.
	16	You can use other hooks, like ``PLUGIN_ALL_PASSES_START``,
	17	``PLUGIN_ALL_PASSES_END``, ``PLUGIN_ALL_IPA_PASSES_START``,
	18	``PLUGIN_ALL_IPA_PASSES_END``, ``PLUGIN_EARLY_GIMPLE_PASSES_START``,
	19	and/or ``PLUGIN_EARLY_GIMPLE_PASSES_END`` to manipulate global state
3ed1b4ce	20	in your plugin(s) in order to get context for the pass execution.