/usr/include/fcl/profile.h is in libfcl-dev 0.3.0-1+b1.
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 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 | /*********************************************************************
* Software License Agreement (BSD License)
*
* Copyright (c) 2008, Willow Garage, Inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided
* with the distribution.
* * Neither the name of the Willow Garage nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*********************************************************************/
/* Author Ioan Sucan */
#ifndef FCL_UTIL_PROFILER
#define FCL_UTIL_PROFILER
#define ENABLE_PROFILING 1
#ifndef ENABLE_PROFILING
/// The ENABLE_PROFILING macro can be set externally. If it is not, profiling is enabled by default, unless NDEBUG is defined.
# ifdef NDEBUG
# define ENABLE_PROFILING 0
# else
# define ENABLE_PROFILING 1
# endif
#endif
#if ENABLE_PROFILING
#include <map>
#include <string>
#include <iostream>
#include <boost/thread.hpp>
#include <boost/noncopyable.hpp>
#include <boost/date_time/posix_time/posix_time.hpp>
namespace fcl
{
/// @brief Namespace containing time datatypes and time operations
namespace time
{
/// @brief Representation of a point in time
typedef boost::posix_time::ptime point;
/// @brief Representation of a time duration
typedef boost::posix_time::time_duration duration;
/// @brief Get the current time point
inline point now(void)
{
return boost::posix_time::microsec_clock::universal_time();
}
/// @brief Return the time duration representing a given number of seconds
inline duration seconds(double sec)
{
long s = (long)sec;
long us = (long)((sec - s) * 1000000);
return boost::posix_time::seconds(s) + boost::posix_time::microseconds(us);
}
/// @brief Return the number of seconds that a time duration represents
inline double seconds(const duration &d)
{
return (double)d.total_microseconds() / 1000000.0;
}
}
namespace tools
{
/// @brief This is a simple thread-safe tool for counting time
/// spent in various chunks of code. This is different from
/// external profiling tools in that it allows the user to count
/// time spent in various bits of code (sub-function granularity)
/// or count how many times certain pieces of code are executed.
class Profiler : private boost::noncopyable
{
public:
/// @brief This instance will call Profiler::begin() when constructed and Profiler::end() when it goes out of scope.
class ScopedBlock
{
public:
/// @brief Start counting time for the block named \e name of the profiler \e prof
ScopedBlock(const std::string &name, Profiler &prof = Profiler::Instance()) : name_(name), prof_(prof)
{
prof_.begin(name);
}
~ScopedBlock(void)
{
prof_.end(name_);
}
private:
std::string name_;
Profiler &prof_;
};
/// @brief This instance will call Profiler::start() when constructed and Profiler::stop() when it goes out of scope.
/// If the profiler was already started, this block's constructor and destructor take no action
class ScopedStart
{
public:
/// @brief Take as argument the profiler instance to operate on (\e prof)
ScopedStart(Profiler &prof = Profiler::Instance()) : prof_(prof), wasRunning_(prof_.running())
{
if (!wasRunning_)
prof_.start();
}
~ScopedStart(void)
{
if (!wasRunning_)
prof_.stop();
}
private:
Profiler &prof_;
bool wasRunning_;
};
/// @brief Return an instance of the class
static Profiler& Instance(void);
/// @brief Constructor. It is allowed to separately instantiate this
/// class (not only as a singleton)
Profiler(bool printOnDestroy = false, bool autoStart = false) : running_(false), printOnDestroy_(printOnDestroy)
{
if (autoStart)
start();
}
/// @brief Destructor
~Profiler(void)
{
if (printOnDestroy_ && !data_.empty())
status();
}
/// @brief Start counting time
static void Start(void)
{
Instance().start();
}
/// @brief Stop counting time
static void Stop(void)
{
Instance().stop();
}
/// @brief Clear counted time and events
static void Clear(void)
{
Instance().clear();
}
/// @brief Start counting time
void start(void);
/// @brief Stop counting time
void stop(void);
/// @brief Clear counted time and events
void clear(void);
/// @brief Count a specific event for a number of times
static void Event(const std::string& name, const unsigned int times = 1)
{
Instance().event(name, times);
}
/// @brief Count a specific event for a number of times
void event(const std::string &name, const unsigned int times = 1);
/// @brief Maintain the average of a specific value
static void Average(const std::string& name, const double value)
{
Instance().average(name, value);
}
/// @brief Maintain the average of a specific value
void average(const std::string &name, const double value);
/// @brief Begin counting time for a specific chunk of code
static void Begin(const std::string &name)
{
Instance().begin(name);
}
/// @brief Stop counting time for a specific chunk of code
static void End(const std::string &name)
{
Instance().end(name);
}
/// @brief Begin counting time for a specific chunk of code
void begin(const std::string &name);
/// @brief Stop counting time for a specific chunk of code
void end(const std::string &name);
/// @brief Print the status of the profiled code chunks and
/// events. Optionally, computation done by different threads
/// can be printed separately.
static void Status(std::ostream &out = std::cout, bool merge = true)
{
Instance().status(out, merge);
}
/// @brief Print the status of the profiled code chunks and
/// events. Optionally, computation done by different threads
/// can be printed separately.
void status(std::ostream &out = std::cout, bool merge = true);
/// @brief Check if the profiler is counting time or not
bool running(void) const
{
return running_;
}
/// @brief Check if the profiler is counting time or not
static bool Running(void)
{
return Instance().running();
}
private:
/// @brief Information about time spent in a section of the code
struct TimeInfo
{
TimeInfo(void) : total(0, 0, 0, 0), shortest(boost::posix_time::pos_infin), longest(boost::posix_time::neg_infin), parts(0)
{
}
/// @brief Total time counted.
time::duration total;
/// @brief The shortest counted time interval
time::duration shortest;
/// @brief The longest counted time interval
time::duration longest;
/// @brief Number of times a chunk of time was added to this structure
unsigned long int parts;
/// @brief The point in time when counting time started
time::point start;
/// @brief Begin counting time
void set(void)
{
start = time::now();
}
/// @brief Add the counted time to the total time
void update(void)
{
const time::duration &dt = time::now() - start;
if (dt > longest)
longest = dt;
if (dt < shortest)
shortest = dt;
total = total + dt;
++parts;
}
};
/// @brief Information maintained about averaged values
struct AvgInfo
{
/// @brief The sum of the values to average
double total;
/// @brief The sub of squares of the values to average
double totalSqr;
/// @brief Number of times a value was added to this structure
unsigned long int parts;
};
/// @brief Information to be maintained for each thread
struct PerThread
{
/// @brief The stored events
std::map<std::string, unsigned long int> events;
/// @brief The stored averages
std::map<std::string, AvgInfo> avg;
/// @brief The amount of time spent in various places
std::map<std::string, TimeInfo> time;
};
void printThreadInfo(std::ostream &out, const PerThread &data);
boost::mutex lock_;
std::map<boost::thread::id, PerThread> data_;
TimeInfo tinfo_;
bool running_;
bool printOnDestroy_;
};
}
}
#else
#include <string>
#include <iostream>
/// If profiling is disabled, provide empty implementations for the public functions
namespace fcl
{
namespace tools
{
class Profiler
{
public:
class ScopedBlock
{
public:
ScopedBlock(const std::string &, Profiler & = Profiler::Instance())
{
}
~ScopedBlock(void)
{
}
};
class ScopedStart
{
public:
ScopedStart(Profiler & = Profiler::Instance())
{
}
~ScopedStart(void)
{
}
};
static Profiler& Instance(void);
Profiler(bool = true, bool = true)
{
}
~Profiler(void)
{
}
static void Start(void)
{
}
static void Stop(void)
{
}
static void Clear(void)
{
}
void start(void)
{
}
void stop(void)
{
}
void clear(void)
{
}
static void Event(const std::string&, const unsigned int = 1)
{
}
void event(const std::string &, const unsigned int = 1)
{
}
static void Average(const std::string&, const double)
{
}
void average(const std::string &, const double)
{
}
static void Begin(const std::string &)
{
}
static void End(const std::string &)
{
}
void begin(const std::string &)
{
}
void end(const std::string &)
{
}
static void Status(std::ostream & = std::cout, bool = true)
{
}
void status(std::ostream & = std::cout, bool = true)
{
}
bool running(void) const
{
return false;
}
static bool Running(void)
{
return false;
}
};
}
}
#endif
#endif
|