stat_control.hh revision 9262:547845010c08 
1/*
2 * Copyright (c) 2012 ARM Limited
3 * All rights reserved
4 *
5 * The license below extends only to copyright in the software and shall
6 * not be construed as granting a license to any other intellectual
7 * property including but not limited to intellectual property relating
8 * to a hardware implementation of the functionality of the software
9 * licensed hereunder.  You may use the software subject to the license
10 * terms below provided that you ensure that this notice is replicated
11 * unmodified and in its entirety in all distributions of the software,
12 * modified or unmodified, in source code or in binary form.
13 *
14 * Copyright (c) 2004-2005 The Regents of The University of Michigan
15 * All rights reserved.
16 *
17 * Redistribution and use in source and binary forms, with or without
18 * modification, are permitted provided that the following conditions are
19 * met: redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer;
21 * redistributions in binary form must reproduce the above copyright
22 * notice, this list of conditions and the following disclaimer in the
23 * documentation and/or other materials provided with the distribution;
24 * neither the name of the copyright holders nor the names of its
25 * contributors may be used to endorse or promote products derived from
26 * this software without specific prior written permission.
27 *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 *
40 * Authors: Nathan Binkert
41 *          Sascha Bischoff
42 */
43
44#ifndef __SIM_STAT_CONTROL_HH__
45#define __SIM_STAT_CONTROL_HH__
46
47namespace Stats {
48
49void initSimStats();
50
51/**
52 * Update the events after resuming from a checkpoint. When resuming from a
53 * checkpoint, curTick will be updated, and any already scheduled events can
54 * end up scheduled in the past. This function checks if the dumpEvent is
55 * scheduled in the past, and reschedules it appropriately.
56 */
57void updateEvents();
58
59/**
60 * Schedule statistics dumping. This allows you to dump and/or reset the
61 * built-in statistics. This can either be done once, or it can be done on a
62 * regular basis.
63 * @param dump Set true to dump the statistics.
64 * @param reset Set true to reset the statistics.
65 * @param when When the dump and/or reset should occur.
66 * @param repeat How often the event should repeat. Set 0 to disable repeating.
67 */
68void schedStatEvent(bool dump, bool reset, Tick when = curTick(),
69                    Tick repeat = 0);
70
71/**
72 * Schedule periodic statistics dumping. This allows you to dump and reset the
73 * built-in statistics on a regular basis, thereby allowing the extraction of
74 * temporal trends in the data.
75 * @param period The period at which the dumping should occur.
76 */
77void periodicStatDump(uint64_t period = 0);
78} // namespace Stats
79
80#endif // __SIM_STAT_CONTROL_HH__
81