]> gerrit.simantics Code Review - simantics/fmil.git/blobdiff - org.simantics.fmil.core/native/FMILibrary/src/Import/src/FMI2/fmi2_import_capi.c
Add FMILibrary-2.0.3 to org.simantics.fmil.core\native.
[simantics/fmil.git] / org.simantics.fmil.core / native / FMILibrary / src / Import / src / FMI2 / fmi2_import_capi.c
diff --git a/org.simantics.fmil.core/native/FMILibrary/src/Import/src/FMI2/fmi2_import_capi.c b/org.simantics.fmil.core/native/FMILibrary/src/Import/src/FMI2/fmi2_import_capi.c
new file mode 100644 (file)
index 0000000..e794775
--- /dev/null
@@ -0,0 +1,384 @@
+/*
+    Copyright (C) 2012 Modelon AB
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the BSD style license.
+
+     This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    FMILIB_License.txt file for more details.
+
+    You should have received a copy of the FMILIB_License.txt file
+    along with this program. If not, contact Modelon AB <http://www.modelon.com>.
+*/
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include <stdio.h>
+#include <errno.h>
+#include <FMI2/fmi2_types.h>
+#include <FMI2/fmi2_functions.h>
+#include <FMI2/fmi2_enums.h>\r
+#include <FMI2/fmi2_capi.h>
+#include <FMI/fmi_util.h>
+#include "fmi2_import_impl.h"
+
+static const char * module = "FMILIB";
+
+/* Load and destroy functions */
+jm_status_enu_t fmi2_import_create_dllfmu(fmi2_import_t* fmu, fmi2_fmu_kind_enu_t fmuKind, const fmi2_callback_functions_t* callBackFunctions) {
+
+       char curDir[FILENAME_MAX + 2];
+       char* dllDirPath = 0;
+       char* dllFileName = 0;
+       const char* modelIdentifier;
+       fmi2_callback_functions_t defaultCallbacks;
+
+       if (fmu == NULL) {
+               assert(0);
+               return jm_status_error;
+       }
+
+       if(fmu -> capi) {
+               if(fmi2_capi_get_fmu_kind(fmu -> capi) == fmuKind) {
+                       jm_log_warning(fmu->callbacks, module, "FMU binary is already loaded"); 
+                       return jm_status_success;
+               }
+               else
+                       fmi2_import_destroy_dllfmu(fmu);                
+       }
+
+       if(fmuKind == fmi2_fmu_kind_me)
+               modelIdentifier = fmi2_import_get_model_identifier_ME(fmu);
+       else    if(fmuKind == fmi2_fmu_kind_cs)
+               modelIdentifier = fmi2_import_get_model_identifier_CS(fmu);
+       else {
+               assert(0);
+               return jm_status_error;
+       }
+
+       if (modelIdentifier == NULL) {
+               jm_log_error(fmu->callbacks, module, "No model identifier given");
+               return jm_status_error;
+       }
+
+       if( jm_portability_get_current_working_directory(curDir, FILENAME_MAX+1) != jm_status_success) {
+               jm_log_warning(fmu->callbacks, module, "Could not get current working directory (%s)", strerror(errno));
+               curDir[0] = 0;
+       };
+
+       dllDirPath = fmi_construct_dll_dir_name(fmu->callbacks, fmu->dirPath);
+       dllFileName = fmi_construct_dll_file_name(fmu->callbacks, dllDirPath, modelIdentifier);
+
+       if (!dllDirPath ||!dllFileName) {
+               fmu->callbacks->free(dllDirPath);
+               return jm_status_error;
+       }
+
+       if(!callBackFunctions) {
+               jm_callbacks* cb = fmu->callbacks;
+               defaultCallbacks.allocateMemory = cb->calloc;
+               defaultCallbacks.freeMemory = cb->free;
+               defaultCallbacks.componentEnvironment = fmu;
+               defaultCallbacks.logger = fmi2_log_forwarding;
+               defaultCallbacks.stepFinished = 0;
+               callBackFunctions = &defaultCallbacks;
+       }
+
+       if(jm_portability_set_current_working_directory(dllDirPath) != jm_status_success) {
+               jm_log_fatal(fmu->callbacks, module, "Could not change to the DLL directory %s", dllDirPath);
+               if(ENOENT == errno)
+                       jm_log_fatal(fmu->callbacks, module, "The FMU contains no binary for this platform.");
+               else
+                       jm_log_fatal(fmu->callbacks, module, "System error: %s", strerror(errno));
+       }
+       else {
+               /* Allocate memory for the C-API struct */
+               fmu -> capi = fmi2_capi_create_dllfmu(fmu->callbacks, dllFileName, modelIdentifier, callBackFunctions, fmuKind);
+       }
+
+
+       /* Load the DLL handle */
+       if (fmu -> capi) {
+               jm_log_info(fmu->callbacks, module, \r
+                       "Loading '" FMI_PLATFORM "' binary with '%s' platform types", fmi2_get_types_platform() );\r
+
+               if(fmi2_capi_load_dll(fmu -> capi) == jm_status_error) {                
+                       fmi2_capi_destroy_dllfmu(fmu -> capi);
+                       fmu -> capi = NULL;
+               }
+       }
+
+       if(curDir[0] && (jm_portability_set_current_working_directory(curDir) != jm_status_success)) {
+               jm_log_error(fmu->callbacks, module, "Could not restore current working directory (%s)", strerror(errno));
+       }
+
+       fmu->callbacks->free((jm_voidp)dllDirPath);
+       fmu->callbacks->free((jm_voidp)dllFileName);
+
+       if (fmu -> capi == NULL) {
+               return jm_status_error;
+       }
+
+
+       /* Load the DLL functions */
+       if (fmi2_capi_load_fcn(fmu -> capi, fmi2_xml_get_capabilities(fmu->md)) == jm_status_error) {
+               fmi2_capi_free_dll(fmu -> capi);                        
+               fmi2_capi_destroy_dllfmu(fmu -> capi);
+               fmu -> capi = NULL;
+               return jm_status_error;
+       }
+       jm_log_verbose(fmu->callbacks, module, "Successfully loaded all the interface functions"); 
+
+       return jm_status_success;
+}
+
+void fmi2_import_set_debug_mode(fmi2_import_t* fmu, int mode) {
+       if (fmu == NULL) {
+               return;
+       }
+       fmi2_capi_set_debug_mode(fmu->capi, mode);
+}
+
+void fmi2_import_destroy_dllfmu(fmi2_import_t* fmu) {
+       
+       if (fmu == NULL) {
+               return;
+       }
+
+       
+       if(fmu -> capi) {
+               jm_log_verbose(fmu->callbacks, module, "Releasing FMU CAPI interface"); 
+
+               /* Free DLL handle */
+               fmi2_capi_free_dll(fmu -> capi);
+
+               /* Destroy the C-API struct */
+               fmi2_capi_destroy_dllfmu(fmu -> capi);
+
+               fmu -> capi = NULL;
+       }
+}
+
+/* FMI 2.0 Common functions */
+const char* fmi2_import_get_version(fmi2_import_t* fmu) {
+       if(!fmu->capi) {
+               jm_log_error(fmu->callbacks, module,"FMU CAPI is not loaded");
+               return 0;
+       }
+       return fmi2_capi_get_version(fmu -> capi);
+}
+
+fmi2_status_t fmi2_import_set_debug_logging(fmi2_import_t* fmu, fmi2_boolean_t loggingOn, size_t nCategories, fmi2_string_t categories[]) {
+       if(!fmu->capi) {
+               jm_log_error(fmu->callbacks, module,"FMU CAPI is not loaded");
+               return fmi2_status_fatal;
+       }
+       return fmi2_capi_set_debug_logging(fmu -> capi, loggingOn, nCategories, categories);
+}
+
+
+jm_status_enu_t fmi2_import_instantiate(fmi2_import_t* fmu,
+  fmi2_string_t instanceName, fmi2_type_t fmuType,
+  fmi2_string_t fmuResourceLocation, fmi2_boolean_t visible) {
+    fmi2_string_t fmuGUID = fmi2_import_get_GUID(fmu);
+    fmi2_boolean_t loggingOn = (fmu->callbacks->log_level > jm_log_level_nothing);
+    fmi2_component_t c;
+    if(!fmuResourceLocation) 
+        fmuResourceLocation = fmu->resourceLocation;
+    c = fmi2_capi_instantiate(fmu -> capi, instanceName, fmuType, fmuGUID,
+                              fmuResourceLocation, visible, loggingOn);
+    if (c == NULL) {
+        return jm_status_error;
+    } else {
+        return jm_status_success;
+    }
+}
+
+void fmi2_import_free_instance(fmi2_import_t* fmu) {
+    if (fmu != NULL) {
+        fmi2_capi_free_instance(fmu -> capi);
+    }
+}
+
+fmi2_status_t fmi2_import_setup_experiment(fmi2_import_t* fmu,
+    fmi2_boolean_t tolerance_defined, fmi2_real_t tolerance,
+    fmi2_real_t start_time, fmi2_boolean_t stop_time_defined,
+    fmi2_real_t stop_time)
+{
+    assert(fmu);
+    return fmi2_capi_setup_experiment(fmu->capi, tolerance_defined, tolerance,
+                                      start_time, stop_time_defined, stop_time);
+}
+
+fmi2_status_t fmi2_import_enter_initialization_mode(fmi2_import_t* fmu)
+{
+    assert(fmu);
+    return fmi2_capi_enter_initialization_mode(fmu->capi);
+}
+
+fmi2_status_t fmi2_import_exit_initialization_mode(fmi2_import_t* fmu)
+{
+    assert(fmu);
+    return fmi2_capi_exit_initialization_mode(fmu->capi);
+}
+
+fmi2_status_t fmi2_import_terminate(fmi2_import_t* fmu) {
+       return fmi2_capi_terminate(fmu -> capi);
+}
+
+fmi2_status_t fmi2_import_reset(fmi2_import_t* fmu) {
+       return fmi2_capi_reset(fmu -> capi);
+}
+
+
+fmi2_status_t fmi2_import_set_real(fmi2_import_t* fmu, const fmi2_value_reference_t vr[], size_t nvr, const fmi2_real_t    value[]) {
+       return fmi2_capi_set_real(fmu -> capi, vr, nvr, value);
+}
+
+fmi2_status_t fmi2_import_set_integer(fmi2_import_t* fmu, const fmi2_value_reference_t vr[], size_t nvr, const fmi2_integer_t value[]) {
+       return fmi2_capi_set_integer(fmu -> capi, vr, nvr, value);
+}
+
+fmi2_status_t fmi2_import_set_boolean(fmi2_import_t* fmu, const fmi2_value_reference_t vr[], size_t nvr, const fmi2_boolean_t value[]) {
+       return fmi2_capi_set_boolean(fmu -> capi, vr, nvr, value);
+}
+
+fmi2_status_t fmi2_import_set_string(fmi2_import_t* fmu, const fmi2_value_reference_t vr[], size_t nvr, const fmi2_string_t  value[]) {
+       return fmi2_capi_set_string(fmu -> capi, vr, nvr, value);
+}
+
+fmi2_status_t fmi2_import_get_real(fmi2_import_t* fmu, const fmi2_value_reference_t vr[], size_t nvr, fmi2_real_t    value[]) {
+       return fmi2_capi_get_real(fmu -> capi, vr, nvr, value);
+}
+
+fmi2_status_t fmi2_import_get_integer(fmi2_import_t* fmu, const fmi2_value_reference_t vr[], size_t nvr, fmi2_integer_t value[]) {
+       return fmi2_capi_get_integer(fmu -> capi, vr, nvr, value);
+}
+
+fmi2_status_t fmi2_import_get_boolean(fmi2_import_t* fmu, const fmi2_value_reference_t vr[], size_t nvr, fmi2_boolean_t value[]) {
+       return fmi2_capi_get_boolean(fmu -> capi, vr, nvr, value);
+}
+
+fmi2_status_t fmi2_import_get_string(fmi2_import_t* fmu, const fmi2_value_reference_t vr[], size_t nvr, fmi2_string_t  value[]) {
+       return fmi2_capi_get_string(fmu -> capi, vr, nvr, value);
+}
+
+const char* fmi2_import_get_types_platform(fmi2_import_t* fmu) {
+       return fmi2_capi_get_types_platform(fmu -> capi);
+}
+
+fmi2_status_t fmi2_import_get_fmu_state           (fmi2_import_t* fmu, fmi2_FMU_state_t* s) {\r
+       return fmi2_capi_get_fmu_state(fmu -> capi,s);\r
+}\r
+fmi2_status_t fmi2_import_set_fmu_state           (fmi2_import_t* fmu, fmi2_FMU_state_t s){\r
+       return fmi2_capi_set_fmu_state(fmu -> capi,s);\r
+}\r
+fmi2_status_t fmi2_import_free_fmu_state          (fmi2_import_t* fmu, fmi2_FMU_state_t* s){\r
+       return fmi2_capi_free_fmu_state (fmu -> capi,s);\r
+}\r
+fmi2_status_t fmi2_import_serialized_fmu_state_size(fmi2_import_t* fmu, fmi2_FMU_state_t s, size_t* sz){\r
+       return fmi2_capi_serialized_fmu_state_size(fmu -> capi,s,sz);\r
+}\r
+fmi2_status_t fmi2_import_serialize_fmu_state     (fmi2_import_t* fmu, fmi2_FMU_state_t s , fmi2_byte_t data[], size_t sz){\r
+       return fmi2_capi_serialize_fmu_state(fmu -> capi,s,data,sz);\r
+}\r
+fmi2_status_t fmi2_import_de_serialize_fmu_state  (fmi2_import_t* fmu, const fmi2_byte_t data[], size_t sz, fmi2_FMU_state_t* s){\r
+       return fmi2_capi_de_serialize_fmu_state (fmu -> capi,data,sz,s);\r
+}\r
+\r
+fmi2_status_t fmi2_import_get_directional_derivative(fmi2_import_t* fmu, const fmi2_value_reference_t v_ref[], size_t nv,\r
+                                                                   const fmi2_value_reference_t z_ref[], size_t nz,\r
+                                                                   const fmi2_real_t dv[], fmi2_real_t dz[]){\r
+       return fmi2_capi_get_directional_derivative(fmu -> capi,v_ref, nv, z_ref, nz, dv, dz);\r
+}
+
+/* FMI 2.0 ME functions */
+
+fmi2_status_t fmi2_import_enter_event_mode(fmi2_import_t* fmu) {
+    return fmi2_capi_enter_event_mode(fmu->capi);
+}
+
+fmi2_status_t fmi2_import_new_discrete_states(fmi2_import_t* fmu, fmi2_event_info_t* eventInfo) {
+    return fmi2_capi_new_discrete_states(fmu->capi, eventInfo);
+}
+
+fmi2_status_t fmi2_import_enter_continuous_time_mode(fmi2_import_t* fmu) {
+    return fmi2_capi_enter_continuous_time_mode(fmu->capi);
+}
+
+fmi2_status_t fmi2_import_set_time(fmi2_import_t* fmu, fmi2_real_t time) {
+       return fmi2_capi_set_time(fmu -> capi, time);
+}
+
+fmi2_status_t fmi2_import_set_continuous_states(fmi2_import_t* fmu, const fmi2_real_t x[], size_t nx) {
+       return fmi2_capi_set_continuous_states(fmu -> capi, x, nx);
+}
+
+fmi2_status_t fmi2_import_completed_integrator_step(fmi2_import_t* fmu,
+  fmi2_boolean_t noSetFMUStatePriorToCurrentPoint,
+  fmi2_boolean_t* enterEventMode, fmi2_boolean_t* terminateSimulation) {
+    return fmi2_capi_completed_integrator_step(fmu -> capi, noSetFMUStatePriorToCurrentPoint,
+                                               enterEventMode, terminateSimulation);
+}
+
+fmi2_status_t fmi2_import_get_derivatives(fmi2_import_t* fmu, fmi2_real_t derivatives[], size_t nx) {
+       return fmi2_capi_get_derivatives(fmu -> capi, derivatives, nx);
+}
+
+fmi2_status_t fmi2_import_get_event_indicators(fmi2_import_t* fmu, fmi2_real_t eventIndicators[], size_t ni) {
+       return fmi2_capi_get_event_indicators(fmu -> capi, eventIndicators, ni);
+}
+
+fmi2_status_t fmi2_import_get_continuous_states(fmi2_import_t* fmu, fmi2_real_t states[], size_t nx) {
+       return fmi2_capi_get_continuous_states(fmu -> capi, states, nx);
+}
+
+fmi2_status_t fmi2_import_get_nominals_of_continuous_states(fmi2_import_t* fmu, fmi2_real_t x_nominal[], size_t nx) {
+       return fmi2_capi_get_nominals_of_continuous_states(fmu -> capi, x_nominal, nx);
+}
+
+/* FMI 2.0 CS functions */
+
+fmi2_status_t fmi2_import_set_real_input_derivatives(fmi2_import_t* fmu, const fmi2_value_reference_t vr[], size_t nvr, const fmi2_integer_t order[], const  fmi2_real_t value[]) {
+       return fmi2_capi_set_real_input_derivatives(fmu -> capi, vr, nvr, order, value);
+}
+                                                  
+fmi2_status_t fmi2_import_get_real_output_derivatives(fmi2_import_t* fmu, const fmi2_value_reference_t vr[], size_t nvr, const fmi2_integer_t order[], fmi2_real_t value[]) {
+       return fmi2_capi_get_real_output_derivatives(fmu -> capi, vr, nvr, order, value);
+}
+                                              
+fmi2_status_t fmi2_import_cancel_step(fmi2_import_t* fmu) {
+       return fmi2_capi_cancel_step(fmu -> capi);
+}
+
+fmi2_status_t fmi2_import_do_step(fmi2_import_t* fmu, fmi2_real_t currentCommunicationPoint, fmi2_real_t communicationStepSize, fmi2_boolean_t newStep) {
+       return fmi2_capi_do_step(fmu -> capi, currentCommunicationPoint, communicationStepSize, newStep);
+}
+
+fmi2_status_t fmi2_import_get_status(fmi2_import_t* fmu, const fmi2_status_kind_t s, fmi2_status_t*  value) {
+       return fmi2_capi_get_status(fmu -> capi, s, value);
+}
+
+fmi2_status_t fmi2_import_get_real_status(fmi2_import_t* fmu, const fmi2_status_kind_t s, fmi2_real_t*    value) {
+       return fmi2_capi_get_real_status(fmu -> capi, s, value);
+}
+
+fmi2_status_t fmi2_import_get_integer_status(fmi2_import_t* fmu, const fmi2_status_kind_t s, fmi2_integer_t* value) {
+       return fmi2_capi_get_integer_status(fmu -> capi, s, value);
+}
+
+fmi2_status_t fmi2_import_get_boolean_status(fmi2_import_t* fmu, const fmi2_status_kind_t s, fmi2_boolean_t* value) {
+       return fmi2_capi_get_boolean_status(fmu -> capi, s, value);
+}
+
+fmi2_status_t fmi2_import_get_string_status(fmi2_import_t* fmu, const fmi2_status_kind_t s, fmi2_string_t*  value) {
+       return fmi2_capi_get_string_status(fmu -> capi, s, value);
+}
+
+#ifdef __cplusplus
+}
+#endif