/usr/include/CGAL/Profile_counter.h is in libcgal-dev 4.7-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 | //r Copyright (c) 2005,2006,2008 INRIA Sophia-Antipolis (France).
// All rights reserved.
//
// This file is part of CGAL (www.cgal.org); you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 3 of the License,
// or (at your option) any later version.
//
// Licensees holding a valid commercial license may use this file in
// accordance with the commercial license agreement provided with the software.
//
// This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
// WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
//
// $URL$
// $Id$
//
//
// Author(s) : Sylvain Pion
#ifndef CGAL_PROFILE_COUNTER_H
#define CGAL_PROFILE_COUNTER_H
// This file contains several classes to help in profiling, together with macros
// triggered by CGAL_PROFILE to enable them:
//
// - Profile_counter which is able to keep track of a number, and prints a
// message in the destructor. Typically, it can be used as a profile counter
// in a static variable.
//
// - Profile_histogram_counter which is similar, but the counter is indexed by
// a value (unsigned int), and the final dump is the histogram of the non-zero
// counters.
//
// - Profile_branch_counter which keeps track of 2 counters, aiming at measuring
// the ratio corresponding to the number of times a branch is taken.
//
// - Profile_branch_counter_3 which keeps track of 3 counters, aiming at measuring
// the ratios corresponding to the number of times 2 branches are taken.
//
// If CGAL_CONCURRENT_PROFILE is defined, the counters can be concurrently updated
//
// See also CGAL/Profile_timer.h
// TODO :
// - Really complete the documentation!
// - Probably at some point we will need ways to selectively enable/disable profilers?
// (kind-wise and/or place-wise)
// - Ideas for new kinds of profilers:
// - lock counters in parallel mode
// (e.g. time spent spinning, and/or number of locks taken or forbidden...)
#include <CGAL/config.h>
#include <iostream>
#include <iomanip>
#include <string>
#include <map>
// Automatically define CGAL_CONCURRENT_PROFILE if we're linked with TBB
#ifdef CGAL_LINKED_WITH_TBB
# ifndef CGAL_CONCURRENT_PROFILE
# define CGAL_CONCURRENT_PROFILE
# endif
#else
// Automatically UNdefine CGAL_CONCURRENT_PROFILE if we're NOT linked with TBB
# ifdef CGAL_CONCURRENT_PROFILE
# undef CGAL_CONCURRENT_PROFILE
# endif
#endif
#ifdef CGAL_CONCURRENT_PROFILE
# include "tbb/concurrent_hash_map.h"
#endif
namespace CGAL {
struct Profile_counter
{
Profile_counter(const std::string & ss)
: s(ss)
{
i = 0; // needed here because of tbb::atomic
}
void operator++() { ++i; }
~Profile_counter()
{
std::cerr << "[CGAL::Profile_counter] "
<< std::setw(10) << i << " " << s << std::endl;
}
private:
#ifdef CGAL_CONCURRENT_PROFILE
tbb::atomic<unsigned int> i;
#else
unsigned int i;
#endif
const std::string s;
};
struct Profile_histogram_counter
{
private:
#ifdef CGAL_CONCURRENT_PROFILE
typedef tbb::concurrent_hash_map<unsigned, unsigned> Counters;
#else
typedef std::map<unsigned, unsigned> Counters;
#endif
public:
Profile_histogram_counter(const std::string & ss)
: s(ss) {}
void operator()(unsigned i)
{
#ifdef CGAL_CONCURRENT_PROFILE
Counters::accessor a;
counters.insert(a, i);
++a->second;
#else
++counters[i];
#endif
}
~Profile_histogram_counter()
{
unsigned total=0;
for (Counters::const_iterator it=counters.begin(), end=counters.end();
it != end; ++it) {
std::cerr << "[CGAL::Profile_histogram_counter] " << s;
std::cerr << " [ " << std::setw(10) << it->first << " : "
<< std::setw(10) << it->second << " ]"
<< std::endl;
total += it->second;
}
std::cerr << "[CGAL::Profile_histogram_counter] " << s;
std::cerr << " [ " << std::setw(10) << "Total" << " : "
<< std::setw(10) << total << " ]" << std::endl;
}
private:
Counters counters;
const std::string s;
};
struct Profile_branch_counter
{
Profile_branch_counter(const std::string & ss)
: s(ss)
{
i = j = 0; // needed here because of tbb::atomic
}
void operator++() { ++i; }
void increment_branch() { ++j; }
~Profile_branch_counter()
{
std::cerr << "[CGAL::Profile_branch_counter] "
<< std::setw(10) << j << " / "
<< std::setw(10) << i << " " << s << std::endl;
}
private:
#ifdef CGAL_CONCURRENT_PROFILE
tbb::atomic<unsigned int> i, j;
#else
unsigned int i, j;
#endif
const std::string s;
};
struct Profile_branch_counter_3
{
Profile_branch_counter_3(const std::string & ss)
: s(ss)
{
i = j = k = 0; // needed here because of tbb::atomic
}
void operator++() { ++i; }
void increment_branch_1() { ++j; }
void increment_branch_2() { ++k; }
~Profile_branch_counter_3()
{
std::cerr << "[CGAL::Profile_branch_counter_3] "
<< std::setw(10) << k << " / "
<< std::setw(10) << j << " / "
<< std::setw(10) << i << " " << s << std::endl;
}
private:
#ifdef CGAL_CONCURRENT_PROFILE
tbb::atomic<unsigned int> i, j, k;
#else
unsigned int i, j, k;
#endif
const std::string s;
};
#ifdef CGAL_PROFILE
# define CGAL_PROFILER(Y) \
{ static CGAL::Profile_counter tmp(Y); ++tmp; }
# define CGAL_HISTOGRAM_PROFILER(Y, Z) \
{ static CGAL::Profile_histogram_counter tmp(Y); tmp(Z); }
# define CGAL_BRANCH_PROFILER(Y, NAME) \
static CGAL::Profile_branch_counter NAME(Y); ++NAME;
# define CGAL_BRANCH_PROFILER_BRANCH(NAME) \
NAME.increment_branch();
# define CGAL_BRANCH_PROFILER_3(Y, NAME) \
static CGAL::Profile_branch_counter_3 NAME(Y); ++NAME;
# define CGAL_BRANCH_PROFILER_BRANCH_1(NAME) \
NAME.increment_branch_1();
# define CGAL_BRANCH_PROFILER_BRANCH_2(NAME) \
NAME.increment_branch_2();
#else
# define CGAL_PROFILER(Y)
# define CGAL_HISTOGRAM_PROFILER(Y, Z)
# define CGAL_BRANCH_PROFILER(Y, NAME)
# define CGAL_BRANCH_PROFILER_BRANCH(NAME)
# define CGAL_BRANCH_PROFILER_3(Y, NAME)
# define CGAL_BRANCH_PROFILER_BRANCH_1(NAME)
# define CGAL_BRANCH_PROFILER_BRANCH_2(NAME)
#endif
} //namespace CGAL
#endif // CGAL_PROFILE_COUNTER_H
|