Add options to handle static and static runtime builds.#299

Draft

gautierbureau wants to merge 32 commits into

mainfrom

static_runtime_msvc

gautierbureau commented Mar 19, 2021 •

edited

Loading

Member

Signed-off-by: Gautier Bureau gautier.bureau@gmail.com

Please check if the PR fulfills these requirements (please use '[x]' to check the checkboxes, or submit the PR and then click the checkboxes)

The commit message follows our guidelines
Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)

What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
Enables to build only static/shared versions of the library and use static runtime on windows

What is the current behavior? (You can also link to an open issue here)
Static and shared versions are always built

What is the new behavior (if this is a feature change)?
Choose a specific version static/shared or both. Use a static boost library. Use static runtime on windows.

sebalaig and others added 26 commits

January 21, 2021 13:05


          Add substation in error message (#237)

e621f84

Signed-off-by: Sébastien LAIGRE <slaigre@silicom.fr>


          Make sure xml serializer is not null when writing extensions (#239)

Signed-off-by: Sébastien LAIGRE <slaigre@silicom.fr>


          Invalidate cache after an element is removed from NodeBreakerVoltageL…

7ffef53

…evel (#242) (#251)

Signed-off-by: Sébastien LAIGRE <slaigre@silicom.fr>


          Update current version to 1.4.0 (#252)

1ecaa31

Signed-off-by: Sébastien LAIGRE <slaigre@silicom.fr>


          [IIDM v1.4] Add ThreeWindingsTransformer::getLegs()

7ec5fe4

Signed-off-by: Sébastien LAIGRE <slaigre@silicom.fr>


          [IIDM v1.4] Aliases by type (#243) (#255)

3a08d4e

Signed-off-by: Sébastien LAIGRE <slaigre@silicom.fr>


          [IIDM v1.4] Add Extendable::getExtensionByName (#210) (#259)

f37484e


          [IIDM v1.4] Allow overwriting an existing variant (#209) (#263)

9b928fa

Signed-off-by: Sébastien LAIGRE <slaigre@silicom.fr>


          Remove unreached cmake code because required cmake version is 3.12 or…

f99900c

… higher (#264)

Signed-off-by: Sébastien LAIGRE <slaigre@silicom.fr>


          [IIDM v1.4.1] Usage of stdcxx::optional (#267)

538022a

* Always use stdcxx::optional instead of direct usage of boost::optional (#221)
* Use optional::operator() to check that an optional is set or not (#216)

Signed-off-by: Sébastien LAIGRE <slaigre@silicom.fr>


          [IIDM v1.4.1] Removal of parameters on defaulted/deleted special func…

5cafded

…tions (#220) (#268)

Signed-off-by: Sébastien LAIGRE <slaigre@silicom.fr>


          Call to direct parent's read method from xml parsers (#226) (#269)

8781b72

Signed-off-by: Sébastien LAIGRE <slaigre@silicom.fr>


          [IIDM v1.4.1] Rename stdcxx::reference_wrapper into stdcxx::Reference (…

d749cf1

…#228) (#266)

Signed-off-by: Sébastien LAIGRE <slaigre@silicom.fr>


          Refactor powsybl::iidm::util (#222) (#270)

3ccb3a2

Signed-off-by: Sébastien LAIGRE <slaigre@silicom.fr>


          Refactoring XML read/write of a Network API (#273)

2dea989

Signed-off-by: Sébastien LAIGRE <slaigre@silicom.fr>
Signed-off-by: Mathieu BAGUE <mathieu.bague@rte-france.com>


          Add option to disable unit tests build (#184) (#274)

f10cb4f

Signed-off-by: Sébastien LAIGRE <slaigre@silicom.fr>


          Pass unique_ptr as parameters by rvalue to functions (#234) (#275)

Signed-off-by: Sébastien LAIGRE <slaigre@silicom.fr>


          Fix CI (boost not avaible on github actions) (#278)

b0aa032

Signed-off-by: Sébastien LAIGRE <slaigre@silicom.fr>
Signed-off-by: Mathieu BAGUE <mathieu.bague@rte-france.com>


          [IIDM v1.4] Add SimpleAnonymizer (#71) (#271)

1eeccab

Signed-off-by: Sébastien LAIGRE <slaigre@silicom.fr>


          [IIDM v1.4] Add AbstractTerminalTopologyVisitor (#240) (#272)

b7f6932

Signed-off-by: Sébastien LAIGRE <slaigre@silicom.fr>
Signed-off-by: Mathieu BAGUE <mathieu.bague@rte-france.com>


          fix node/breaker voltage level connect/disconnect for internal connec…

bdc6968

…tions (#281)

Signed-off-by: Luma <zamarrenolm@aia.es>
Signed-off-by: Mathieu BAGUE <mathieu.bague@rte-france.com>


          Fix CI: invoke apt-get update before installing boost (#287)

5a7aa5b

Signed-off-by: Sébastien LAIGRE <slaigre@silicom.fr>


          [IIDM v1.4] Add ThreadLocalMultipleVariantContext (#183) (#277)

a34a16a

Signed-off-by: Sébastien LAIGRE <slaigre@silicom.fr>


          Add four substations node breaker factory (#276) (#286)

fb284d6

Signed-off-by: Sébastien LAIGRE <slaigre@silicom.fr>


          Cosmetic: fix methods order (#289)

01f6b3c

Signed-off-by: Sébastien LAIGRE <slaigre@silicom.fr>


          Iso APIs: backport missing methods (#284)

* Add Bus::getP() and Bus::getQ()
* Add Network::getCountries()
* Rename HvdcLine::*NominalVoltage into HvdcLine::*NominalV
* Rename getNominalVoltage into getNominalV and setNominalVoltage into setNominalV

Signed-off-by: Sébastien LAIGRE <slaigre@silicom.fr>

gautierbureau force-pushed the static_runtime_msvc branch 4 times, most recently from 20039c8 to 02592f6 Compare

March 19, 2021 13:36

gautierbureau and others added 2 commits

March 19, 2021 14:42


          Add option to disable tools build.

9df3438

Signed-off-by: Gautier Bureau <gautier.bureau@gmail.com>


          Add Substation::remove() (#283)

c50b0aa

Signed-off-by: Sébastien LAIGRE <slaigre@silicom.fr>

mathbagu force-pushed the static_runtime_msvc branch from 02592f6 to 31918be Compare

March 19, 2021 20:56

mathbagu reviewed

View reviewed changes

CMakeLists.txt

                   set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /wd4244 /wd4250 /wd4251 /wd4267 /wd4275")
+                  if (NOT BUILD_SHARED_LIBS AND BUILD_STATIC_LIBS)
+                      if (MSVC_STATIC_RUNTIME_LIBRARY)
+                          set(CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>")

mathbagu Mar 22, 2021

This variable has been added in cmake v3.15 (https://cmake.org/cmake/help/git-stage/variable/CMAKE_MSVC_RUNTIME_LIBRARY.html). Is there an equivalent for older version?

CMakeLists.txt Outdated

+              else ()
+                  set(Boost_USE_STATIC_LIBS OFF)
+                  set(Boost_USE_STATIC_RUNTIME OFF)
+              endif ()

mathbagu Mar 22, 2021

I propose to set Boost_USE_STATIC_RUNTIME according to the value of MSVC_STATIC_RUNTIME_LIBRARY even if BOOST_STATIC_LIBS is not set.

set(Boost_USE_STATIC_LIBS ${BOOST_STATIC_LIBS})
set(Boost_USE_STATIC_RUNTIME ${MSVC_STATIC_RUNTIME_LIBRARY})

gautierbureau Apr 2, 2021

Member Author

done

CMakeLists.txt Outdated

+              option(BUILD_SHARED_LIBS "Enable/disable build of shared libraries." ON)
+              option(BUILD_SHARED_EXTENSIONS "Enable/disable build of shared extensions." ON)
+              option(BUILD_STATIC_LIBS "Enable/disable build of static libraries." ON)
+              option(BUILD_STATIC_EXTENSIONS "Enable/disable build of static extensions." ON)

mathbagu Mar 22, 2021

It's arguable, but I think we should not allow people to mix static and dynamic libraries. I propose to keep only BUILD_SHARED_LIBS and BUILD_STATIC_LIBS. I wonder if we should add an option for each extension library

CMakeLists.txt

+              if (BOOST_STATIC_LIBS AND BUILD_SHARED_LIBS)
+                  set(BOOST_STATIC_LIBS OFF)
+                  message(WARNING "BOOST_STATIC_LIBS disabled if you want to build shared libraries. Use this option with BUILD_SHARED_LIBS=OFF")
+              endif ()

mathbagu Mar 22, 2021

I would raise an error in that case instead of making an arbitrary choice.

gautierbureau Apr 2, 2021

Member Author

done

CMakeLists.txt Outdated

+              if (BUILD_TESTS AND NOT BUILD_SHARED_LIBS)
+                  message(FATAL_ERROR "BUILD_TESTS is ON but BUILD_SHARED_LIBS is OFF, you should turn ON BUILD_SHARED_LIBS or turn off BUILD_TESTS.")
+              endif ()

mathbagu Mar 22, 2021

Maybe we have to do something similar for the examples. Maybe we can find a way to link the examples and the tests to the IIDM library, using a postfix for example (empty or -static).

mathbagu added the PR: waiting-for-info-author label

Mathieu BAGUE and others added 3 commits

March 25, 2021 07:11


          Link extensions static libraries with iidm-static

a65cddc

Signed-off-by: Mathieu BAGUE <mathieu.bague@rte-france.com>


          Make registerExtension public (#303)

d84e4a4

* Make registerExtension public
* Add an example to show how to use an XIIDM extension

Signed-off-by: Mathieu BAGUE <mathieu.bague@rte-france.com>


          Add options to handle static and static runtime builds.

acc3995

Signed-off-by: Gautier Bureau <gautier.bureau@gmail.com>

gautierbureau force-pushed the static_runtime_msvc branch from 31918be to 7a7da82 Compare

April 7, 2021 13:02


          Corrections after review of handle of static/shared compilation.

3b81bdc

Signed-off-by: Gautier Bureau <gautier.bureau@gmail.com>

gautierbureau force-pushed the static_runtime_msvc branch from 7a7da82 to 3b81bdc Compare

April 7, 2021 13:12

gautierbureau added PR: do-not-merge and removed PR: waiting-for-info-author labels

gautierbureau commented Apr 7, 2021 •

edited

Loading

Member Author

Following a discussion with @mathbagu this PR will be put on hold indefinitely. Some conclusions on the proposed solution and future work that could be bone:

as it is now the unit tests can now be launched with a static or shared build but with separate cmake build directories. Previously unit tests were only tested against the shared versions of the library.
One issue with the proposed solutions is that the methods ExtensionProviders::loadExtensions and ExtensionProviders::loadLibrary are not tested anymore because the class ExtensionFixture is not used anymore to load extensions but rather the registerExtensionmethod is used.
Following the two previous issues we stated that unit tests should be launched in static and shared versions in the same cmake build and that there should be distinct target to test them to have code compiled in one version of the target and not the other. For exemple for the shared unit tests ExtensionFixture should still be used and for the the static version a new class similar to what it is proposed here should be used to registerExtension.

gautierbureau marked this pull request as draft

April 7, 2021 13:27

gautierbureau requested review from mathbagu and removed request for mathbagu

April 7, 2021 13:27

sonarqubecloud Bot commented Apr 7, 2021

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

mathbagu changed the base branch from integration/v1.4.0 to integration/v1.5.0

April 12, 2021 10:11

Base automatically changed from integration/v1.5.0 to main

January 10, 2022 10:36

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

PR: do-not-merge