coregrind/m_sbprofile.c

   1
   2 /*--------------------------------------------------------------------*/
   3 /*--- For printing superblock profiles               m_sbprofile.c ---*/
   4 /*--------------------------------------------------------------------*/
   5
   6 /*
   7    This file is part of Valgrind, a dynamic binary instrumentation
   8    framework.
   9
  10    Copyright (C) 2012-2017 Mozilla Foundation
  11
  12    This program is free software; you can redistribute it and/or
  13    modify it under the terms of the GNU General Public License as
  14    published by the Free Software Foundation; either version 2 of the
  15    License, or (at your option) any later version.
  16
  17    This program is distributed in the hope that it will be useful, but
  18    WITHOUT ANY WARRANTY; without even the implied warranty of
  19    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20    General Public License for more details.
  21
  22    You should have received a copy of the GNU General Public License
  23    along with this program; if not, write to the Free Software
  24    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  25    02111-1307, USA.
  26
  27    The GNU General Public License is contained in the file COPYING.
  28 */
  29
  30 /* Contributed by Julian Seward <jseward@acm.org> */
  31
  32 #include "pub_core_basics.h"
  33 #include "pub_core_transtab.h"
  34 #include "pub_core_libcbase.h"
  35 #include "pub_core_libcprint.h"
  36 #include "pub_core_libcassert.h"
  37 #include "pub_core_debuginfo.h"
  38 #include "pub_core_translate.h"
  39 #include "pub_core_options.h"
  40 #include "pub_core_sbprofile.h"    // self
  41
  42 /*====================================================================*/
  43 /*=== SB profiling                                                 ===*/
  44 /*====================================================================*/
  45
  46 static UInt n_profiles = 0;
  47
  48 static
  49 void show_SB_profile ( const SBProfEntry tops[], UInt n_tops,
  50                        ULong score_total, ULong ecs_done )
  51 {
  52    ULong score_cumul, score_cumul_saved, score_here;
  53    Int   r; /* must be signed */
  54
  55    HChar ecs_txt[50];    // large enough
  56    if (ecs_done > 0) {
  57       VG_(sprintf)(ecs_txt, "%'llu ecs done", ecs_done);
  58    } else {
  59       VG_(strcpy)(ecs_txt, "for the entire run");
  60    }
  61
  62    vg_assert(VG_(clo_profyle_sbs));
  63
  64    VG_(printf)("\n");
  65    VG_(printf)("<<<---<<<---<<<---<<<---<<<---<<<---<<<---"
  66                "<<<---<<<---<<<---<<<---<<<---<<<\n");
  67    VG_(printf)("<<<---<<<---<<<---<<<---<<<---<<<---<<<---"
  68                "<<<---<<<---<<<---<<<---<<<---<<<\n");
  69    VG_(printf)("\n");
  70    VG_(printf)("<<< BEGIN SB Profile #%u (%s)\n",
  71                ++n_profiles, ecs_txt);
  72    VG_(printf)("<<<\n");
  73    VG_(printf)("\n");
  74
  75    VG_(printf)("Total score = %'llu\n\n", score_total);
  76
  77    // FIXME JRS EPOCH 28 July 2017: this is probably not right in general
  78    DiEpoch cur_ep = VG_(current_DiEpoch)();
  79
  80    /* Print an initial per-block summary. */
  81    VG_(printf)("rank  ---cumulative---      -----self-----\n");
  82    score_cumul = 0;
  83    for (r = 0; r < n_tops; r++) {
  84       if (tops[r].addr == 0)
  85          continue;
  86       if (tops[r].score == 0)
  87          continue;
  88
  89       const HChar *name;
  90       VG_(get_fnname_w_offset)(cur_ep, tops[r].addr, &name);
  91
  92       score_here = tops[r].score;
  93       score_cumul += score_here;
  94
  95       /* Careful: do not divide by zero. score_total == 0 implies
  96          score_cumul == 0 and also score_here == 0. */
  97       Double percent_cumul =
  98          score_total == 0 ? 100.0 : score_cumul * 100.0 / score_total;
  99       Double percent_here =
 100          score_total == 0 ? 100.0 : score_here * 100.0 / score_total;
 101
 102       VG_(printf)("%3d: (%9llu %5.2f%%)   %9llu %5.2f%%      0x%lx %s\n",
 103                   r,
 104                   score_cumul, percent_cumul,
 105                   score_here,  percent_here, tops[r].addr, name);
 106    }
 107    score_cumul_saved = score_cumul;
 108
 109    if (VG_(clo_profyle_flags) > 0) {
 110
 111       /* Show the details, if requested. */
 112       VG_(printf)("\n");
 113       VG_(printf)("-----------------------------"
 114                   "------------------------------\n");
 115       VG_(printf)("--- SB Profile (SB details)  "
 116                   "                           ---\n");
 117       VG_(printf)("-----------------------------"
 118                   "------------------------------\n");
 119       VG_(printf)("\n");
 120
 121       score_cumul = 0;
 122       for (r = 0; r < n_tops; r++) {
 123          if (tops[r].addr == 0)
 124             continue;
 125          if (tops[r].score == 0)
 126             continue;
 127
 128          const HChar *name;
 129          VG_(get_fnname_w_offset)(cur_ep, tops[r].addr, &name);
 130
 131          score_here = tops[r].score;
 132          score_cumul += score_here;
 133
 134          /* Careful: do not divide by zero. score_total == 0 implies
 135             score_cumul == 0 and also score_here == 0. */
 136          Double percent_cumul =
 137            score_total == 0 ? 100.0 : score_cumul * 100.0 / score_total;
 138          Double percent_here =
 139            score_total == 0 ? 100.0 : score_here * 100.0 / score_total;
 140
 141          VG_(printf)("\n");
 142          VG_(printf)("=-=-=-=-=-=-=-=-=-=-=-=-=-= begin SB rank %d "
 143                      "=-=-=-=-=-=-=-=-=-=-=-=-=-=\n\n", r);
 144          VG_(printf)("%3d: (%9llu %5.2f%%)   %9llu %5.2f%%      0x%lx %s\n",
 145                      r,
 146                      score_cumul, percent_cumul,
 147                      score_here,  percent_here, tops[r].addr, name );
 148          VG_(printf)("\n");
 149          VG_(discard_translations)(tops[r].addr, 1, "bb profile");
 150          VG_(translate)(0, tops[r].addr, True, VG_(clo_profyle_flags), 0, True);
 151          VG_(printf)("=-=-=-=-=-=-=-=-=-=-=-=-=-=  end SB rank %d  "
 152                      "=-=-=-=-=-=-=-=-=-=-=-=-=-=\n\n", r);
 153       }
 154
 155       /* Print a final per-block summary, in reverse order, for the
 156          convenience of people reading up from the end. */
 157       score_cumul = score_cumul_saved;
 158       for (r = n_tops-1; r >= 0; r--) {
 159          if (tops[r].addr == 0)
 160             continue;
 161          if (tops[r].score == 0)
 162             continue;
 163
 164          const HChar *name;
 165          VG_(get_fnname_w_offset)(cur_ep, tops[r].addr, &name);
 166
 167          score_here = tops[r].score;
 168
 169          /* Careful: do not divide by zero. score_total == 0 implies
 170             score_cumul == 0 and also score_here == 0. */
 171          Double percent_cumul =
 172            score_total == 0 ? 100.0 : score_cumul * 100.0 / score_total;
 173          Double percent_here =
 174            score_total == 0 ? 100.0 : score_here * 100.0 / score_total;
 175
 176          VG_(printf)("%3d: (%9llu %5.2f%%)   %9llu %5.2f%%      0x%lx %s\n",
 177                      r,
 178                      score_cumul, percent_cumul,
 179                      score_here,  percent_here, tops[r].addr, name );
 180          score_cumul -= score_here;
 181       }
 182       VG_(printf)("rank  ---cumulative---      -----self-----\n");
 183
 184    }
 185
 186    VG_(printf)("\n");
 187    VG_(printf)(">>>\n");
 188    VG_(printf)(">>> END SB Profile #%u (%s)\n",
 189                n_profiles, ecs_txt);
 190    VG_(printf)(">>>\n");
 191    VG_(printf)(">>>--->>>--->>>--->>>--->>>--->>>--->>>---"
 192                ">>>--->>>--->>>--->>>--->>>--->>>\n");
 193    VG_(printf)(">>>--->>>--->>>--->>>--->>>--->>>--->>>---"
 194                ">>>--->>>--->>>--->>>--->>>--->>>\n");
 195    VG_(printf)("\n");
 196 }
 197
 198
 199 /* Get and print a profile.  Also, zero out the counters so that if we
 200    call it again later, the second call will only show new work done
 201    since the first call.  ecs_done == 0 is taken to mean this is a
 202    run-end profile. */
 203 void VG_(get_and_show_SB_profile) ( ULong ecs_done )
 204 {
 205    /* The number of blocks to show for a end-of-run profile */
 206 #  define N_MAX_END 200
 207    /* The number of blocks to show for a mid-run profile. */
 208 #  define N_MAX_INTERVAL 20
 209    vg_assert(N_MAX_INTERVAL <= N_MAX_END);
 210    SBProfEntry tops[N_MAX_END];
 211    Int nToShow = ecs_done == 0  ? N_MAX_END  : N_MAX_INTERVAL;
 212    ULong score_total = VG_(get_SB_profile)(tops, nToShow);
 213    show_SB_profile(tops, nToShow, score_total, ecs_done);
 214 #  undef N_MAX_END
 215 #  undef N_MAX_INTERVAL
 216 }
 217
 218
 219 /*--------------------------------------------------------------------*/
 220 /*--- end                                            m_sbprofile.c ---*/
 221 /*--------------------------------------------------------------------*/