gcc/predict.def

   1 /* This file contains the definitions and documentation for the
   2    builtins used in the GNU compiler.
   3    Copyright (C) 2001 Free Software Foundation, Inc.
   4
   5 This file is part of GNU CC.
   6
   7 GNU CC is free software; you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation; either version 2, or (at your option)
  10 any later version.
  11
  12 GNU CC is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GNU CC; see the file COPYING.  If not, write to
  19 the Free Software Foundation, 59 Temple Place - Suite 330,
  20 Boston, MA 02111-1307, USA.  */
  21
  22 /* Before including this file, you should define a macro:
  23
  24      DEF_PREDICTOR (ENUM, NAME, HITRATE)
  25
  26    This macro will be called once for each predictor.  The ENUM will
  27    be of type `enum predictor', and will enumerate all supported
  28    predictors.  The order of DEF_PREDICTOR calls is important, as
  29    in the first match combining heuristics, the predictor appearing
  30    first in this file will win.
  31
  32    NAME is used in the debugging output to determine predictor type.
  33
  34    HITRATE is the probability that edge predicted by predictor as taken
  35    will be really taken (so it should be always above
  36    REG_BR_PROB_BASE / 2).  */
  37
  38
  39 DEF_PREDICTOR (PRED_FIRST_MATCH, "first match", PROB_ALWAYS)
  40 DEF_PREDICTOR (PRED_UNCONDITIONAL, "unconditional jump", PROB_ALWAYS)
  41 DEF_PREDICTOR (PRED_LOOP_ITERATIONS, "loop iterations", PROB_ALWAYS)
  42 DEF_PREDICTOR (PRED_BUILTIN_EXPECT, "__builtin_expect", PROB_VERY_LIKELY)
  43 DEF_PREDICTOR (PRED_NORETURN, "noreturn call", PROB_ALWAYS)
  44 DEF_PREDICTOR (PRED_LOOP_BRANCH, "loop branch", PROB_VERY_LIKELY)
  45 DEF_PREDICTOR (PRED_LOOP_EXIT, "loop exit", PROB_LIKELY)
  46 DEF_PREDICTOR (PRED_LOOP_HEADER, "loop header", PROB_LIKELY)
  47 DEF_PREDICTOR (PRED_POINTER, "pointer", PROB_LIKELY)
  48 DEF_PREDICTOR (PRED_OPCODE, "opcode", PROB_LIKELY)
  49 DEF_PREDICTOR (PRED_CALL, "call", PROB_LIKELY)
  50 DEF_PREDICTOR (PRED_ERROR_RETURN, "error return", PROB_LIKELY)