gcc/insn-notes.def

   1 /* Insn note definitions.
   2    Copyright (C) 2004-2021 Free Software Foundation, Inc.
   3
   4 This file is part of GCC.
   5
   6 GCC is free software; you can redistribute it and/or modify it under
   7 the terms of the GNU General Public License as published by the Free
   8 Software Foundation; either version 3, or (at your option) any later
   9 version.
  10
  11 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14 for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along 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.  */
  35 INSN_NOTE (DELETED)
  36
  37 /* Generated in place of user-declared labels when they are deleted.  */
  38 INSN_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.  */
  42 INSN_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.  */
  46 INSN_NOTE (BLOCK_BEG)
  47 INSN_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.  */
  52 INSN_NOTE (FUNCTION_BEG)
  53
  54 /* This marks the point immediately after the last prologue insn.  */
  55 INSN_NOTE (PROLOGUE_END)
  56
  57 /* This marks the point immediately prior to the first epilogue insn.  */
  58 INSN_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.  */
  62 INSN_NOTE (EH_REGION_BEG)
  63 INSN_NOTE (EH_REGION_END)
  64
  65 /* The location of a variable.  */
  66 INSN_NOTE (VAR_LOCATION)
  67
  68 /* The beginning of a statement.  */
  69 INSN_NOTE (BEGIN_STMT)
  70
  71 /* The entry point for an inlined function.  Its NOTE_BLOCK references
  72    the lexical block whose abstract origin is the inlined function.  */
  73 INSN_NOTE (INLINE_ENTRY)
  74
  75 /* Record the struct for the following basic block.  Uses
  76    NOTE_BASIC_BLOCK.  FIXME: Redundant with the basic block pointer
  77    now included in every insn.  NOTE: If there's no CFG anymore, in other words,
  78    if BLOCK_FOR_INSN () == NULL, NOTE_BASIC_BLOCK cannot be considered reliable
  79    anymore.  */
  80 INSN_NOTE (BASIC_BLOCK)
  81
  82 /* Mark the inflection point in the instruction stream where we switch
  83    between hot and cold text sections.  */
  84 INSN_NOTE (SWITCH_TEXT_SECTIONS)
  85
  86 /* When emitting dwarf2 frame information, contains a directive that
  87    should be emitted.  */
  88 INSN_NOTE (CFI)
  89
  90 /* When emitting dwarf2 frame information, contains the number of a debug
  91    label that should be emitted.  */
  92 INSN_NOTE (CFI_LABEL)
  93
  94 /* This note indicates that the function context must be updated if
  95    the Setjmp/Longjmp exception mechanism is used.  */
  96 INSN_NOTE (UPDATE_SJLJ_CONTEXT)
  97
  98 #undef INSN_NOTE