]> git.ipfire.org Git - thirdparty/gcc.git/blame - gcc/insn-notes.def
re PR testsuite/27476 (ACATS: Ada testsuite Bourne shell compatibility problem on...
[thirdparty/gcc.git] / gcc / insn-notes.def
CommitLineData
826c9564 1/* Insn note definitions.
fe9565ed 2 Copyright (C) 2004, 2005 Free Software Foundation, Inc.
826c9564
ZW
3
4This file is part of GCC.
5
6GCC is free software; you can redistribute it and/or modify it under
7the terms of the GNU General Public License as published by the Free
8Software Foundation; either version 2, or (at your option) any later
9version.
10
11GCC is distributed in the hope that it will be useful, but WITHOUT ANY
12WARRANTY; without even the implied warranty of MERCHANTABILITY or
13FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14for more details.
15
16You should have received a copy of the GNU General Public License
17along with GCC; see the file COPYING. If not, write to the Free
366ccddb
KC
18Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA
1902110-1301, USA. */
826c9564
ZW
20
21/* This file defines all the codes that may appear in the
22 NOTE_LINE_NUMBER field of a NOTE insn for kinds of notes that are
23 not line numbers. Source files define DEF_INSN_NOTE appropriately
24 before including this file.
25
26 We are slowly removing the concept of insn-chain notes from the
27 compiler. Adding new codes to this file is STRONGLY DISCOURAGED.
28 If you think you need one, look for other ways to express what you
29 mean, such as register notes or bits in the basic-block structure. */
30
31/* Shorthand. */
32#define INSN_NOTE(NAME) DEF_INSN_NOTE (NOTE_INSN_##NAME)
33
34/* This note is used to get rid of an insn when it isn't safe to patch
35 the insn out of the chain. */
36INSN_NOTE (DELETED)
37
38/* Generated in place of user-declared labels when they are deleted. */
39INSN_NOTE (DELETED_LABEL)
40
41/* These are used to mark the beginning and end of a lexical block.
42 See NOTE_BLOCK and reorder_blocks. */
43INSN_NOTE (BLOCK_BEG)
44INSN_NOTE (BLOCK_END)
45
46/* These mark the extremes of a loop. */
47INSN_NOTE (LOOP_BEG)
48INSN_NOTE (LOOP_END)
49
826c9564
ZW
50/* This note indicates the start of the real body of the function,
51 i.e. the point just after all of the parms have been moved into
52 their homes, etc. */
53INSN_NOTE (FUNCTION_BEG)
54
55/* This kind of note is generated at the end of the function body,
56 just before the return insn or return label. In an optimizing
57 compilation it is deleted by the first jump optimization, after
58 enabling that optimizer to determine whether control can fall
59 off the end of the function body without a return statement. */
60INSN_NOTE (FUNCTION_END)
61
62/* This marks the point immediately after the last prologue insn. */
63INSN_NOTE (PROLOGUE_END)
64
65/* This marks the point immediately prior to the first epilogue insn. */
66INSN_NOTE (EPILOGUE_BEG)
67
68/* These note where exception handling regions begin and end.
69 Uses NOTE_EH_HANDLER to identify the region in question. */
70INSN_NOTE (EH_REGION_BEG)
71INSN_NOTE (EH_REGION_END)
72
73/* Generated whenever a duplicate line number note is output.
74 For example, one is output after the end of an inline function,
75 in order to prevent the line containing the inline call from
76 being counted twice in gcov. */
77INSN_NOTE (REPEATED_LINE_NUMBER)
78
79/* The location of a variable. */
80INSN_NOTE (VAR_LOCATION)
81
82/* Record the expected value of a register at a location. Uses
83 NOTE_EXPECTED_VALUE; stored as (eq (reg) (const_int)). */
84INSN_NOTE (EXPECTED_VALUE)
85
86/* Record the struct for the following basic block. Uses
87 NOTE_BASIC_BLOCK. FIXME: Redundant with the basic block pointer
88 now included in every insn. */
89INSN_NOTE (BASIC_BLOCK)
90
87c8b4be
CT
91/* Mark the inflection point in the instruction stream where we switch
92 between hot and cold text sections. */
93INSN_NOTE (SWITCH_TEXT_SECTIONS)
826c9564 94
826c9564 95#undef INSN_NOTE