Table of contents
The document describes how to generate a LinkableComponent on Linux:
During runtime the C# wrapper refers only one Fortran shared library. All Fortran sources were compiled to one shared library <fortranEngine>.so:
ifort -c -fPIC -convert big_endian -fpp *.f90 |
Linking the compiled objects:
ifort -shared -o <fortranEngine.so> *.o |
During runtime some fortran libraries must be accessible via the environment variable LD_LIBRARY_PATH. In the following examples they are provided by the ifort compiler.
export LD_LIBRARY_PATH=/opt/intel/fce/9.1.051/lib:. // on 64bit systems |
The ifort compiler v. 9.1.051 has a bug with public character parameters in modules.
Example:
CHARACTER (LEN=40), PUBLIC, PARAMETER :: c_att_name(2)= & |
The parameter c_att_name can easily be accessed from an external Fortran method. But if a Mono C# application calls a Fortran method, that accesses c_att_name, it will crash without error message. The solution is a Fortran function, that exports the parameter as a return value. Now the values can be accessed from C#.
PUBLIC FUNCTION get_c_att_name ( idx ) & |
The <fortranEngine>.so interface functions are the same as in Windows Fortran. The two example functions are part of the module gei_ui and will be accessed from C# in 4.2.1.. The first one returns the integer comp_id_len.
FUNCTION gei_component_id_len ( comp_id_len ) RESULT( ok ) |
The second example returns the character string comp_id.
FUNCTION gei_component_id ( comp_idx, comp_id ) RESULT( ok ) |
The Mono Guidelines Interop with Native Libaries gives general information about the interface between managed and unmanaged code.
The wrapper has three layers:
Compilation of the two inner layers:
gmcs -target:library -out: <engine>DotNetAccess.dll <engine>DllAccess.cs <engine>DotNetAccess.cs |
Compilation of the outer layer:
gmcs -target:library -out:<engine>Wrapper.dll -pkg:baw-geidotnet.pc, openmi-backbone.pc,openmi-devsupport.pc,openmi-spatial.pc,openmi-standard.pc,openmi-wrapper.pc *.cs |
Fortunately, the original Windows C# code can nearly remain as it is.
<engine>DllAccess offers access to the Fortran shared library, e.g. @"gei.xe.so". The most of the Windows C# code remains unchanged and is displayed in black colour in the following example. The Fortran module gei_ui, method gei_component_id_len returns the integer comp_id_len.
[DllImport(
|
Some more adjustments are necessary, if a Fortran method returns the character string quantId:
[ DllImport( |
[Out] byte[ ] quantId:
Several guidelines recommend to marshall a variable of type StringBuilder in order to return a Fortran character string:
[MarshalAs(UnmanagedType.LPStr)] StringBuilder quantId |
But on Linux systems StringBuilder can very rarely lead to variables with undefined return values. It is not clear why this happens. The Mono guidelines display a slightly different case, where the Mono garbage collector frees memory before the character string is returned, s. paragraph "GC-Safe P/Invoke code".
However, the variables of type [Out] byte[ ] were always returned correctly and it is recommended to use them on Linux. The StringBuilder remains the better solution for Windows .NET. Developers are invited to find a solution that works on Windows as well as on Linux, e.g. an additional C / C++ wrapper or a SWIG generated wrapper.
Methods accessing int variables, e.g. ComponentIdLen(), remain unchanged from Windows:
public int ComponentIdLen() return compIdLen; |
This example displays that the variable of type byte[ ] from 4.2.1. is externally encoded to the string str:
public string OutputExchangeQuantityId(int compIdx, int outputExchangeN) } |
Furthermore, the Initialize method of this class is a good place for a check, whether the dll is running on Mono or not:
if ( Type.GetType ("Mono.Runtime") == null ) |
There are no changes compared to Windows C#.
Before using the LinkableComponent its location must be known by Linux. It is recommended to put all shared libraries <fortranEngine>.so, <engine>DotNetAccess.dll and <engine>Wrapper.dll in one directory <componentDir>.
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:<componentDir> |
Now the generated LinkableComponent can be connected to any other LinkableComponent. Adding it as a model to the Linux version of the ConfigurationEditor is an easy test, s. How to port the OpenMI from Windows to Linux.