/usr/include/dolfin/common/timing.h is in libdolfin-dev 2016.2.0-2.
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 | // Copyright (C) 2005-2010 Anders Logg, 2015 Jan Blechta
//
// This file is part of DOLFIN.
//
// DOLFIN is free software: 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.
//
// DOLFIN is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with DOLFIN. If not, see <http://www.gnu.org/licenses/>.
#ifndef __TIMING_H
#define __TIMING_H
#include <string>
#include <cstdint>
#include <dolfin/log/Table.h>
namespace dolfin
{
/// Parameter specifying whether to clear timing(s):
/// * ``TimingClear::keep``
/// * ``TimingClear::clear``
enum class TimingClear : bool { keep = false, clear = true };
/// Timing types:
/// * ``TimingType::wall`` wall-clock time
/// * ``TimingType::user`` user (cpu) time
/// * ``TimingType::system`` system (kernel) time
///
/// Precision of wall is around 1 microsecond, user and system are around
/// 10 millisecond (on Linux).
enum class TimingType : int32_t { wall = 0, user = 1, system = 2 };
/// Start timing (should not be used internally in DOLFIN!)
void tic();
/// Return elapsed wall time (should not be used internally in DOLFIN!)
double toc();
/// Return wall time elapsed since some implementation dependent epoch
double time();
/// Return a summary of timings and tasks in a _Table_, optionally clearing
/// stored timings
///
/// *Arguments*
/// clear (TimingClear)
/// * ``TimingClear::clear`` resets stored timings
/// * ``TimingClear::keep`` leaves stored timings intact
/// type (std::set<TimingType>)
/// subset of ``{ TimingType::wall, TimingType::user,
/// TimingType::system }``
///
/// *Returns*
/// _Table_
/// _Table_ with timings
Table timings(TimingClear clear, std::set<TimingType> type);
/// List a summary of timings and tasks, optionally clearing stored timings.
/// ``MPI_AVG`` reduction is printed. Collective on ``MPI_COMM_WORLD``.
///
/// *Arguments*
/// clear (TimingClear)
/// * ``TimingClear::clear`` resets stored timings
/// * ``TimingClear::keep`` leaves stored timings intact
/// type (std::set<TimingType>)
/// subset of ``{ TimingType::wall, TimingType::user,
/// TimingType::system }``
void list_timings(TimingClear clear, std::set<TimingType> type);
// NOTE: Function marked as 'collective on COMM_WORLD' (instead of
// 'collective on Logger::mpi_comm()') as user has no clue what the
// function has to do with Logger
/// Dump a summary of timings and tasks to XML file, optionally clearing
/// stored timings. ``MPI_MAX``, ``MPI_MIN`` and ``MPI_AVG`` reductions are
/// stored. Collective on ``MPI_COMM_WORLD``.
///
/// *Arguments*
/// filename (std::string)
/// output filename; must have ``.xml`` suffix; existing file
/// is silently overwritten
/// clear (TimingClear)
/// * ``TimingClear::clear`` resets stored timings
/// * ``TimingClear::keep`` leaves stored timings intact
void dump_timings_to_xml(std::string filename, TimingClear clear);
// NOTE: Function marked as 'collective on COMM_WORLD' (instead of
// 'collective on Logger::mpi_comm()') as user has no clue what the
// function has to do with Logger
/// Return timing (count, total wall time, total user time,
/// total system time) for given task, optionally clearing
/// all timings for the task
///
/// *Arguments*
/// task (std::string)
/// name of a task
/// clear (TimingClear)
/// * ``TimingClear::clear`` resets stored timings
/// * ``TimingClear::keep`` leaves stored timings intact
///
/// *Returns*
/// std::tuple<std::size_t, double, double, double>
/// (count, total wall time, total user time, total system time)
std::tuple<std::size_t, double, double, double>
timing(std::string task, TimingClear clear);
}
#endif
|