gem5  v21.1.0.2
text.hh
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2019-2020 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 
41 #ifndef __BASE_STATS_TEXT_HH__
42 #define __BASE_STATS_TEXT_HH__
43 
44 #include <iosfwd>
45 #include <stack>
46 #include <string>
47 
48 #include "base/compiler.hh"
49 #include "base/output.hh"
50 #include "base/stats/output.hh"
51 #include "base/stats/types.hh"
52 
53 namespace gem5
54 {
55 
56 GEM5_DEPRECATED_NAMESPACE(Stats, statistics);
57 namespace statistics
58 {
59 
60 class Text : public Output
61 {
62  protected:
63  bool mystream;
64  std::ostream *stream;
65 
66  // Object/group path
67  std::stack<std::string> path;
68 
69  protected:
70  bool noOutput(const Info &info);
71 
72  public:
75  bool spaces;
76 
77  public:
78  Text();
79  Text(std::ostream &stream);
80  Text(const std::string &file);
81  ~Text();
82 
83  void open(std::ostream &stream);
84  void open(const std::string &file);
85  std::string statName(const std::string &name) const;
86 
87  // Implement Visit
88  void visit(const ScalarInfo &info) override;
89  void visit(const VectorInfo &info) override;
90  void visit(const DistInfo &info) override;
91  void visit(const VectorDistInfo &info) override;
92  void visit(const Vector2dInfo &info) override;
93  void visit(const FormulaInfo &info) override;
94  void visit(const SparseHistInfo &info) override;
95 
96  // Group handling
97  void beginGroup(const char *name) override;
98  void endGroup() override;
99 
100  // Implement Output
101  bool valid() const override;
102  void begin() override;
103  void end() override;
104 };
105 
106 std::string ValueToString(Result value, int precision);
107 
108 Output *initText(const std::string &filename, bool desc, bool spaces);
109 
110 } // namespace statistics
111 } // namespace gem5
112 
113 #endif // __BASE_STATS_TEXT_HH__
gem5::statistics::Text::stream
std::ostream * stream
Definition: text.hh:64
gem5::statistics::Text::spaces
bool spaces
Definition: text.hh:75
types.hh
gem5::statistics::DistInfo
Definition: info.hh:201
gem5::statistics::Text::Text
Text()
Definition: text.cc:76
gem5::statistics::Result
double Result
All results are doubles.
Definition: types.hh:56
gem5::statistics::VectorInfo
Definition: info.hh:184
gem5::statistics::Text::mystream
bool mystream
Definition: text.hh:63
gem5::statistics::Text::beginGroup
void beginGroup(const char *name) override
Definition: text.cc:153
gem5::statistics::ScalarInfo
Definition: info.hh:176
gem5::statistics::Text::descriptions
bool descriptions
Definition: text.hh:74
output.hh
gem5::statistics::Text::endGroup
void endGroup() override
Definition: text.cc:163
gem5::statistics::Text::path
std::stack< std::string > path
Definition: text.hh:67
gem5::statistics::Text::begin
void begin() override
Definition: text.cc:131
gem5::statistics::Output
Definition: output.hh:65
gem5::statistics::SparseHistInfo
Definition: info.hh:251
gem5::statistics::Text::~Text
~Text()
Definition: text.cc:92
gem5::statistics::ValueToString
std::string ValueToString(Result value, int precision)
Definition: text.cc:182
gem5::statistics::Text::visit
void visit(const ScalarInfo &info) override
Definition: text.cc:587
compiler.hh
gem5::statistics::Text::end
void end() override
Definition: text.cc:137
gem5::statistics::Text::valid
bool valid() const override
Definition: text.cc:125
gem5::GEM5_DEPRECATED_NAMESPACE
GEM5_DEPRECATED_NAMESPACE(GuestABI, guest_abi)
name
const std::string & name()
Definition: trace.cc:49
gem5::statistics::Text
Definition: text.hh:60
gem5::statistics::Text::open
void open(std::ostream &stream)
Definition: text.cc:101
gem5::statistics::VectorDistInfo
Definition: info.hh:208
gem5::statistics::Text::noOutput
bool noOutput(const Info &info)
Definition: text.cc:170
output.hh
gem5::statistics::Text::statName
std::string statName(const std::string &name) const
Definition: text.cc:144
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
gem5::statistics::Text::enableUnits
bool enableUnits
Definition: text.hh:73
gem5::statistics::initText
Output * initText(const std::string &filename, bool desc, bool spaces)
Definition: text.cc:804
gem5::statistics::FormulaInfo
Definition: info.hh:245
gem5::statistics::Vector2dInfo
Definition: info.hh:226
gem5::statistics::Info
Definition: info.hh:80

Generated on Tue Sep 21 2021 12:24:59 for gem5 by doxygen 1.8.17