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;
183 callbacks->log_level = jm_log_level_debug;
184 callbacks->context = 0;
186 context = fmi_import_allocate_context(callbacks);
188 version = fmi_import_get_fmi_version(context, zipFilePath, unzipFolder);
190 if (version == fmi_version_1_enu ) {
191 fmu = fmi1_import_parse_xml(context, unzipFolder);
192 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) {
193 *error = "Provided FMU is version 1 but wrong type me (Model Exchange) when it should be cs (Co-Simulation)";
194 return 2; /* wrong type, should be co-simulation */
197 callBackFunctions.logger = fmilogger;
198 callBackFunctions.allocateMemory = calloc;
199 callBackFunctions.freeMemory = free;
201 status = fmi1_import_create_dllfmu(fmu, callBackFunctions, 0);
202 if (status == jm_status_error) {
203 *error = fmi1_import_get_last_error(fmu);
209 } else if (version == fmi_version_2_0_enu) {
210 fmu2 = fmi2_import_parse_xml(context, unzipFolder, 0);
212 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) {
213 *error = "Provided FMU is version 2.0 but wrong type me (Model Exchange) when it should be cs (Co-Simulation)";
214 return 2; /* wrong type, should be co-simulation */
217 callBackFunctions2.logger = fmi2_log_forwarding;
218 callBackFunctions2.allocateMemory = calloc;
219 callBackFunctions2.freeMemory = free;
220 callBackFunctions2.componentEnvironment = fmu2;
222 status = fmi2_import_create_dllfmu(fmu2, fmi2_fmu_kind_cs, &callBackFunctions2);
223 if (status == jm_status_error) {
224 *error = fmi2_import_get_last_error(fmu2);
232 fmi_import_free_context(context);
234 return 0; /* success */
237 int FMI1_CS_UNLOAD(void *fmu_, const char **error) {
238 fmi1_import_t *fmu = (fmi1_import_t *)fmu_;
239 fmi1_import_destroy_dllfmu(fmu);
240 fmi1_import_free(fmu);
244 int FMI2_CS_UNLOAD(void *fmu_, const char **error) {
245 fmi2_import_t *fmu = (fmi2_import_t *)fmu_;
246 fmi2_import_destroy_dllfmu(fmu);
247 fmi2_import_free(fmu);
253 printf("No type definition\n");
257 quan = fmi1_import_get_type_quantity(vt);
259 printf("Type %s\n description: %s\n", fmi1_import_get_type_name(vt), fmi1_import_get_type_description(vt));
261 printf("Base type: %s\n", fmi1_base_type_to_string(fmi1_import_get_base_type(vt)));
264 printf("Quantity: %s\n", quan);
266 switch(fmi1_import_get_base_type(vt)) {
267 case fmi1_base_type_real: {
268 fmi1_import_real_typedef_t* rt = fmi1_import_get_type_as_real(vt);
269 fmi1_real_t min = fmi1_import_get_real_type_min(rt);
270 fmi1_real_t max = fmi1_import_get_real_type_max(rt);
271 fmi1_real_t nom = fmi1_import_get_real_type_nominal(rt);
272 fmi1_import_unit_t* u = fmi1_import_get_real_type_unit(rt);
273 fmi1_import_display_unit_t* du = fmi1_import_get_type_display_unit(rt);
275 printf("Min %g, max %g, nominal %g\n", min, max, nom);
278 printf("Unit: %s\n", fmi1_import_get_unit_name(u));
281 printf("Display unit: %s, gain: %g, offset: %g, is relative: %s",
282 fmi1_import_get_display_unit_name(du),
283 fmi1_import_get_display_unit_gain(du),
284 fmi1_import_get_display_unit_offset(du),
285 fmi1_import_get_real_type_is_relative_quantity(rt)?"yes":"no"
291 case fmi1_base_type_int:{
292 fmi1_import_integer_typedef_t* it = fmi1_import_get_type_as_int(vt);
293 int min = fmi1_import_get_integer_type_min(it);
294 int max = fmi1_import_get_integer_type_max(it);
295 printf("Min %d, max %d\n", min, max);
298 case fmi1_base_type_bool:{
301 case fmi1_base_type_str:{
304 case fmi1_base_type_enum:{
305 fmi1_import_enumeration_typedef_t* et = fmi1_import_get_type_as_enum(vt);
306 int min = fmi1_import_get_enum_type_min(et);
307 int max = fmi1_import_get_enum_type_max(et);
308 printf("Min %d, max %d\n", min, max);
312 ni = fmi1_import_get_enum_type_size(et);
315 printf("There are %u items \n",(unsigned)ni);
316 for(i = 0; i < ni; i++) {
317 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));
323 printf("Error in fmiGetBaseType()\n");
328 FMIL_Variable *FMI1_CS_GET_VARIABLES(void *fmu, int *count, const char **error) {
331 FMIL_Variable *result;
332 fmi1_import_variable_list_t* vl = fmi1_import_get_variable_list((fmi1_import_t *)fmu);
333 fmi1_import_variable_typedef_t* type;
335 count[0] = fmi1_import_get_variable_list_size(vl);
337 result = (FMIL_Variable *)malloc(count[0]*sizeof(FMIL_Variable));
339 for(i = 0; i < count[0]; i++) {
341 fmi1_import_variable_t* var = fmi1_import_get_variable(vl, i);
344 printf("Something wrong with variable %d \n",i);
349 result[i].name = fmi1_import_get_variable_name(var);
350 result[i].description = fmi1_import_get_variable_description(var);
352 switch (fmi1_import_get_variability(var)) {
353 case fmi1_variability_enu_constant:
354 result[i].variability = 0;
356 case fmi1_variability_enu_parameter:
357 result[i].variability = 1;
359 case fmi1_variability_enu_discrete:
360 result[i].variability = 2;
362 case fmi1_variability_enu_continuous:
363 result[i].variability = 3;
365 case fmi1_variability_enu_unknown:
366 result[i].variability = 4;
370 switch (fmi1_import_get_causality(var)) {
371 case fmi1_causality_enu_input:
372 result[i].causality = 0;
374 case fmi1_causality_enu_output:
375 result[i].causality = 1;
377 case fmi1_causality_enu_internal:
378 result[i].causality = 2;
380 case fmi1_causality_enu_none:
381 result[i].causality = 3;
383 case fmi1_causality_enu_unknown:
384 result[i].causality = 4;
388 switch (fmi1_import_get_variable_base_type(var)) {
389 case fmi1_base_type_real:
392 case fmi1_base_type_int:
395 case fmi1_base_type_bool:
398 case fmi1_base_type_str:
401 case fmi1_base_type_enum:
406 result[i].vr = fmi1_import_get_variable_vr(var);
408 type = fmi1_import_get_variable_declared_type(var);
410 result[i].declaredType = fmi1_import_get_type_name(type);
412 result[i].declaredType = 0;
419 fmi1_import_free_variable_list(vl);
425 FMIL_Variable *FMI2_CS_GET_VARIABLES(void *fmu, int *count, const char **error) {
428 FMIL_Variable *result;
429 fmi2_import_variable_list_t* vl = fmi2_import_get_variable_list((fmi2_import_t *)fmu, 0);
430 fmi2_import_variable_typedef_t* type;
432 count[0] = fmi2_import_get_variable_list_size(vl);
434 result = (FMIL_Variable *)malloc(count[0]*sizeof(FMIL_Variable));
436 for(i = 0; i < count[0]; i++) {
438 fmi2_import_variable_t* var = fmi2_import_get_variable(vl, i);
441 printf("Something wrong with variable %d \n",i);
446 result[i].name = fmi2_import_get_variable_name(var);
447 result[i].description = fmi2_import_get_variable_description(var);
449 switch (fmi2_import_get_variability(var)) {
450 case fmi2_variability_enu_constant:
451 result[i].variability = 0;
453 case fmi2_variability_enu_fixed:
454 case fmi2_variability_enu_tunable:
455 result[i].variability = 1;
457 case fmi2_variability_enu_discrete:
458 result[i].variability = 2;
460 case fmi2_variability_enu_continuous:
461 result[i].variability = 3;
463 case fmi2_variability_enu_unknown:
464 result[i].variability = 4;
468 switch (fmi2_import_get_causality(var)) {
469 case fmi2_causality_enu_input:
470 result[i].causality = 0;
472 case fmi2_causality_enu_output:
473 result[i].causality = 1;
475 case fmi2_causality_enu_local:
476 result[i].causality = 2;
478 case fmi2_causality_enu_independent:
479 result[i].causality = 3;
481 case fmi2_causality_enu_unknown:
482 result[i].causality = 4;
486 switch (fmi2_import_get_variable_base_type(var)) {
487 case fmi2_base_type_real:
490 case fmi2_base_type_int:
493 case fmi2_base_type_bool:
496 case fmi2_base_type_str:
499 case fmi2_base_type_enum:
504 result[i].vr = fmi2_import_get_variable_vr(var);
506 type = fmi2_import_get_variable_declared_type(var);
508 result[i].declaredType = fmi2_import_get_type_name(type);
510 result[i].declaredType = 0;
517 fmi2_import_free_variable_list(vl);
523 FMIL_DeclaredType *FMI1_CS_GET_DECLARED_TYPES(void *fmu, int *count, const char **error) {
525 FMIL_DeclaredType *result;
526 fmi1_import_type_definitions_t* td = fmi1_import_get_type_definitions((fmi1_import_t *)fmu);
527 fmi1_import_variable_typedef_t* type;
528 unsigned i, ntd = (unsigned)fmi1_import_get_type_definition_number(td);
532 result = (FMIL_DeclaredType *)malloc(count[0]*sizeof(FMIL_DeclaredType));
534 for(i = 0; i < ntd; i++) {
535 type = fmi1_import_get_typedef(td, i);
536 result[i].name = fmi1_import_get_type_name(type);
537 result[i].description = fmi1_import_get_type_description(type);
538 result[i].quantity = fmi1_import_get_type_quantity(type);
541 switch(fmi1_import_get_base_type(type)) {
542 case fmi1_base_type_real: {
543 fmi1_import_real_typedef_t* rt = fmi1_import_get_type_as_real(type);
544 fmi1_import_unit_t* u = fmi1_import_get_real_type_unit(rt);
545 if(u) result[i].unit = fmi1_import_get_unit_name(u);
555 FMIL_DeclaredType *FMI2_CS_GET_DECLARED_TYPES(void *fmu, int *count, const char **error) {
557 FMIL_DeclaredType *result;
558 fmi2_import_type_definitions_t* td = fmi2_import_get_type_definitions((fmi2_import_t *)fmu);
559 fmi2_import_variable_typedef_t* type;
560 unsigned i, ntd = (unsigned)fmi2_import_get_type_definition_number(td);
564 result = (FMIL_DeclaredType *)malloc(count[0]*sizeof(FMIL_DeclaredType));
566 for(i = 0; i < ntd; i++) {
567 type = fmi2_import_get_typedef(td, i);
568 result[i].name = fmi2_import_get_type_name(type);
569 result[i].description = fmi2_import_get_type_description(type);
570 result[i].quantity = fmi2_import_get_type_quantity(type);
573 switch(fmi2_import_get_base_type(type)) {
574 case fmi2_base_type_real: {
575 fmi2_import_real_typedef_t* rt = fmi2_import_get_type_as_real(type);
576 fmi2_import_unit_t* u = fmi2_import_get_real_type_unit(rt);
577 if(u) result[i].unit = fmi2_import_get_unit_name(u);
587 int FMI1_CS_INSTANTIATE(void *fmu, const char *instanceName, const char **error) {
589 fmi1_string_t fmuLocation;
590 fmi1_string_t mimeType;
592 fmi1_boolean_t visible;
593 fmi1_boolean_t interactive;
594 fmi1_boolean_t loggingOn;
596 jm_status_enu_t jmstatus;
601 visible = fmi1_false;
602 interactive = fmi1_false;
603 loggingOn = fmi1_true;
605 jmstatus = fmi1_import_instantiate_slave((fmi1_import_t*)fmu, instanceName, NULL, NULL, timeout, fmi1_false, fmi1_false);
606 if (jmstatus == jm_status_error) {
607 *error = fmi1_import_get_last_error((fmi1_import_t*)fmu);
613 int FMI2_CS_INSTANTIATE(void *fmu, const char *instanceName, const char **error) {
615 fmi2_string_t fmuLocation;
616 fmi2_string_t mimeType;
618 fmi2_boolean_t visible;
619 fmi2_boolean_t interactive;
620 fmi2_boolean_t loggingOn;
621 jm_status_enu_t jmstatus;
626 visible = fmi2_false;
627 jmstatus = fmi2_import_instantiate((fmi2_import_t*)fmu, instanceName, fmi2_cosimulation, NULL, visible);
628 if (jmstatus == jm_status_error) {
629 *error = fmi2_import_get_last_error((fmi2_import_t*)fmu);
635 int FMI1_CS_INITIALIZE(void *fmu, const char **error) {
637 fmi1_status_t status;
640 fmi1_boolean_t StopTimeDefined;
644 StopTimeDefined = fmi1_false;
646 status = fmi1_import_initialize_slave((fmi1_import_t *)fmu, tStart, StopTimeDefined, tStop);
647 if (status == fmi1_status_error || status == fmi1_status_fatal) {
648 printf("fmi1_capi_initialize_slave: Failed\n");
651 printf("fmi1_capi_initialize_slave: Success\n");
657 int FMI2_CS_INITIALIZE(void *fmu, const char **error) {
661 fmi2_boolean_t StopTimeDefined;
662 fmi2_real_t relativeTol = 1e-4;
664 fmi2_status_t fmistatus;
668 StopTimeDefined = fmi1_false;
670 fmistatus = fmi2_import_setup_experiment((fmi2_import_t*)fmu, fmi2_true, relativeTol, tStart, StopTimeDefined, tStop);
671 if(fmistatus != fmi2_status_ok) {
672 *error = ("fmi2_import_setup_experiment failed\n");
676 fmistatus = fmi2_import_enter_initialization_mode((fmi2_import_t*)fmu);
677 if(fmistatus != fmi2_status_ok) {
678 *error = ("fmi2_import_enter_initialization_mode failed\n");
682 fmistatus = fmi2_import_exit_initialization_mode((fmi2_import_t*)fmu);
683 if(fmistatus != fmi2_status_ok) {
684 *error = ("fmi2_import_exit_initialization_mode failed\n");
691 int FMI1_CS_STEP(void *fmu, double masterTime, double stepSize, const char **error) {
693 fmi1_status_t status;
695 status = fmi1_import_do_step((fmi1_import_t *)fmu, (fmi1_real_t)masterTime, (fmi1_real_t)stepSize, fmi1_true);
696 if (status == fmi1_status_error || status == fmi1_status_fatal) {
697 *error = "Error happened during stepping!";
703 int FMI2_CS_STEP(void *fmu, double masterTime, double stepSize, const char **error) {
705 fmi2_status_t status;
707 status = fmi2_import_do_step((fmi2_import_t *)fmu, (fmi2_real_t)masterTime, (fmi2_real_t)stepSize, fmi2_true);
708 if (status == fmi2_status_error || status == fmi2_status_fatal) {
709 *error = "Error happened during stepping!";
715 int FMI1_CS_SET_REAL(void *fmu, int valueId, double value, const char **error) {
717 fmi1_status_t status;
719 fmi1_value_reference_t vr = valueId;
720 status = fmi1_import_set_real((fmi1_import_t *)fmu, &vr, 1, &value);
721 if (status == fmi1_status_error || status == fmi1_status_fatal) {
722 *error = "Error happened during setting real value!";
728 int FMI2_CS_SET_REAL(void *fmu, int valueId, double value, const char **error) {
730 fmi2_status_t status;
732 fmi2_value_reference_t vr = valueId;
733 status = fmi2_import_set_real((fmi2_import_t *)fmu, &vr, 1, &value);
734 if (status == fmi2_status_error || status == fmi2_status_fatal) {
735 *error = "Error happened during setting real value!";
741 double FMI1_CS_GET_REAL(void *fmu, int valueReference, const char **error) {
743 fmi1_value_reference_t vr = valueReference;
746 fmi1_status_t status;
748 status = fmi1_import_get_real((fmi1_import_t *)fmu, &vr, 1, &value);
749 if (status == fmi1_status_error || status == fmi1_status_fatal) {
750 *error = "Error happened during getting real value!";
755 double FMI2_CS_GET_REAL(void *fmu, int valueReference, const char **error) {
757 fmi2_value_reference_t vr = valueReference;
760 fmi2_status_t status;
762 status = fmi2_import_get_real((fmi2_import_t *)fmu, &vr, 1, &value);
763 if (status == fmi2_status_error || status == fmi2_status_fatal) {
764 *error = "Error happened during setting real value!";
769 int FMI1_CS_GET_REALS(void *fmu, int *valueReferences, double *result, int count, const char **error) {
771 fmi1_value_reference_t *vrs = (fmi1_value_reference_t*) valueReferences;
774 fmi1_status_t status;
776 status = fmi1_import_get_real((fmi1_import_t *)fmu, vrs, count, result);
777 if (status == fmi1_status_error || status == fmi1_status_fatal) {
778 *error = "Error happened during getting reals value!";
783 int FMI2_CS_GET_REALS(void *fmu, int *valueReferences, double *result, int count, const char **error) {
785 fmi2_value_reference_t *vrs = (fmi2_value_reference_t*) valueReferences;
788 fmi2_status_t status;
790 status = fmi2_import_get_real((fmi2_import_t *)fmu, vrs, count, result);
791 if (status == fmi2_status_error || status == fmi2_status_fatal) {
792 *error = "Error happened during getting reals value!";