2 Copyright (C) 2012 Modelon AB
4 This program is free software: you can redistribute it and/or modify
5 it under the terms of the BSD style license.
7 This program is distributed in the hope that it will be useful,
8 but WITHOUT ANY WARRANTY; without even the implied warranty of
9 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 FMILIB_License.txt file for more details.
12 You should have received a copy of the FMILIB_License.txt file
13 along with this program. If not, contact Modelon AB <http://www.modelon.com>.
19 #include <FMI/fmi_util.h>
20 #include <FMI/fmi_zip_unzip.h>
23 char* fmi_construct_dll_dir_name(jm_callbacks* callbacks, const char* fmu_unzipped_path) {
27 assert( fmu_unzipped_path && callbacks);
30 strlen(fmu_unzipped_path) + strlen(FMI_FILE_SEP)
31 + strlen(FMI_BINARIES) + strlen(FMI_FILE_SEP)
32 + strlen(FMI_PLATFORM) + strlen(FMI_FILE_SEP) + 1;
34 dir_path = (char*)callbacks->malloc(len);
35 if (dir_path == NULL) {
36 jm_log_fatal(callbacks, "FMIUT", "Failed to allocate memory.");
40 sprintf(dir_path, "%s%s%s%s%s%s", fmu_unzipped_path, FMI_FILE_SEP, FMI_BINARIES, FMI_FILE_SEP, FMI_PLATFORM, FMI_FILE_SEP);/*safe */
45 char* fmi_construct_dll_file_name(jm_callbacks* callbacks, const char* dll_dir_name, const char* model_identifier) {
48 assert(callbacks && model_identifier);
50 strlen(dll_dir_name) +
51 strlen(model_identifier)
52 + strlen(FMI_DLL_EXT) + 1;
53 fname = (char*)callbacks->malloc(len);
55 jm_log_fatal(callbacks, "FMIUT", "Failed to allocate memory.");
58 sprintf(fname, "%s%s%s", dll_dir_name, model_identifier, FMI_DLL_EXT);/*safe */
108 #define DLLEXPORT __declspec(dllexport)
110 #define DLLEXPORT __attribute__((visibility("default")))
111 #pragma warning Using GNUC default visibility
114 #pragma warning Empty dynamic link EXPORT defined
117 DLLEXPORT int FMI_CS_LOAD(const char *zipFilePath, const char *unzipFolder, void **fmuPointer, int *fmuVersion, const char **error);
119 DLLEXPORT int FMI1_CS_UNLOAD(void* fmu, const char **error);
120 DLLEXPORT FMIL_Variable *FMI1_CS_GET_VARIABLES(void* fmu, int *count, const char **error);
121 DLLEXPORT FMIL_DeclaredType *FMI1_CS_GET_DECLARED_TYPES(void* fmu, int *count, const char **error);
122 DLLEXPORT int FMI1_CS_INSTANTIATE(void* fmu, const char *instanceName, const char **error);
123 DLLEXPORT int FMI1_CS_INITIALIZE(void* fmu, const char **error);
124 DLLEXPORT int FMI1_CS_STEP(void* fmu, double masterTime, double stepSize, const char **error);
125 DLLEXPORT int FMI1_CS_SET_REAL(void* fmu, int vr, double value, const char **error);
126 DLLEXPORT double FMI1_CS_GET_REAL(void* fmu, int vr, const char **error);
127 DLLEXPORT int FMI1_CS_GET_REALS(void* fmu, int *vrs, double *values, int count, const char **error);
129 DLLEXPORT int FMI2_CS_UNLOAD(void* fmu, const char **error);
130 DLLEXPORT FMIL_Variable *FMI2_CS_GET_VARIABLES(void* fmu, int *count, const char **error);
131 DLLEXPORT FMIL_DeclaredType *FMI2_CS_GET_DECLARED_TYPES(void* fmu, int *count, const char **error);
132 DLLEXPORT int FMI2_CS_INSTANTIATE(void* fmu, const char *instanceName, const char **error);
133 DLLEXPORT int FMI2_CS_INITIALIZE(void* fmu, const char **error);
134 DLLEXPORT int FMI2_CS_STEP(void* fmu, double masterTime, double stepSize, const char **error);
135 DLLEXPORT int FMI2_CS_SET_REAL(void* fmu, int vr, double value, const char **error);
136 DLLEXPORT double FMI2_CS_GET_REAL(void* fmu, int vr, const char **error);
137 DLLEXPORT int FMI2_CS_GET_REALS(void* fmu, int *vrs, double *values, int count, const char **error);
145 /* Logger function used by the C-API */
146 void importlogger(jm_callbacks* c, jm_string module, jm_log_level_enu_t log_level, jm_string message)
148 printf("module = %s, log level = %d: %s\n", module, log_level, message);
151 /* Logger function used by the FMU internally */
152 void fmilogger(fmi1_component_t c, fmi1_string_t instanceName, fmi1_status_t status, fmi1_string_t category, fmi1_string_t message, ...)
157 va_start(argp, message);
158 /*len=jm_vsnprintf(msg, BUFFER, message, argp);
159 printf("fmiStatus = %d; %s (%s): %s\n", status, instanceName, category, msg);
161 printf("Warning: message was trancated");
165 int FMI_CS_LOAD(const char *zipFilePath, const char *unzipFolder, void **fmuPointer, int *fmuVersion, const char **error) {
167 fmi1_callback_functions_t callBackFunctions;
168 fmi2_callback_functions_t callBackFunctions2;
169 fmi_import_context_t* context;
170 fmi_version_enu_t version;
171 jm_status_enu_t status;
174 jm_callbacks* callbacks;
176 callbacks = (jm_callbacks *)calloc(1, sizeof(jm_callbacks));
178 callbacks->malloc = malloc;
179 callbacks->calloc = calloc;
180 callbacks->realloc = realloc;
181 callbacks->free = free;
182 callbacks->logger = importlogger;
184 callbacks->log_level = jm_log_level_debug;
186 callbacks->log_level = jm_log_level_warning;
188 callbacks->context = 0;
190 context = fmi_import_allocate_context(callbacks);
192 version = fmi_import_get_fmi_version(context, zipFilePath, unzipFolder);
194 if (version == fmi_version_1_enu ) {
195 fmu = fmi1_import_parse_xml(context, unzipFolder);
196 if (fmi1_import_get_fmu_kind(fmu) != fmi1_fmu_kind_enu_cs_standalone && fmi1_import_get_fmu_kind(fmu) != fmi1_fmu_kind_enu_cs_tool) {
197 *error = "Provided FMU is version 1 but wrong type me (Model Exchange) when it should be cs (Co-Simulation)";
198 return 2; /* wrong type, should be co-simulation */
201 callBackFunctions.logger = fmilogger;
202 callBackFunctions.allocateMemory = calloc;
203 callBackFunctions.freeMemory = free;
205 status = fmi1_import_create_dllfmu(fmu, callBackFunctions, 0);
206 if (status == jm_status_error) {
207 *error = fmi1_import_get_last_error(fmu);
213 } else if (version == fmi_version_2_0_enu) {
214 fmu2 = fmi2_import_parse_xml(context, unzipFolder, 0);
216 if (fmi2_import_get_fmu_kind(fmu2) != fmi1_fmu_kind_enu_cs_standalone && fmi2_import_get_fmu_kind(fmu2) != fmi1_fmu_kind_enu_cs_tool) {
217 *error = "Provided FMU is version 2.0 but wrong type me (Model Exchange) when it should be cs (Co-Simulation)";
218 return 2; /* wrong type, should be co-simulation */
221 callBackFunctions2.logger = fmi2_log_forwarding;
222 callBackFunctions2.allocateMemory = calloc;
223 callBackFunctions2.freeMemory = free;
224 callBackFunctions2.componentEnvironment = fmu2;
226 status = fmi2_import_create_dllfmu(fmu2, fmi2_fmu_kind_cs, &callBackFunctions2);
227 if (status == jm_status_error) {
228 *error = fmi2_import_get_last_error(fmu2);
236 fmi_import_free_context(context);
238 return 0; /* success */
241 int FMI1_CS_UNLOAD(void *fmu_, const char **error) {
242 fmi1_import_t *fmu = (fmi1_import_t *)fmu_;
243 fmi1_import_destroy_dllfmu(fmu);
244 fmi1_import_free(fmu);
248 int FMI2_CS_UNLOAD(void *fmu_, const char **error) {
249 fmi2_import_t *fmu = (fmi2_import_t *)fmu_;
250 fmi2_import_destroy_dllfmu(fmu);
251 fmi2_import_free(fmu);
257 printf("No type definition\n");
261 quan = fmi1_import_get_type_quantity(vt);
263 printf("Type %s\n description: %s\n", fmi1_import_get_type_name(vt), fmi1_import_get_type_description(vt));
265 printf("Base type: %s\n", fmi1_base_type_to_string(fmi1_import_get_base_type(vt)));
268 printf("Quantity: %s\n", quan);
270 switch(fmi1_import_get_base_type(vt)) {
271 case fmi1_base_type_real: {
272 fmi1_import_real_typedef_t* rt = fmi1_import_get_type_as_real(vt);
273 fmi1_real_t min = fmi1_import_get_real_type_min(rt);
274 fmi1_real_t max = fmi1_import_get_real_type_max(rt);
275 fmi1_real_t nom = fmi1_import_get_real_type_nominal(rt);
276 fmi1_import_unit_t* u = fmi1_import_get_real_type_unit(rt);
277 fmi1_import_display_unit_t* du = fmi1_import_get_type_display_unit(rt);
279 printf("Min %g, max %g, nominal %g\n", min, max, nom);
282 printf("Unit: %s\n", fmi1_import_get_unit_name(u));
285 printf("Display unit: %s, gain: %g, offset: %g, is relative: %s",
286 fmi1_import_get_display_unit_name(du),
287 fmi1_import_get_display_unit_gain(du),
288 fmi1_import_get_display_unit_offset(du),
289 fmi1_import_get_real_type_is_relative_quantity(rt)?"yes":"no"
295 case fmi1_base_type_int:{
296 fmi1_import_integer_typedef_t* it = fmi1_import_get_type_as_int(vt);
297 int min = fmi1_import_get_integer_type_min(it);
298 int max = fmi1_import_get_integer_type_max(it);
299 printf("Min %d, max %d\n", min, max);
302 case fmi1_base_type_bool:{
305 case fmi1_base_type_str:{
308 case fmi1_base_type_enum:{
309 fmi1_import_enumeration_typedef_t* et = fmi1_import_get_type_as_enum(vt);
310 int min = fmi1_import_get_enum_type_min(et);
311 int max = fmi1_import_get_enum_type_max(et);
312 printf("Min %d, max %d\n", min, max);
316 ni = fmi1_import_get_enum_type_size(et);
319 printf("There are %u items \n",(unsigned)ni);
320 for(i = 0; i < ni; i++) {
321 printf("[%u] %s (%s) \n", (unsigned)i+1, fmi1_import_get_enum_type_item_name(et, i), fmi1_import_get_enum_type_item_description(et, i));
327 printf("Error in fmiGetBaseType()\n");
332 FMIL_Variable *FMI1_CS_GET_VARIABLES(void *fmu, int *count, const char **error) {
335 FMIL_Variable *result;
336 fmi1_import_variable_list_t* vl = fmi1_import_get_variable_list((fmi1_import_t *)fmu);
337 fmi1_import_variable_typedef_t* type;
339 count[0] = fmi1_import_get_variable_list_size(vl);
341 result = (FMIL_Variable *)malloc(count[0]*sizeof(FMIL_Variable));
343 for(i = 0; i < count[0]; i++) {
345 fmi1_import_variable_t* var = fmi1_import_get_variable(vl, i);
348 printf("Something wrong with variable %d \n",i);
353 result[i].name = fmi1_import_get_variable_name(var);
354 result[i].description = fmi1_import_get_variable_description(var);
356 switch (fmi1_import_get_variability(var)) {
357 case fmi1_variability_enu_constant:
358 result[i].variability = 0;
360 case fmi1_variability_enu_parameter:
361 result[i].variability = 1;
363 case fmi1_variability_enu_discrete:
364 result[i].variability = 2;
366 case fmi1_variability_enu_continuous:
367 result[i].variability = 3;
369 case fmi1_variability_enu_unknown:
370 result[i].variability = 4;
374 switch (fmi1_import_get_causality(var)) {
375 case fmi1_causality_enu_input:
376 result[i].causality = 0;
378 case fmi1_causality_enu_output:
379 result[i].causality = 1;
381 case fmi1_causality_enu_internal:
382 result[i].causality = 2;
384 case fmi1_causality_enu_none:
385 result[i].causality = 3;
387 case fmi1_causality_enu_unknown:
388 result[i].causality = 4;
392 switch (fmi1_import_get_variable_base_type(var)) {
393 case fmi1_base_type_real:
396 case fmi1_base_type_int:
399 case fmi1_base_type_bool:
402 case fmi1_base_type_str:
405 case fmi1_base_type_enum:
410 result[i].vr = fmi1_import_get_variable_vr(var);
412 type = fmi1_import_get_variable_declared_type(var);
414 result[i].declaredType = fmi1_import_get_type_name(type);
416 result[i].declaredType = 0;
423 fmi1_import_free_variable_list(vl);
429 FMIL_Variable *FMI2_CS_GET_VARIABLES(void *fmu, int *count, const char **error) {
432 FMIL_Variable *result;
433 fmi2_import_variable_list_t* vl = fmi2_import_get_variable_list((fmi2_import_t *)fmu, 0);
434 fmi2_import_variable_typedef_t* type;
436 count[0] = fmi2_import_get_variable_list_size(vl);
438 result = (FMIL_Variable *)malloc(count[0]*sizeof(FMIL_Variable));
440 for(i = 0; i < count[0]; i++) {
442 fmi2_import_variable_t* var = fmi2_import_get_variable(vl, i);
445 printf("Something wrong with variable %d \n",i);
450 result[i].name = fmi2_import_get_variable_name(var);
451 result[i].description = fmi2_import_get_variable_description(var);
453 switch (fmi2_import_get_variability(var)) {
454 case fmi2_variability_enu_constant:
455 result[i].variability = 0;
457 case fmi2_variability_enu_fixed:
458 case fmi2_variability_enu_tunable:
459 result[i].variability = 1;
461 case fmi2_variability_enu_discrete:
462 result[i].variability = 2;
464 case fmi2_variability_enu_continuous:
465 result[i].variability = 3;
467 case fmi2_variability_enu_unknown:
468 result[i].variability = 4;
472 switch (fmi2_import_get_causality(var)) {
473 case fmi2_causality_enu_input:
474 result[i].causality = 0;
476 case fmi2_causality_enu_output:
477 result[i].causality = 1;
479 case fmi2_causality_enu_local:
480 result[i].causality = 2;
482 case fmi2_causality_enu_independent:
483 result[i].causality = 3;
485 case fmi2_causality_enu_unknown:
486 result[i].causality = 4;
490 switch (fmi2_import_get_variable_base_type(var)) {
491 case fmi2_base_type_real:
494 case fmi2_base_type_int:
497 case fmi2_base_type_bool:
500 case fmi2_base_type_str:
503 case fmi2_base_type_enum:
508 result[i].vr = fmi2_import_get_variable_vr(var);
510 type = fmi2_import_get_variable_declared_type(var);
512 result[i].declaredType = fmi2_import_get_type_name(type);
514 result[i].declaredType = 0;
521 fmi2_import_free_variable_list(vl);
527 FMIL_DeclaredType *FMI1_CS_GET_DECLARED_TYPES(void *fmu, int *count, const char **error) {
529 FMIL_DeclaredType *result;
530 fmi1_import_type_definitions_t* td = fmi1_import_get_type_definitions((fmi1_import_t *)fmu);
531 fmi1_import_variable_typedef_t* type;
532 unsigned i, ntd = (unsigned)fmi1_import_get_type_definition_number(td);
536 result = (FMIL_DeclaredType *)malloc(count[0]*sizeof(FMIL_DeclaredType));
538 for(i = 0; i < ntd; i++) {
539 type = fmi1_import_get_typedef(td, i);
540 result[i].name = fmi1_import_get_type_name(type);
541 result[i].description = fmi1_import_get_type_description(type);
542 result[i].quantity = fmi1_import_get_type_quantity(type);
545 switch(fmi1_import_get_base_type(type)) {
546 case fmi1_base_type_real: {
547 fmi1_import_real_typedef_t* rt = fmi1_import_get_type_as_real(type);
548 fmi1_import_unit_t* u = fmi1_import_get_real_type_unit(rt);
549 if(u) result[i].unit = fmi1_import_get_unit_name(u);
559 FMIL_DeclaredType *FMI2_CS_GET_DECLARED_TYPES(void *fmu, int *count, const char **error) {
561 FMIL_DeclaredType *result;
562 fmi2_import_type_definitions_t* td = fmi2_import_get_type_definitions((fmi2_import_t *)fmu);
563 fmi2_import_variable_typedef_t* type;
564 unsigned i, ntd = (unsigned)fmi2_import_get_type_definition_number(td);
568 result = (FMIL_DeclaredType *)malloc(count[0]*sizeof(FMIL_DeclaredType));
570 for(i = 0; i < ntd; i++) {
571 type = fmi2_import_get_typedef(td, i);
572 result[i].name = fmi2_import_get_type_name(type);
573 result[i].description = fmi2_import_get_type_description(type);
574 result[i].quantity = fmi2_import_get_type_quantity(type);
577 switch(fmi2_import_get_base_type(type)) {
578 case fmi2_base_type_real: {
579 fmi2_import_real_typedef_t* rt = fmi2_import_get_type_as_real(type);
580 fmi2_import_unit_t* u = fmi2_import_get_real_type_unit(rt);
581 if(u) result[i].unit = fmi2_import_get_unit_name(u);
591 int FMI1_CS_INSTANTIATE(void *fmu, const char *instanceName, const char **error) {
593 fmi1_string_t fmuLocation;
594 fmi1_string_t mimeType;
596 fmi1_boolean_t visible;
597 fmi1_boolean_t interactive;
598 fmi1_boolean_t loggingOn;
600 jm_status_enu_t jmstatus;
605 visible = fmi1_false;
606 interactive = fmi1_false;
607 loggingOn = fmi1_true;
609 jmstatus = fmi1_import_instantiate_slave((fmi1_import_t*)fmu, instanceName, NULL, NULL, timeout, fmi1_false, fmi1_false);
610 if (jmstatus == jm_status_error) {
611 *error = fmi1_import_get_last_error((fmi1_import_t*)fmu);
617 int FMI2_CS_INSTANTIATE(void *fmu, const char *instanceName, const char **error) {
619 fmi2_string_t fmuLocation;
620 fmi2_string_t mimeType;
622 fmi2_boolean_t visible;
623 fmi2_boolean_t interactive;
624 fmi2_boolean_t loggingOn;
625 jm_status_enu_t jmstatus;
630 visible = fmi2_false;
631 jmstatus = fmi2_import_instantiate((fmi2_import_t*)fmu, instanceName, fmi2_cosimulation, NULL, visible);
632 if (jmstatus == jm_status_error) {
633 *error = fmi2_import_get_last_error((fmi2_import_t*)fmu);
639 int FMI1_CS_INITIALIZE(void *fmu, const char **error) {
641 fmi1_status_t status;
644 fmi1_boolean_t StopTimeDefined;
648 StopTimeDefined = fmi1_false;
650 status = fmi1_import_initialize_slave((fmi1_import_t *)fmu, tStart, StopTimeDefined, tStop);
651 if (status == fmi1_status_error || status == fmi1_status_fatal) {
652 printf("fmi1_capi_initialize_slave: Failed\n");
655 printf("fmi1_capi_initialize_slave: Success\n");
661 int FMI2_CS_INITIALIZE(void *fmu, const char **error) {
665 fmi2_boolean_t StopTimeDefined;
666 fmi2_real_t relativeTol = 1e-4;
668 fmi2_status_t fmistatus;
672 StopTimeDefined = fmi1_false;
674 fmistatus = fmi2_import_setup_experiment((fmi2_import_t*)fmu, fmi2_true, relativeTol, tStart, StopTimeDefined, tStop);
675 if(fmistatus != fmi2_status_ok) {
676 *error = ("fmi2_import_setup_experiment failed\n");
680 fmistatus = fmi2_import_enter_initialization_mode((fmi2_import_t*)fmu);
681 if(fmistatus != fmi2_status_ok) {
682 *error = ("fmi2_import_enter_initialization_mode failed\n");
686 fmistatus = fmi2_import_exit_initialization_mode((fmi2_import_t*)fmu);
687 if(fmistatus != fmi2_status_ok) {
688 *error = ("fmi2_import_exit_initialization_mode failed\n");
695 int FMI1_CS_STEP(void *fmu, double masterTime, double stepSize, const char **error) {
697 fmi1_status_t status;
699 status = fmi1_import_do_step((fmi1_import_t *)fmu, (fmi1_real_t)masterTime, (fmi1_real_t)stepSize, fmi1_true);
700 if (status == fmi1_status_error || status == fmi1_status_fatal) {
701 *error = "Error happened during stepping!";
707 int FMI2_CS_STEP(void *fmu, double masterTime, double stepSize, const char **error) {
709 fmi2_status_t status;
711 status = fmi2_import_do_step((fmi2_import_t *)fmu, (fmi2_real_t)masterTime, (fmi2_real_t)stepSize, fmi2_true);
712 if (status == fmi2_status_error || status == fmi2_status_fatal) {
713 *error = "Error happened during stepping!";
719 int FMI1_CS_SET_REAL(void *fmu, int valueId, double value, const char **error) {
721 fmi1_status_t status;
723 fmi1_value_reference_t vr = valueId;
724 status = fmi1_import_set_real((fmi1_import_t *)fmu, &vr, 1, &value);
725 if (status == fmi1_status_error || status == fmi1_status_fatal) {
726 *error = "Error happened during setting real value!";
732 int FMI2_CS_SET_REAL(void *fmu, int valueId, double value, const char **error) {
734 fmi2_status_t status;
736 fmi2_value_reference_t vr = valueId;
737 status = fmi2_import_set_real((fmi2_import_t *)fmu, &vr, 1, &value);
738 if (status == fmi2_status_error || status == fmi2_status_fatal) {
739 *error = "Error happened during setting real value!";
745 double FMI1_CS_GET_REAL(void *fmu, int valueReference, const char **error) {
747 fmi1_value_reference_t vr = valueReference;
750 fmi1_status_t status;
752 status = fmi1_import_get_real((fmi1_import_t *)fmu, &vr, 1, &value);
753 if (status == fmi1_status_error || status == fmi1_status_fatal) {
754 *error = "Error happened during getting real value!";
759 double FMI2_CS_GET_REAL(void *fmu, int valueReference, const char **error) {
761 fmi2_value_reference_t vr = valueReference;
764 fmi2_status_t status;
766 status = fmi2_import_get_real((fmi2_import_t *)fmu, &vr, 1, &value);
767 if (status == fmi2_status_error || status == fmi2_status_fatal) {
768 *error = "Error happened during setting real value!";
773 int FMI1_CS_GET_REALS(void *fmu, int *valueReferences, double *result, int count, const char **error) {
775 fmi1_value_reference_t *vrs = (fmi1_value_reference_t*) valueReferences;
778 fmi1_status_t status;
780 status = fmi1_import_get_real((fmi1_import_t *)fmu, vrs, count, result);
781 if (status == fmi1_status_error || status == fmi1_status_fatal) {
782 *error = "Error happened during getting reals value!";
787 int FMI2_CS_GET_REALS(void *fmu, int *valueReferences, double *result, int count, const char **error) {
789 fmi2_value_reference_t *vrs = (fmi2_value_reference_t*) valueReferences;
792 fmi2_status_t status;
794 status = fmi2_import_get_real((fmi2_import_t *)fmu, vrs, count, result);
795 if (status == fmi2_status_error || status == fmi2_status_fatal) {
796 *error = "Error happened during getting reals value!";