pythonfmu3 0.3.3__py3-none-any.whl → 1.0.0__py3-none-any.whl

pythonfmu3/pythonfmu-export/generate_shim.py

@@ -0,0 +1,88 @@
+"""Generate src/shim/fmi3_forwarders.cpp from src/fmi/fmi3FunctionTypes.h.
+
+The shim is the library the importer loads on Linux/macOS. It has no link-time
+dependency on libpython: on instantiation it loads libpython (unless the host process
+already provides it, e.g. when the importer is itself written in Python) and then the
+real implementation (the "backend" library), and forwards every FMI call to it.
+
+Re-run this script after updating the FMI headers:
+    python generate_shim.py
+"""
+import re
+from pathlib import Path
+
+HERE = Path(__file__).parent
+TYPES_HEADER = HERE / "src" / "fmi" / "fmi3FunctionTypes.h"
+OUTPUT = HERE / "src" / "shim" / "fmi3_forwarders.cpp"
+
+TYPEDEF_RE = re.compile(r"typedef\s+([\w\s\*]+?)\s*\b(fmi3\w+)TYPE\s*\((.*?)\)\s*;", re.S)
+INSTANTIATE = {
+    "fmi3InstantiateModelExchange",
+    "fmi3InstantiateCoSimulation",
+    "fmi3InstantiateScheduledExecution",
+}
+
+
+def param_names(params: str):
+    params = " ".join(params.split())
+    if params in ("", "void"):
+        return []
+    return [re.findall(r"\w+", p.replace("[]", ""))[-1] for p in params.split(",")]
+
+
+def main():
+    functions = [
+        (" ".join(ret.split()), name, " ".join(params.split()))
+        for ret, name, params in TYPEDEF_RE.findall(TYPES_HEADER.read_text())
+    ]
+    forwarded = [f for f in functions if f[1] != "fmi3GetVersion"]
+
+    out = [
+        "// GENERATED by generate_shim.py from fmi/fmi3FunctionTypes.h - do not edit by hand.",
+        '#include "shim/shim_loader.hpp"',
+        "",
+        "namespace pythonfmu_shim",
+        "{",
+        "const char* const kFunctionNames[] = {",
+        *[f'    "{name}",' for _, name, _ in forwarded],
+        "};",
+        f"const std::size_t kFunctionCount = {len(forwarded)};",
+        "} // namespace pythonfmu_shim",
+        "",
+        'extern "C" {',
+        "",
+        "FMI3_Export const char* fmi3GetVersion(void)",
+        "{",
+        "    return fmi3Version;",
+        "}",
+        "",
+    ]
+    for index, (ret, name, params) in enumerate(forwarded):
+        names = param_names(params)
+        args = ", ".join(names)
+        out.append(f"FMI3_Export {ret} {name}({params})")
+        out.append("{")
+        if name in INSTANTIATE:
+            out.append(
+                "    if (!pythonfmu_shim::ensureBackendLoaded(resourcePath, instanceEnvironment, logMessage)) return nullptr;"
+            )
+        out.append(f"    const auto fn = reinterpret_cast<{name}TYPE*>(pythonfmu_shim::function({index}));")
+        if ret == "void":
+            out.append(f"    if (fn) fn({args});")
+        elif ret == "fmi3Status":
+            out.append("    if (!fn) return fmi3Error;")
+            out.append(f"    return fn({args});")
+        else:
+            out.append("    if (!fn) return nullptr;")
+            out.append(f"    return fn({args});")
+        out.append("}")
+        out.append("")
+    out.append('} // extern "C"')
+    out.append("")
+    OUTPUT.parent.mkdir(exist_ok=True)
+    OUTPUT.write_text("\n".join(out))
+    print(f"wrote {OUTPUT.relative_to(HERE)} ({len(functions)} functions)")
+
+
+if __name__ == "__main__":
+    main()

pythonfmu3/pythonfmu-export/src/CMakeLists.txt

@@ -1,4 +1,3 @@
-
 set(headers
         cppfmu/cppfmu_cs.hpp
         cppfmu/cppfmu_common.hpp
@@ -17,29 +16,58 @@ set(sources
         pythonfmu/PySlaveInstance.cpp
         )
 
-add_library(pythonfmu-export ${sources} ${headers})
-target_compile_features(pythonfmu-export PUBLIC "cxx_std_17")
+set(BINARY_OUTPUT_DIR "${CMAKE_SOURCE_DIR}/../resources/binaries/${TARGET_PLATFORM}")
 
-target_include_directories(pythonfmu-export
+if (WIN32)
+  # Windows: a single library, linked against the version-independent python3.dll.
+  set(PYTHONFMU_IMPL_TARGET pythonfmu-export)
+else ()
+  # Linux/macOS: the Python-dependent implementation lives in a "backend" library
+  # (FMI functions renamed with a prefix). The FMU library itself (pythonfmu-export,
+  # renamed to <modelIdentifier> by the builder) is a small shim with no link-time
+  # dependency on libpython, so non-Python importers can load it. See shim/shim_loader.cpp.
+  set(PYTHONFMU_IMPL_TARGET pythonfmu-backend)
+endif ()
+
+add_library(${PYTHONFMU_IMPL_TARGET} ${sources} ${headers})
+target_compile_features(${PYTHONFMU_IMPL_TARGET} PUBLIC "cxx_std_17")
+target_include_directories(${PYTHONFMU_IMPL_TARGET}
         PRIVATE
         "${Python3_INCLUDE_DIRS}"
         "${CMAKE_CURRENT_SOURCE_DIR}"
         )
 
 if (WIN32)
-  target_link_libraries(pythonfmu-export PRIVATE ${Python3_LIBRARIES})
-elseif (APPLE)
-  set_target_properties(pythonfmu-export PROPERTIES LINK_FLAGS "-undefined dynamic_lookup")
-endif ()
-
-if (WIN32)
-  set_target_properties(pythonfmu-export
+  target_link_libraries(${PYTHONFMU_IMPL_TARGET} PRIVATE ${Python3_LIBRARIES})
+  set_target_properties(${PYTHONFMU_IMPL_TARGET}
           PROPERTIES
-          RUNTIME_OUTPUT_DIRECTORY_RELEASE "${CMAKE_SOURCE_DIR}/../resources/binaries/${TARGET_PLATFORM}"
+          RUNTIME_OUTPUT_DIRECTORY_RELEASE "${BINARY_OUTPUT_DIR}"
           )
 else ()
+  # Python symbols are resolved at load time against the process (the host Python, or
+  # the libpython the shim opened with RTLD_GLOBAL).
+  target_compile_definitions(${PYTHONFMU_IMPL_TARGET} PRIVATE FMI3_FUNCTION_PREFIX=pythonfmu_backend_)
+  if (APPLE)
+    set_target_properties(${PYTHONFMU_IMPL_TARGET} PROPERTIES LINK_FLAGS "-undefined dynamic_lookup")
+  endif ()
+  set_target_properties(${PYTHONFMU_IMPL_TARGET}
+          PROPERTIES
+          LIBRARY_OUTPUT_DIRECTORY "${BINARY_OUTPUT_DIR}"
+          )
+
+  add_library(pythonfmu-export
+          shim/shim_loader.cpp
+          shim/shim_loader.hpp
+          shim/fmi3_forwarders.cpp
+          )
+  target_compile_features(pythonfmu-export PUBLIC "cxx_std_17")
+  target_include_directories(pythonfmu-export PRIVATE "${CMAKE_CURRENT_SOURCE_DIR}")
+  target_link_libraries(pythonfmu-export PRIVATE ${CMAKE_DL_LIBS})
   set_target_properties(pythonfmu-export
           PROPERTIES
-          LIBRARY_OUTPUT_DIRECTORY "${CMAKE_SOURCE_DIR}/../resources/binaries/${TARGET_PLATFORM}"
+          LIBRARY_OUTPUT_DIRECTORY "${BINARY_OUTPUT_DIR}"
+          # Only the FMI functions (marked FMI3_Export) are exported
+          CXX_VISIBILITY_PRESET hidden
+          VISIBILITY_INLINES_HIDDEN ON
           )
 endif ()

pythonfmu3/pythonfmu-export/src/cppfmu/cppfmu_common.hpp

@@ -121,6 +121,9 @@ public:
         FMIString message,
         Args&&... args) CPPFMU_NOEXCEPT
     {
+        if (m_fmiLogger == nullptr) {
+            return; // FMI 3.0 allows instantiating without a logger callback
+        }
         if (m_settings->loggedCategories.empty() ||
             detail::CanFind(m_settings->loggedCategories, category)) {
             m_fmiLogger(

pythonfmu3/pythonfmu-export/src/cppfmu/cppfmu_cs.cpp

@@ -66,7 +66,8 @@ void SlaveInstance::SetFloat64(
 void SlaveInstance::SetInt32(
     const FMIValueReference /*vr*/[],
     std::size_t nvr,
-    const FMIInt32 /*value*/[])
+    const FMIInt32 /*value*/[],
+    std::size_t nValues)
 {
     if (nvr != 0) {
         throw std::logic_error("Attempted to set nonexistent variable");
@@ -76,7 +77,8 @@ void SlaveInstance::SetInt32(
 void SlaveInstance::SetInt64(
     const FMIValueReference /*vr*/[],
     std::size_t nvr,
-    const FMIInt64 /*value*/[])
+    const FMIInt64 /*value*/[],
+    std::size_t nValues)
 {
     if (nvr != 0) {
         throw std::logic_error("Attempted to set nonexistent variable");
@@ -86,7 +88,8 @@ void SlaveInstance::SetInt64(
 void SlaveInstance::SetUInt64(
     const FMIValueReference /*vr*/[],
     std::size_t nvr,
-    const FMIUInt64 /*value*/[])
+    const FMIUInt64 /*value*/[],
+    std::size_t nValues)
 {
     if (nvr != 0) {
         throw std::logic_error("Attempted to set nonexistent variable");
@@ -97,7 +100,8 @@ void SlaveInstance::SetUInt64(
 void SlaveInstance::SetBoolean(
     const FMIValueReference /*vr*/[],
     std::size_t nvr,
-    const FMIBoolean /*value*/[])
+    const FMIBoolean /*value*/[],
+    std::size_t nValues)
 {
     if (nvr != 0) {
         throw std::logic_error("Attempted to set nonexistent variable");
@@ -108,7 +112,8 @@ void SlaveInstance::SetBoolean(
 void SlaveInstance::SetString(
     const FMIValueReference /*vr*/[],
     std::size_t nvr,
-    const FMIString /*value*/[])
+    const FMIString /*value*/[],
+    std::size_t nValues)
 {
     if (nvr != 0) {
         throw std::logic_error("Attempted to set nonexistent variable");
@@ -131,7 +136,8 @@ void SlaveInstance::GetFloat64(
 void SlaveInstance::GetInt32(
     const FMIValueReference /*vr*/[],
     std::size_t nvr,
-    FMIInt32 /*value*/[]) const
+    FMIInt32 /*value*/[],
+    std::size_t nValues) const
 {
     if (nvr != 0) {
         throw std::logic_error("Attempted to get nonexistent variable");
@@ -142,7 +148,8 @@ void SlaveInstance::GetInt32(
 void SlaveInstance::GetInt64(
     const FMIValueReference /*vr*/[],
     std::size_t nvr,
-    FMIInt64 /*value*/[]) const
+    FMIInt64 /*value*/[],
+    std::size_t nValues) const
 {
     if (nvr != 0) {
         throw std::logic_error("Attempted to get nonexistent variable");
@@ -153,7 +160,8 @@ void SlaveInstance::GetInt64(
 void SlaveInstance::GetUInt64(
     const FMIValueReference /*vr*/[],
     std::size_t nvr,
-    FMIUInt64 /*value*/[]) const
+    FMIUInt64 /*value*/[],
+    std::size_t nValues) const
 {
     if (nvr != 0) {
         throw std::logic_error("Attempted to get nonexistent variable");
@@ -164,7 +172,8 @@ void SlaveInstance::GetUInt64(
 void SlaveInstance::GetBoolean(
     const FMIValueReference /*vr*/[],
     std::size_t nvr,
-    FMIBoolean /*value*/[]) const
+    FMIBoolean /*value*/[],
+    std::size_t nValues) const
 {
     if (nvr != 0) {
         throw std::logic_error("Attempted to set nonexistent variable");
@@ -175,7 +184,8 @@ void SlaveInstance::GetBoolean(
 void SlaveInstance::GetString(
     const FMIValueReference /*vr*/[],
     std::size_t nvr,
-    FMIString /*value*/[]) const
+    FMIString /*value*/[],
+    std::size_t nValues) const
 {
     if (nvr != 0) {
         throw std::logic_error("Attempted to set nonexistent variable");

pythonfmu3/pythonfmu-export/src/cppfmu/cppfmu_cs.hpp

@@ -76,23 +76,28 @@ public:
     virtual void SetInt32(
         const FMIValueReference vr[],
         std::size_t nvr,
-        const FMIInt32 value[]);
+        const FMIInt32 value[],
+        std::size_t nValues);
     virtual void SetInt64(
         const FMIValueReference vr[],
         std::size_t nvr,
-        const FMIInt64 value[]);
+        const FMIInt64 value[],
+        std::size_t nValues);
     virtual void SetUInt64(
         const FMIValueReference vr[],
         std::size_t nvr,
-        const FMIUInt64 value[]);
+        const FMIUInt64 value[],
+        std::size_t nValues);
     virtual void SetBoolean(
         const FMIValueReference vr[],
         std::size_t nvr,
-        const FMIBoolean value[]);
+        const FMIBoolean value[],
+        std::size_t nValues);
     virtual void SetString(
         const FMIValueReference vr[],
         std::size_t nvr,
-        const FMIString value[]);
+        const FMIString value[],
+        std::size_t nValues);
 
     /* Called from fmi3GetXxx()/fmiGetXxx().
      * Throws std::logic_error by default.
@@ -105,23 +110,28 @@ public:
     virtual void GetInt32(
         const FMIValueReference vr[],
         std::size_t nvr,
-        FMIInt32 value[]) const;
+        FMIInt32 value[],
+        std::size_t nValues) const;
     virtual void GetInt64(
         const FMIValueReference vr[],
         std::size_t nvr,
-        FMIInt64 value[]) const;
+        FMIInt64 value[],
+        std::size_t nValues) const;
     virtual void GetUInt64(
         const FMIValueReference vr[],
         std::size_t nvr,
-        FMIUInt64 value[]) const;
+        FMIUInt64 value[],
+        std::size_t nValues) const;
     virtual void GetBoolean(
         const FMIValueReference vr[],
         std::size_t nvr,
-        FMIBoolean value[]) const;
+        FMIBoolean value[],
+        std::size_t nValues) const;
     virtual void GetString(
         const FMIValueReference vr[],
         std::size_t nvr,
-        FMIString value[]) const;
+        FMIString value[],
+        std::size_t nValues) const;
 
     // Called from fmi3DoStep()/fmiDoStep(). Must be implemented in model code.
     virtual FMIStatus DoStep(

pythonfmu3/pythonfmu-export/src/cppfmu/fmi_functions.cpp

@@ -95,7 +95,8 @@ fmi3Instance fmi3InstantiateCoSimulation(
     fmi3IntermediateUpdateCallback intermediateUpdate )
 {
     try {
-        auto component = new Component(
+        // Owned until fully constructed, so a failing instantiation does not leak it.
+        auto component = std::make_unique<Component>(
             environment,
             logMessage,
             loggingOn);
@@ -108,7 +109,7 @@ fmi3Instance fmi3InstantiateCoSimulation(
             visible,
             cppfmu::FMIFalse,
             component->logger);
-        return component;
+        return component.release();
     } catch (const cppfmu::FatalError& e) {
         if (logMessage)
         {
@@ -134,7 +135,8 @@ fmi3Instance fmi3InstantiateModelExchange(
     fmi3LogMessageCallback     logMessage)
 {
     try {
-        auto component = new Component(
+        // Owned until fully constructed, so a failing instantiation does not leak it.
+        auto component = std::make_unique<Component>(
             environment,
             logMessage,
             loggingOn);
@@ -147,7 +149,7 @@ fmi3Instance fmi3InstantiateModelExchange(
             visible,
             cppfmu::FMIFalse,
             component->logger);
-        return component;
+        return component.release();
     } catch (const cppfmu::FatalError& e) {
         if (logMessage)
         {
@@ -334,7 +336,7 @@ fmi3Status fmi3GetInt32(
 {
     const auto component = reinterpret_cast<Component*>(c);
     try {
-        component->slave->GetInt32(vr, nvr, values);
+        component->slave->GetInt32(vr, nvr, values, nValues);
         return fmi3OK;
     } catch (const cppfmu::FatalError& e) {
         component->logger.Log(fmi3Fatal, "", e.what());
@@ -354,7 +356,7 @@ fmi3Status fmi3GetInt64(
 {
     const auto component = reinterpret_cast<Component*>(c);
     try {
-        component->slave->GetInt64(vr, nvr, values);
+        component->slave->GetInt64(vr, nvr, values, nValues);
         return fmi3OK;
     } catch (const cppfmu::FatalError& e) {
         component->logger.Log(fmi3Fatal, "", e.what());
@@ -374,7 +376,7 @@ fmi3Status fmi3GetUInt64(
 {
     const auto component = reinterpret_cast<Component*>(c);
     try {
-        component->slave->GetUInt64(vr, nvr, values);
+        component->slave->GetUInt64(vr, nvr, values, nValues);
         return fmi3OK;
     } catch (const cppfmu::FatalError& e) {
         component->logger.Log(fmi3Fatal, "", e.what());
@@ -394,7 +396,7 @@ fmi3Status fmi3GetBoolean(
 {
     const auto component = reinterpret_cast<Component*>(c);
     try {
-        component->slave->GetBoolean(vr, nvr, values);
+        component->slave->GetBoolean(vr, nvr, values, nValues);
         return fmi3OK;
     } catch (const cppfmu::FatalError& e) {
         component->logger.Log(fmi3Fatal, "", e.what());
@@ -414,7 +416,7 @@ fmi3Status fmi3GetString(
 {
     const auto component = reinterpret_cast<Component*>(c);
     try {
-        component->slave->GetString(vr, nvr, values);
+        component->slave->GetString(vr, nvr, values, nValues);
         return fmi3OK;
     } catch (const cppfmu::FatalError& e) {
         component->logger.Log(fmi3Fatal, "", e.what());
@@ -455,7 +457,7 @@ fmi3Status fmi3SetInt32(
 {
     const auto component = reinterpret_cast<Component*>(c);
     try {
-        component->slave->SetInt32(vr, nvr, values);
+        component->slave->SetInt32(vr, nvr, values, nValues);
         return fmi3OK;
     } catch (const cppfmu::FatalError& e) {
         component->logger.Log(fmi3Fatal, "", e.what());
@@ -475,7 +477,7 @@ fmi3Status fmi3SetInt64(
 {
     const auto component = reinterpret_cast<Component*>(c);
     try {
-        component->slave->SetInt64(vr, nvr, values);
+        component->slave->SetInt64(vr, nvr, values, nValues);
         return fmi3OK;
     } catch (const cppfmu::FatalError& e) {
         component->logger.Log(fmi3Fatal, "", e.what());
@@ -495,7 +497,7 @@ fmi3Status fmi3SetUInt64(
 {
     const auto component = reinterpret_cast<Component*>(c);
     try {
-        component->slave->SetUInt64(vr, nvr, values);
+        component->slave->SetUInt64(vr, nvr, values, nValues);
         return fmi3OK;
     } catch (const cppfmu::FatalError& e) {
         component->logger.Log(fmi3Fatal, "", e.what());
@@ -515,7 +517,7 @@ fmi3Status fmi3SetBoolean(
 {
     const auto component = reinterpret_cast<Component*>(c);
     try {
-        component->slave->SetBoolean(vr, nvr, values);
+        component->slave->SetBoolean(vr, nvr, values, nValues);
         return fmi3OK;
     } catch (const cppfmu::FatalError& e) {
         component->logger.Log(fmi3Fatal, "", e.what());
@@ -535,7 +537,7 @@ fmi3Status fmi3SetString(
 {
     const auto component = reinterpret_cast<Component*>(c);
     try {
-        component->slave->SetString(vr, nvr, values);
+        component->slave->SetString(vr, nvr, values, nValues);
         return fmi3OK;
     } catch (const cppfmu::FatalError& e) {
         component->logger.Log(fmi3Fatal, "", e.what());