1/* Insn note definitions.
2 Copyright (C) 2004-2017 Free Software Foundation, Inc.
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 3, 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 COPYING3. If not see
18<http://www.gnu.org/licenses/>. */
19
20/* This file defines all the codes that may appear in the
21 NOTE_LINE_NUMBER field of a NOTE insn for kinds of notes that are
22 not line numbers. Source files define DEF_INSN_NOTE appropriately
23 before including this file.
24
25 We are slowly removing the concept of insn-chain notes from the
26 compiler. Adding new codes to this file is STRONGLY DISCOURAGED.
27 If you think you need one, look for other ways to express what you
28 mean, such as register notes or bits in the basic-block structure. */
29
30/* Shorthand. */
31#define INSN_NOTE(NAME) DEF_INSN_NOTE (NOTE_INSN_##NAME)
32
33/* This note is used to get rid of an insn when it isn't safe to patch
34 the insn out of the chain. */
35INSN_NOTE (DELETED)
36
37/* Generated in place of user-declared labels when they are deleted. */
38INSN_NOTE (DELETED_LABEL)
39/* Similarly, but for labels that have been present in debug stmts
40 earlier and thus will only appear with -g. These must use different
41 label namespace. */
42INSN_NOTE (DELETED_DEBUG_LABEL)
43
44/* These are used to mark the beginning and end of a lexical block.
45 See NOTE_BLOCK and reorder_blocks. */
46INSN_NOTE (BLOCK_BEG)
47INSN_NOTE (BLOCK_END)
48
49/* This note indicates the start of the real body of the function,
50 i.e. the point just after all of the parms have been moved into
51 their homes, etc. */
52INSN_NOTE (FUNCTION_BEG)
53
54/* This marks the point immediately after the last prologue insn. */
55INSN_NOTE (PROLOGUE_END)
56
57/* This marks the point immediately prior to the first epilogue insn. */
58INSN_NOTE (EPILOGUE_BEG)
59
60/* These note where exception handling regions begin and end.
61 Uses NOTE_EH_HANDLER to identify the region in question. */
62INSN_NOTE (EH_REGION_BEG)
63INSN_NOTE (EH_REGION_END)
64
65/* The location of a variable. */
66INSN_NOTE (VAR_LOCATION)
67
68/* The values passed to callee. */
69INSN_NOTE (CALL_ARG_LOCATION)
70
71/* The beginning of a statement. */
72INSN_NOTE (BEGIN_STMT)
73
74/* Record the struct for the following basic block. Uses
75 NOTE_BASIC_BLOCK. FIXME: Redundant with the basic block pointer
76 now included in every insn. NOTE: If there's no CFG anymore, in other words,
77 if BLOCK_FOR_INSN () == NULL, NOTE_BASIC_BLOCK cannot be considered reliable
78 anymore. */
79INSN_NOTE (BASIC_BLOCK)
80
81/* Mark the inflection point in the instruction stream where we switch
82 between hot and cold text sections. */
83INSN_NOTE (SWITCH_TEXT_SECTIONS)
84
85/* When emitting dwarf2 frame information, contains a directive that
86 should be emitted. */
87INSN_NOTE (CFI)
88
89/* When emitting dwarf2 frame information, contains the number of a debug
90 label that should be emitted. */
91INSN_NOTE (CFI_LABEL)
92
93/* This note indicates that the function context must be updated if
94 the Setjmp/Longjmp exception mechanism is used. */
95INSN_NOTE (UPDATE_SJLJ_CONTEXT)
96
97#undef INSN_NOTE
98