gem5 [DEVELOP-FOR-25.0]
Loading...
Searching...
No Matches
cxx_config_ini.cc
Go to the documentation of this file.
1/*
2 * Copyright (c) 2014 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 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions are
16 * met: redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer;
18 * redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution;
21 * neither the name of the copyright holders nor the names of its
22 * contributors may be used to endorse or promote products derived from
23 * this software without specific prior written permission.
24 *
25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 */
37
38#include <cassert>
39
40#include "sim/cxx_config_ini.hh"
41
42#include "base/str.hh"
43
44namespace gem5
45{
46
47bool
48CxxIniFile::getParam(const std::string &object_name,
49 const std::string &param_name,
50 std::string &value) const
51{
52 return iniFile.find(object_name, param_name, value);
53}
54
55bool
56CxxIniFile::getParamVector(const std::string &object_name,
57 const std::string &param_name,
58 std::vector<std::string> &values) const
59{
60 std::string value;
61 bool ret = iniFile.find(object_name, param_name, value);
62
63 if (ret) {
64 std::vector<std::string> sub_object_names;
65
66 tokenize(values, value, ' ', true);
67 }
68
69 return ret;
70}
71
72bool
73CxxIniFile::getParamDict(const std::string &object_name,
74 const std::string &param_name,
75 std::unordered_map<std::string, std::string> &values) const
76{
77 std::vector<std::string> vec_values;
78 auto ret = getParamVector(object_name, param_name, vec_values);
79
80 // Fail if number of vector entries is odd as it means we are
81 // missing a key or a value
82 assert(vec_values.size() % 2 == 0);
83
84 if (ret) {
85 for (auto idx = 0; idx < vec_values.size(); idx+=2) {
86 const std::string &key = vec_values[idx];
87 const std::string &val = vec_values[idx + 1];
88
89 panic_if(values.find(key) != values.end(),
90 "Key %s already present in Dict", key);
91 values[key] = val;
92 }
93 }
94
95 return ret;
96}
97
98bool
99CxxIniFile::getPortPeers(const std::string &object_name,
100 const std::string &port_name,
101 std::vector<std::string> &peers) const
102{
103 return getParamVector(object_name, port_name, peers);
104}
105
106bool
107CxxIniFile::objectExists(const std::string &object) const
108{
109 return iniFile.sectionExists(object);
110}
111
112void
117
118void
119CxxIniFile::getObjectChildren(const std::string &object_name,
120 std::vector<std::string> &children, bool return_paths) const
121{
122 if (!getParamVector(object_name, "children", children))
123 return;
124
125 if (return_paths && object_name != "root") {
126 for (auto i = children.begin(); i != children.end(); ++i)
127 *i = object_name + "." + *i;
128 }
129}
130
131bool
132CxxIniFile::load(const std::string &filename)
133{
134 return iniFile.load(filename);
135}
136
137} // namespace gem5
bool getParamDict(const std::string &object_name, const std::string &param_name, std::unordered_map< std::string, std::string > &values) const
Finds the dictionary parameter of the object in the ini file and unserializes it into the values argu...
bool objectExists(const std::string &object_name) const
Does an object with this path exist?
bool getParamVector(const std::string &object_name, const std::string &param_name, std::vector< std::string > &values) const
Get a list/vector parameter.
bool getPortPeers(const std::string &object_name, const std::string &port_name, std::vector< std::string > &peers) const
Get the peer (connected) ports of the named ports.
bool load(const std::string &filename)
Load config file.
void getObjectChildren(const std::string &object_name, std::vector< std::string > &children, bool return_paths=false) const
Get the names or paths of all the children SimObjects of this SimObject.
void getAllObjectNames(std::vector< std::string > &list) const
Get all SimObjects in the config.
bool getParam(const std::string &object_name, const std::string &param_name, std::string &value) const
Get a single parameter value as a string returned in value.
STL list class.
Definition stl.hh:51
STL vector class.
Definition stl.hh:37
.ini file reading wrapper for use with CxxConfigManager
#define panic_if(cond,...)
Conditional panic macro that checks the supplied condition and only panics if the condition is true a...
Definition logging.hh:246
Bitfield< 7 > i
Definition misc_types.hh:67
Bitfield< 63 > val
Definition misc.hh:804
Copyright (c) 2024 Arm Limited All rights reserved.
Definition binary32.hh:36
void tokenize(std::vector< std::string > &v, const std::string &s, char token, bool ignore)
Definition str.cc:68

Generated on Mon May 26 2025 09:19:13 for gem5 by doxygen 1.13.2