Gabe Black has uploaded this change for review. (
https://gem5-review.googlesource.com/c/public/gem5/+/49455 )
Change subject: scons,sim,util: Eliminate the generated cxx_config/init.cc
file.
......................................................................
scons,sim,util: Eliminate the generated cxx_config/init.cc file.
This file populated the "cxx_config_directory" map from type names to
directory entry generating types. It used a comprehensive list of
includes of all SimObject headers, and a comprehensive list of the
generating types to fill everything in.
Instead, this change creates a new singleton helper class which, when
instantiated as a static member of a CxxConfigParams subclass, will
install a pointer to a CxxConfigDirectoryEntry to that map during global
object construction time.
Also, this change renames the map to cxxConfigDirectory which is in
compliance with the style guide, and puts it behind an accessor which
returns a static variable which is the actual map. This avoids any
problems that might come from global object construction order.
Change-Id: Iaa913fbe5af1b11d90ca618e29420eeb7cb0faed
---
M src/SConscript
M src/sim/cxx_config.cc
M src/sim/cxx_config.hh
M src/sim/cxx_manager.cc
M util/bld/cxx_config_hh.py
D util/bld/cxx_config_init_cc.py
6 files changed, 27 insertions(+), 106 deletions(-)
diff --git a/src/SConscript b/src/SConscript
index 731ab5c..6ae21f2 100644
--- a/src/SConscript
+++ b/src/SConscript
@@ -132,16 +132,12 @@
'''Add a SimObject python file as a python source object and add
it to a list of sim object modules'''
- sim_objects = []
-
def __init__(self, source, *, sim_objects=[], enums=[],
tags=None, add_tags=None):
'''Specify the source file and any tags (automatically in
the m5.objects package)'''
super(SimObject, self).__init__('m5.objects', source, tags,
add_tags)
- SimObject.sim_objects.extend(sim_objects)
-
build_dir = Dir(env['BUILDDIR'])
module = self.modpath
@@ -600,25 +596,6 @@
m5_module_static = list(map(lambda s: s.static(gem5py_env),
m5_module_source))
gem5py_env.Program(gem5py_m5, [ 'python/gem5py.cc' ] + m5_module_static)
-########################################################################
-#
-# Create the CXX config init.cc.
-#
-
-all_sim_objects = sorted(SimObject.sim_objects)
-sim_object_args = list(f'"{sim_object}"' for sim_object in all_sim_objects)
-cc_file = File('cxx_config/init.cc')
-gem5py_env.Command([ "${CXXCONFIGINIT_CC}" ],
- [ "${GEM5PY}", "${CXXCONFIGINITCC_PY}" ],
- MakeAction('"${GEM5PY}" "${CXXCONFIGINITCC_PY}" "${TARGET}" '
- '${SIM_OBJECTS}',
- Transform("CXXCINIT", 0)),
- CXXCONFIGINITCC_PY=util_bld.File('cxx_config_init_cc.py'),
- SIM_OBJECTS=' '.join(sim_object_args),
- CXXCONFIGINIT_CC=cc_file)
-if GetOption('with_cxx_config'):
- Source(cc_file)
-
#
# Handle debug flags
#
diff --git a/src/sim/cxx_config.cc b/src/sim/cxx_config.cc
index dc25402..2f14ae9 100644
--- a/src/sim/cxx_config.cc
+++ b/src/sim/cxx_config.cc
@@ -43,6 +43,11 @@
const std::string CxxConfigParams::invalidName = "<invalid>";
/** Directory of all SimObject classes config details */
-std::map<std::string, CxxConfigDirectoryEntry *> cxx_config_directory;
+std::map<std::string, CxxConfigDirectoryEntry *> &
+cxxConfigDirectory()
+{
+ static std::map<std::string, CxxConfigDirectoryEntry *> dir;
+ return dir;
+}
} // namespace gem5
diff --git a/src/sim/cxx_config.hh b/src/sim/cxx_config.hh
index 081860a..1f677b3 100644
--- a/src/sim/cxx_config.hh
+++ b/src/sim/cxx_config.hh
@@ -119,6 +119,9 @@
virtual ~CxxConfigDirectoryEntry() { }
};
+/** Directory of all SimObject classes config details */
+std::map<std::string, CxxConfigDirectoryEntry *> &cxxConfigDirectory();
+
/** Base for peer classes of SimObjectParams derived classes with parameter
* modifying member functions. C++ configuration will offer objects of
* these classes to SimObjects as params rather than SimObjectParams
@@ -128,6 +131,18 @@
private:
static const std::string invalidName;
+ protected:
+ struct AddToConfigDir
+ {
+ AddToConfigDir(const std::string &name, CxxConfigDirectoryEntry
*entry)
+ {
+ auto [it, success] = cxxConfigDirectory().insert({name,
entry});
+ panic_if(!success,
+ "Failed to insert config directory entry %s
(duplicate?).",
+ name);
+ }
+ };
+
public:
/** Flags passable to setParam... to smooth over any parsing difference
* between different config files */
@@ -229,14 +244,6 @@
virtual CxxConfigParams::Flags getFlags() const { return 0; }
};
-/** Directory of all SimObject classes config details */
-extern std::map<std::string, CxxConfigDirectoryEntry *>
- cxx_config_directory;
-
-/** Initialise cxx_config_directory. This is defined in the
- * auto-generated .../cxx_config/init.cc */
-void cxxConfigInit();
-
} // namespace gem5
#endif // __SIM_CXX_CONFIG_HH__
diff --git a/src/sim/cxx_manager.cc b/src/sim/cxx_manager.cc
index 9c25091..609b939 100644
--- a/src/sim/cxx_manager.cc
+++ b/src/sim/cxx_manager.cc
@@ -65,14 +65,14 @@
if (!configFile.getParam(object_name, "type", object_type))
throw Exception(object_name, "Sim object has no 'type' field");
- if (cxx_config_directory.find(object_type) ==
- cxx_config_directory.end())
+ if (cxxConfigDirectory().find(object_type) ==
+ cxxConfigDirectory().end())
{
throw Exception(object_name, csprintf(
"No sim object type %s is available", object_type));
}
- const CxxConfigDirectoryEntry *entry =
cxx_config_directory[object_type];
+ const CxxConfigDirectoryEntry *entry =
cxxConfigDirectory()[object_type];
return *entry;
}
diff --git a/util/bld/cxx_config_hh.py b/util/bld/cxx_config_hh.py
index b559cc6..28d97b6 100644
--- a/util/bld/cxx_config_hh.py
+++ b/util/bld/cxx_config_hh.py
@@ -71,6 +71,9 @@
}
};
+ static inline AddToConfigDir dirEntry
+ {"${sim_object_name}", new DirectoryEntry};
+
public:
bool setSimObject(const std::string &name, SimObject *simObject);
@@ -90,13 +93,6 @@
bool setPortConnectionCount(const std::string &name, unsigned int
count);
SimObject *simObjectCreate();
-
- static CxxConfigDirectoryEntry *
- makeDirectoryEntry()
- {
- return new DirectoryEntry;
- }
-
};
} // namespace gem5
diff --git a/util/bld/cxx_config_init_cc.py b/util/bld/cxx_config_init_cc.py
deleted file mode 100644
index f26c0e4..0000000
--- a/util/bld/cxx_config_init_cc.py
+++ /dev/null
@@ -1,64 +0,0 @@
-# Copyright 2021 Google, Inc.
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are
-# met: redistributions of source code must retain the above copyright
-# notice, this list of conditions and the following disclaimer;
-# redistributions in binary form must reproduce the above copyright
-# notice, this list of conditions and the following disclaimer in the
-# documentation and/or other materials provided with the distribution;
-# neither the name of the copyright holders nor the names of its
-# contributors may be used to endorse or promote products derived from
-# this software without specific prior written permission.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-import sys
-
-from code_formatter import code_formatter
-
-if len(sys.argv) < 2:
- print(f"Usage: {sys.argv[0]} CXX_CONFIG_INIT_CC [simobject]...",
- file=sys.stderr)
- sys.exit(1)
-
-cc = sys.argv[1]
-sim_objects = sys.argv[2:]
-
-code = code_formatter()
-
-for sim_object in sim_objects:
- code('#include "cxx_config/${sim_object}.hh"')
-
-code('''
-namespace gem5
-{
-
-void
-cxxConfigInit()
-{
-''')
-
-code.indent()
-for sim_object in sim_objects:
- code('cxx_config_directory["${sim_object}"] = '
- '${sim_object}CxxConfigParams::makeDirectoryEntry();')
-code.dedent()
-
-code('''
-}
-
-} // namespace gem5
-''')
-
-code.write(cc)
--
To view, visit https://gem5-review.googlesource.com/c/public/gem5/+/49455
To unsubscribe, or for help writing mail filters, visit
https://gem5-review.googlesource.com/settings
Gerrit-Project: public/gem5
Gerrit-Branch: develop
Gerrit-Change-Id: Iaa913fbe5af1b11d90ca618e29420eeb7cb0faed
Gerrit-Change-Number: 49455
Gerrit-PatchSet: 1
Gerrit-Owner: Gabe Black <[email protected]>
Gerrit-MessageType: newchange
_______________________________________________
gem5-dev mailing list -- [email protected]
To unsubscribe send an email to [email protected]
%(web_page_url)slistinfo%(cgiext)s/%(_internal_name)s
