Reduce build time by suppressing template instantiation #1419

shouth · 2024-10-10T06:58:06Z

Description

Abstract

This PR reduces the build time of openscenario_interpreter by suppressing heavy template instantiation.

Background

openscenario_interpreter heavily relies on templated components. These components are typically instantiated and optimized per translation unit, which can lead to longer build times.

Details

Added several explicit instantiations to readAttribute and moved the substitute() function used internally to the cpp file. No changes were made to the algorithm itself.

Added several explicit instantiations to readElement. Additionally, the choice() function was made non-template and its implementation was moved to the cpp file. No changes were made to the algorithm itself. Due to this change, the arguments of the choice() function have changed from "variadic arguments of std::pair" to "std::unordered_map," resulting in a slight modification in how the arguments are described in the places where choice() is called. Most of the changes in the diffs are due to this modification.

Removed the template specialization declarations in DistanceCondition / RelativeDistanceCondition. There are no impacts on other classes due to this change. With the removal of the declarations, the implementation of the distance() function has been moved after the specialization.

References

N/A

Destructive Changes

N/A

Known Limitations

N/A

…late-instantiation

github-actions · 2024-10-10T06:58:20Z

Checklist for reviewers ☑️

All references to "You" in the following text refer to the code reviewer.

Is this pull request written in a way that is easy to read from a third-party perspective?
Is there sufficient information (background, purpose, specification, algorithm description, list of disruptive changes, and migration guide) in the description of this pull request?
If this pull request contains a destructive change, does this pull request contain the migration guide?
Labels of this pull request are valid?
All unit tests/integration tests are included in this pull request? If you think adding test cases is unnecessary, please describe why and cross out this line.
The documentation for this pull request is enough? If you think adding documents for this pull request is unnecessary, please describe why and cross out this line.

…late-instantiation

sonarcloud · 2024-10-24T04:06:52Z

Quality Gate passed

Issues
18 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

yamacir-kit · 2024-10-25T01:47:35Z

openscenario/openscenario_interpreter/CMakeLists.txt

@@ -54,11 +54,13 @@ ament_export_include_directories(${boost_json_SOURCE_DIR}/include)
 file(GLOB ${PROJECT_NAME}_POSIX_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/src/posix/*.cpp)
 file(GLOB ${PROJECT_NAME}_SYNTAX_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/src/syntax/*.cpp)
 file(GLOB ${PROJECT_NAME}_UTILITY_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/src/utility/*.cpp)
+file(GLOB ${PROJECT_NAME}_READER_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/src/reader/*.cpp)


Please sort in lexicographic order unless there is a technical reason not to.

yamacir-kit · 2024-10-25T01:47:43Z

openscenario/openscenario_interpreter/CMakeLists.txt


 ament_auto_add_library(${PROJECT_NAME} SHARED
  ${${PROJECT_NAME}_POSIX_SOURCES}
  ${${PROJECT_NAME}_SYNTAX_SOURCES}
  ${${PROJECT_NAME}_UTILITY_SOURCES}
+  ${${PROJECT_NAME}_READER_SOURCES}


Please sort in lexicographic order unless there is a technical reason not to.

yamacir-kit · 2024-10-25T01:50:03Z

openscenario/openscenario_interpreter/include/openscenario_interpreter/reader/attribute.hpp

-}
+inline namespace reader
+{
+auto substitute(std::string attribute, const Scope & scope) -> String;


Suggested change

auto substitute(std::string attribute, const Scope & scope) -> String;

auto substitute(const std::string & attribute, const Scope & scope) -> String;

yamacir-kit · 2024-10-25T01:51:06Z

openscenario/openscenario_interpreter/include/openscenario_interpreter/reader/attribute.hpp

@@ -177,5 +133,4 @@ auto readAttribute(const std::string & name, const Node & node, const Scope & sc
 }
 }  // namespace reader
 }  // namespace openscenario_interpreter


Suggested change

} // namespace openscenario_interpreter

} // namespace openscenario_interpreter

yamacir-kit · 2024-10-25T01:51:55Z

openscenario/openscenario_interpreter/include/openscenario_interpreter/reader/attribute.hpp

+extern template auto readAttribute(const std::string &, const pugi::xml_node &, const Scope &)
+  -> Boolean;
+extern template auto readAttribute(const std::string &, const pugi::xml_node &, const Scope &)
+  -> UnsignedShort;
+extern template auto readAttribute(const std::string &, const pugi::xml_node &, const Scope &)
+  -> UnsignedInteger;
+extern template auto readAttribute(const std::string &, const pugi::xml_node &, const Scope &)
+  -> Double;
+extern template auto readAttribute(const std::string &, const pugi::xml_node &, const Scope &)
+  -> String;
+extern template auto readAttribute(const std::string &, const pugi::xml_node &, const Scope &)
+  -> syntax::Rule;


Please sort in lexicographic order unless there is a technical reason not to.

yamacir-kit · 2024-10-25T01:52:13Z

openscenario/openscenario_interpreter/include/openscenario_interpreter/reader/element.hpp

@@ -36,6 +36,17 @@

 namespace openscenario_interpreter
 {
+


Suggested change

yamacir-kit · 2024-10-25T01:53:03Z

openscenario/openscenario_interpreter/include/openscenario_interpreter/reader/element.hpp

+auto choice(
+  const pugi::xml_node & node,
+  std::unordered_map<std::string, std::function<Object(const pugi::xml_node &)>> callees) -> Object;


Suggested change

auto choice(

const pugi::xml_node & node,

std::unordered_map<std::string, std::function<Object(const pugi::xml_node &)>> callees) -> Object;

auto choice(

const pugi::xml_node & node,

const std::unordered_map<std::string, std::function<Object(const pugi::xml_node &)>> & callees) -> Object;

yamacir-kit · 2024-10-25T01:53:45Z

openscenario/openscenario_interpreter/src/reader/attribute.cpp

+{
+inline namespace reader
+{
+auto substitute(std::string attribute, const Scope & scope) -> String


Suggested change

auto substitute(std::string attribute, const Scope & scope) -> String

auto substitute(const std::string & attribute, const Scope & scope) -> String

yamacir-kit · 2024-10-25T01:54:19Z

openscenario/openscenario_interpreter/src/reader/attribute.cpp

+template auto readAttribute(const std::string &, const pugi::xml_node &, const Scope &) -> Boolean;
+template auto readAttribute(const std::string &, const pugi::xml_node &, const Scope &)
+  -> UnsignedShort;
+template auto readAttribute(const std::string &, const pugi::xml_node &, const Scope &)
+  -> UnsignedInteger;
+template auto readAttribute(const std::string &, const pugi::xml_node &, const Scope &) -> Double;
+template auto readAttribute(const std::string &, const pugi::xml_node &, const Scope &) -> String;
+template auto readAttribute(const std::string &, const pugi::xml_node &, const Scope &)
+  -> syntax::Rule;


Please sort in lexicographic order unless there is a technical reason not to.

shouth added 12 commits September 17, 2024 18:15

Utilize extern template to make build faster

f9a953b

Add new sources to CMakeLists.txt

d4600c3

Remove unneccessary template specialization declaration

e136f89

Change choice() to be non-templated function

cc83724

Merge remote-tracking branch 'origin/master' into feature/faster-temp…

619bba6

…late-instantiation

Format

6e75007

Merge remote-tracking branch 'origin/master' into feature/faster-temp…

65edc60

…late-instantiation

Format comment

9ee8e98

Merge remote-tracking branch 'origin/master' into feature/faster-temp…

f12442d

…late-instantiation

Format comment

b3a5354

Add some extern template to make build faster

84f77bd

Make substitute() non-templated to make build faster

8fc9e2e

shouth self-assigned this Oct 10, 2024

shouth added bump patch If this pull request merged, bump patch version of the scenario_simulator_v2 wait for regression test labels Oct 10, 2024

shouth added 3 commits October 10, 2024 17:12

Add missing copyright notice

c47b8b3

Merge branch 'master' into feature/faster-template-instantiation

904fbfe

Merge remote-tracking branch 'origin/master' into feature/faster-temp…

2400904

…late-instantiation

shouth marked this pull request as ready for review October 24, 2024 07:00

yamacir-kit self-requested a review October 24, 2024 07:02

yamacir-kit requested changes Oct 25, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Reduce build time by suppressing template instantiation #1419

Reduce build time by suppressing template instantiation #1419

shouth commented Oct 10, 2024 •

edited

Loading

github-actions bot commented Oct 10, 2024

sonarcloud bot commented Oct 24, 2024

yamacir-kit Oct 25, 2024

yamacir-kit Oct 25, 2024

yamacir-kit Oct 25, 2024

yamacir-kit Oct 25, 2024

yamacir-kit Oct 25, 2024

yamacir-kit Oct 25, 2024

yamacir-kit Oct 25, 2024

yamacir-kit Oct 25, 2024

yamacir-kit Oct 25, 2024

	auto substitute(std::string attribute, const Scope & scope) -> String;
	auto substitute(const std::string & attribute, const Scope & scope) -> String;

	} // namespace openscenario_interpreter
	} // namespace openscenario_interpreter

Reduce build time by suppressing template instantiation #1419

Are you sure you want to change the base?

Reduce build time by suppressing template instantiation #1419

Conversation

shouth commented Oct 10, 2024 • edited Loading

Description

Abstract

Background

Details

References

Destructive Changes

Known Limitations

github-actions bot commented Oct 10, 2024

Checklist for reviewers ☑️

sonarcloud bot commented Oct 24, 2024

Quality Gate passed

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shouth commented Oct 10, 2024 •

edited

Loading