Do not include the standard FMI headers in the FMU

Belonging to [master]:
  - #2989
  - OpenModelica/OpenModelica-testsuite#1149

Author: sjoelund

Compiler/Script/CevalScriptBackend.mo

@@ -3042,7 +3042,7 @@ algorithm
     if Flags.isSet(Flags.GC_PROF) then
       print(GC.profStatsStr(GC.getProfStats(), head="GC stats after front-end:") + "\n");
     end if;
-	ExecStat.execStat("FrontEnd - DAE generated");
+  ExecStat.execStat("FrontEnd - DAE generated");
     odae := SOME(dae);
   else
     // Return odae=NONE(); needed to update cache and symbol table if we fail
@@ -3354,7 +3354,8 @@ protected
   String CC, CFLAGS, LDFLAGS, makefileStr, container, host, nozip,
     dir=fmutmp+"/sources/", cmd="",
     quote="'",
-    dquote = if isWindows then "\"" else "'";
+    dquote = if isWindows then "\"" else "'",
+    includeDefaultFmi;
   list<String> rest;
   Boolean finishedBuild;
   Integer uid;
@@ -3368,6 +3369,7 @@ algorithm
     System.removeFile(logfile);
   end if;
   nozip := System.getMakeCommand()+" -j"+intString(Config.noProc()) + " nozip";
+  includeDefaultFmi := "-I" + Settings.getInstallationDirectoryPath() + "/include/omc/c/fmi";
   finishedBuild := match Util.stringSplitAtChar(platform, " ")
     case {"dynamic"}
       algorithm
@@ -3381,7 +3383,7 @@ algorithm
         makefileStr := System.stringReplace(makefileStr, "@NEED_RUNTIME@", "");
         makefileStr := System.stringReplace(makefileStr, "@NEED_DGESV@", "");
         makefileStr := System.stringReplace(makefileStr, "@FMIPLATFORM@", System.modelicaPlatform());
-        makefileStr := System.stringReplace(makefileStr, "@CPPFLAGS@", "");
+        makefileStr := System.stringReplace(makefileStr, "@CPPFLAGS@", includeDefaultFmi);
         makefileStr := System.stringReplace(makefileStr, "@LIBTYPE_DYNAMIC@", "1");
         makefileStr := System.stringReplace(makefileStr, "\r\n", "\n");
         System.writeFile(dir + "Makefile", makefileStr);
@@ -3400,7 +3402,7 @@ algorithm
         makefileStr := System.stringReplace(makefileStr, "@NEED_RUNTIME@", "");
         makefileStr := System.stringReplace(makefileStr, "@NEED_DGESV@", "");
         makefileStr := System.stringReplace(makefileStr, "@FMIPLATFORM@", System.modelicaPlatform());
-        makefileStr := System.stringReplace(makefileStr, "@CPPFLAGS@", "-DOMC_MINIMAL_RUNTIME=1 -DCMINPACK_NO_DLL=1");
+        makefileStr := System.stringReplace(makefileStr, "@CPPFLAGS@", "-DOMC_MINIMAL_RUNTIME=1 -DCMINPACK_NO_DLL=1 " + includeDefaultFmi);
         makefileStr := System.stringReplace(makefileStr, "@LIBTYPE_DYNAMIC@", "1");
         makefileStr := System.stringReplace(makefileStr, "\r\n", "\n");
         System.writeFile(dir + "Makefile", makefileStr);
@@ -3409,7 +3411,7 @@ algorithm
       then false;
     case {_}
       algorithm
-        cmd := "cd \"" +  fmutmp + "/sources\" && ./configure --host="+quote+platform+quote+" CFLAGS="+quote+"-Os"+quote+" LDFLAGS= && " +
+        cmd := "cd \"" +  fmutmp + "/sources\" && ./configure --host="+quote+platform+quote+" CFLAGS="+quote+"-Os"+quote+" CPPFLAGS="+quote+includeDefaultFmi+quote+" LDFLAGS= && " +
                nozip;
         if 0 <> System.systemCall(cmd, outFile=logfile) then
           Error.addMessage(Error.SIMULATOR_BUILD_ERROR, {System.readFile(logfile)});
@@ -3422,7 +3424,7 @@ algorithm
         uid := System.getuid();
         cmd := "docker run "+(if uid<>0 then "--user " + String(uid) else "")+" --rm -w /fmu -v "+quote+System.realpath(fmutmp+"/..")+quote+":/fmu " +stringDelimitList(rest," ")+ " sh -c " + dquote +
                "cd " + dquote + System.basename(fmutmp) + "/sources" + dquote + " && " +
-               "./configure --host="+quote+host+quote+" CFLAGS="+quote+"-Os"+quote+" LDFLAGS= && " +
+               "./configure --host="+quote+host+quote+" CFLAGS="+quote+"-Os"+quote+" CPPFLAGS="+quote+includeDefaultFmi+quote+" LDFLAGS= && " +
                nozip + dquote;
         if 0 <> System.systemCall(cmd, outFile=logfile) then
           Error.addMessage(Error.SIMULATOR_BUILD_ERROR, {System.readFile(logfile)});
@@ -3529,8 +3531,8 @@ algorithm
       ExecStat.execStat("buildModelFMU: Generate C++ for platform " + platform);
     end for;
     if 0 <> System.systemCall("make -f " + filenameprefix + "_FMU.makefile clean", outFile=logfile) then
-	  // do nothing
-	end if;
+    // do nothing
+  end if;
     return;
   end if;
 
@@ -3579,21 +3581,21 @@ algorithm
     ext := if System.os() == "Windows_NT" then ".exe" else "";
     if encrypt then
       // create the path till packagetool
-	    packageTool := stringAppendList({omhome,pd,"lib",pd,"omc",pd,"SEMLA",pd,"packagetool",ext});
-	    if System.regularFileExists(packageTool) then
-	      // create the list of arguments for packagetool
-	      packageToolArgs := "-librarypath \"" + System.dirname(fileName) + "\" -version \"1.0\" -language \"3.2\" -encrypt \"" + boolString(encrypt) + "\"";
-	      command := stringAppendList({packageTool," ",packageToolArgs});
-	    else
-	      Error.addMessage(Error.ENCRYPTION_NOT_SUPPORTED, {packageTool});
+      packageTool := stringAppendList({omhome,pd,"lib",pd,"omc",pd,"SEMLA",pd,"packagetool",ext});
+      if System.regularFileExists(packageTool) then
+        // create the list of arguments for packagetool
+        packageToolArgs := "-librarypath \"" + System.dirname(fileName) + "\" -version \"1.0\" -language \"3.2\" -encrypt \"" + boolString(encrypt) + "\"";
+        command := stringAppendList({packageTool," ",packageToolArgs});
+      else
+        Error.addMessage(Error.ENCRYPTION_NOT_SUPPORTED, {packageTool});
         success := false;
         runCommand := false;
-	    end if;
-	  else
-	    molName := Absyn.pathString(className) + ".mol";
-	    dirPath := System.dirname(fileName);
-	    // commands
-	    rmCommand := "rm -f \"" + molName + "\"";
+      end if;
+    else
+      molName := Absyn.pathString(className) + ".mol";
+      dirPath := System.dirname(fileName);
+      // commands
+      rmCommand := "rm -f \"" + molName + "\"";
       cdCommand := "cd \"" +  dirPath + "\"";
       mvCommand := "mv \"" + molName +"\" \"" + System.pwd() + "\"";
 
@@ -8181,8 +8183,8 @@ algorithm
    if nm == 2 then
      resultFile := f; return;
    end if;
-	else
-	  // do nothing
+  else
+    // do nothing
   end try;
 end selectResultFile;
 

Compiler/SimCode/SimCodeMain.mo

@@ -728,7 +728,7 @@ algorithm
         varInfo := simCode.modelInfo.varInfo;
         allFiles := {};
         allFiles := listAppend(RuntimeSources.commonHeaders, listAppend(RuntimeSources.commonFiles, allFiles));
-        allFiles := listAppend(if FMUVersion=="1.0" then RuntimeSources.fmi1AllFiles else RuntimeSources.fmi2AllFiles, allFiles);
+        allFiles := listAppend(if FMUVersion=="1.0" then RuntimeSources.fmi1Files else RuntimeSources.fmi2Files, allFiles);
         if varInfo.numLinearSystems > 0 then
           allFiles := listAppend(RuntimeSources.lsFiles, allFiles);
         end if;
@@ -738,6 +738,9 @@ algorithm
         if varInfo.numMixedSystems > 0 then
           allFiles := listAppend(RuntimeSources.mixedFiles, allFiles);
         end if;
+
+        System.writeFile(fmutmp+"/sources/isfmi" + (if FMUVersion=="1.0" then "1" else "2"), "");
+
         dgesvFiles :=  if varInfo.numLinearSystems > 0 or varInfo.numNonLinearSystems > 0 then RuntimeSources.dgesvFiles else {};
         defaultFiles := list(simCode.fileNamePrefix + f for f in RuntimeSources.defaultFileSuffixes);
         runtimeFiles := list(f for f guard Util.endsWith(f, ".c") in allFiles);

Compiler/Template/CodegenFMU.tpl

@@ -224,9 +224,9 @@ case SIMCODE(__) then
   #include "simulation/solver/initialization/initialization.h"
   #include "simulation/solver/events.h"
   <%if isFMIVersion20(FMUVersion) then
-  '#include "fmi2/fmu2_model_interface.h"'
+  '#include "fmi-export/fmu2_model_interface.h"'
   else
-  '#include "fmi1/fmu1_model_interface.h"'%>
+  '#include "fmi-export/fmu1_model_interface.h"'%>
 
   #ifdef __cplusplus
   extern "C" {
@@ -271,13 +271,13 @@ case SIMCODE(__) then
     <<
     extern void <%symbolName(modelNamePrefix(simCode),"setupDataStruc")%>(DATA *data, threadData_t *threadData);
     #define fmu2_model_interface_setupDataStruc <%symbolName(modelNamePrefix(simCode),"setupDataStruc")%>
-    #include "fmi2/fmu2_model_interface.c.inc"
+    #include "fmi-export/fmu2_model_interface.c.inc"
     >>
   else
     <<
     extern void <%symbolName(modelNamePrefix(simCode),"setupDataStruc")%>(DATA *data, threadData_t *threadData);
     #define fmu1_model_interface_setupDataStruc <%symbolName(modelNamePrefix(simCode),"setupDataStruc")%>
-    #include "fmi1/fmu1_model_interface.c.inc"
+    #include "fmi-export/fmu1_model_interface.c.inc"
     >>
   %>
 

SimulationRuntime/c/Makefile.common

@@ -290,10 +290,9 @@ install: bootstrap-dependencies $(LIBSIMULATION) $(LIBFMIRUNTIME) $(ALL_OBJS) fm
 	test ! `uname` = Darwin || install_name_tool -change libsundials_kinsol.1.dylib @rpath/libsundials_kinsol.1.dylib $(builddir_lib)/$(LIBSIMULATION)
 	test ! `uname` = Darwin || install_name_tool -change liblis.dylib @rpath/liblis.dylib $(builddir_lib)/$(LIBSIMULATION)
 	# copy fmi stuff
-	cp -p $(RUNTIME_HEADERS_FMU) ../fmi/export/fmi1/*.h \
-	   ../fmi/export/fmi1/fmu1_model_interface.c.inc $(builddir_inc)/c/fmi1
-	cp -p ../fmi/export/fmi2/*.h \
-	   ../fmi/export/fmi2/fmu2_model_interface.c.inc $(builddir_inc)/c/fmi2
+	mkdir -p $(builddir_inc)/c/fmi-export
+	cp -p ../fmi/export/fmi/*.h $(builddir_inc)/c/fmi
+	cp -p ../fmi/export/openmodelica/*.inc ../fmi/export/openmodelica/*.h $(builddir_inc)/c/fmi-export
 
 clean:
 	rm -rf $(ALL_PATHS_CLEAN_OBJS) fmi/*.o *.a *.so optimization/*/*.o build/

SimulationRuntime/c/RuntimeSources.mo.tpl

@@ -1,12 +1,8 @@
 encapsulated package RuntimeSources
   constant list<String> commonFiles={COMMON_FILES};
   constant list<String> commonHeaders={COMMON_HEADERS};
-  constant list<String> fmi1Files={"fmi1/fmu1_model_interface.c.inc"};
-  constant list<String> fmi1Headers={"fmi1/fmiModelFunctions.h","fmi1/fmiModelTypes.h","fmi1/fmu1_model_interface.h"};
-  constant list<String> fmi1AllFiles=listAppend(fmi1Files, fmi1Headers);
-  constant list<String> fmi2Files={"fmi2/fmu2_model_interface.c.inc"};
-  constant list<String> fmi2Headers={"fmi2/fmi2Functions.h","fmi2/fmi2TypesPlatform.h","fmi2/fmu2_model_interface.h","fmi2/fmi2FunctionTypes.h"};
-  constant list<String> fmi2AllFiles=listAppend(fmi2Files, fmi2Headers);
+  constant list<String> fmi1Files={"fmi-export/fmu1_model_interface.c.inc","fmi-export/fmu1_model_interface.h"};
+  constant list<String> fmi2Files={"fmi-export/fmu2_model_interface.c.inc","fmi-export/fmu2_model_interface.h"};
   constant list<String> defaultFileSuffixes={".c", "_functions.c", "_records.c", "_01exo.c", "_02nls.c", "_03lsy.c", "_04set.c", "_05evt.c", "_06inz.c", "_07dly.c", "_08bnd.c", "_09alg.c", "_10asr.c", "_11mix.c", "_12jac.c", "_13opt.c", "_14lnz.c", "_15syn.c", "_16dae.c", "_17inl.c", "_init_fmu.c", "_FMU.c"};
   constant list<String> dgesvFiles={DGESV_FILES, "./external_solvers/blaswrap.h", "./external_solvers/clapack.h", "./external_solvers/f2c.h"};
   constant list<String> lsFiles={LS_FILES};

SimulationRuntime/fmi/export/buildproject/configure.ac

@@ -209,6 +209,14 @@ AC_CHECK_LIB([m],[cos],[],[AC_MSG_ERROR([math library not found])])
 AC_MSG_CHECKING([for filesystem access])
 AC_TRY_LINK([#include <stdio.h>], [fopen("a.txt", "r");], [AC_MSG_RESULT([OK])], [AC_MSG_RESULT([no]); CPPFLAGS="$CPPFLAGS -DOMC_NO_FILESYSTEM"])
 
+if test -f isfmi1; then
+AC_CHECK_HEADERS([fmiModelFunctions.h fmiModelTypes.h], [], [AC_MSG_ERROR([FMI headers need to be present in the include path. Try setting CPPFLAGS.])])
+elif test -f isfmi2; then
+AC_CHECK_HEADERS([fmi2Functions.h  fmi2FunctionTypes.h  fmi2TypesPlatform.h], [], [AC_MSG_ERROR([FMI headers need to be present in the include path. Try setting CPPFLAGS.])])
+else
+AC_MSG_ERROR([Neither file isfmi1 or isfmi2 exists in the source directory])
+fi
+
 AC_ARG_WITH(dynamic-om-runtime,  [  --with-dynamic-om-runtime    (uses the OMC runtime as a shared object instead of compiling it statically into the the FMU.)],[OPENMODELICADYNAMIC=yes],[OPENMODELICADYNAMIC=no])
 
 if test "$OPENMODELICADYNAMIC" = "no"; then