gem5  v22.1.0.0
cxx_config_ini.hh
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 
44 #ifndef __SIM_CXX_CONFIG_INI_HH__
45 #define __SIM_CXX_CONFIG_INI_HH__
46 
47 #include "base/inifile.hh"
48 #include "sim/cxx_config.hh"
49 
50 namespace gem5
51 {
52 
55 {
56  protected:
58 
59  public:
60  CxxIniFile() { }
61 
62  /* Most of these functions work by mapping 'object' onto 'section' */
63 
64  bool getParam(const std::string &object_name,
65  const std::string &param_name,
66  std::string &value) const;
67 
68  bool getParamVector(const std::string &object_name,
69  const std::string &param_name,
70  std::vector<std::string> &values) const;
71 
72  bool getPortPeers(const std::string &object_name,
73  const std::string &port_name,
74  std::vector<std::string> &peers) const;
75 
76  bool objectExists(const std::string &object_name) const;
77 
79 
80  void getObjectChildren(const std::string &object_name,
81  std::vector<std::string> &children,
82  bool return_paths = false) const;
83 
84  bool load(const std::string &filename);
85 };
86 
87 } // namespace gem5
88 
89 #endif // __SIM_CXX_CONFIG_INI_HH__
Config file wrapper providing a common interface to CxxConfigManager.
Definition: cxx_config.hh:204
CxxConfigManager interface for using .ini files.
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.
This class represents the contents of a ".ini" file.
Definition: inifile.hh:56
C++-only configuration and instantiation support.
Declaration of IniFile object.
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
static scfx_rep_node * list
Definition: scfx_rep.cc:336

Generated on Wed Dec 21 2022 10:22:39 for gem5 by doxygen 1.9.1