lib/timevar.def

   1 /* This file contains the definitions for timing variables used to -*- C -*-
   2    measure run-time performance of the compiler.
   3
   4    Copyright (C) 2002, 2007, 2009-2015, 2018-2024 Free Software Foundation,
   5    Inc.
   6
   7    Contributed by Akim Demaille <akim@freefriends.org>.
   8
   9    This program is free software: you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation, either version 3 of the License, or
  12    (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program.  If not, see <https://www.gnu.org/licenses/>.  */
  21
  22 /* This file contains the list of timing variable definitions, used by
  23    timevar.h and timevar.c.
  24
  25    Syntax:
  26
  27      DEFTIMEVAR (Id, Name)
  28
  29    where:
  30
  31    - Id is the value used to identify the timing variable.
  32      It's an enum value, i.e., behaves like a nonnegative integer.
  33      It is used only the manipulate the timer: the user of the
  34      program will never see this identifier.
  35
  36    - Name is a string describing its purpose.  This string
  37      will be presented to the user in the timing tables.  It does not
  38      need to be a literal, you may for instance use gettext.
  39
  40    The order of this list matters: that is the order in which the
  41    timing table is printed, except that 'tv_total' is printed last.
  42   */
  43
  44 /* The total execution time.  Mandatory.  */
  45 DEFTIMEVAR (tv_total,      "total time")
  46
  47 /* Examples.  */
  48 DEFTIMEVAR (tv_read,       "read")
  49 DEFTIMEVAR (tv_work,       "work")
  50 DEFTIMEVAR (tv_work_1,     "work: phase 1")
  51 DEFTIMEVAR (tv_work_2,     "work: phase 2")
  52 DEFTIMEVAR (tv_output,     "output")