Recently I found myself unexpectedly lost in translation.\u00a0 As a \u201cnative speaker\u201d of several languages of the C family I was facing the problem of calling various functions of a FORTRAN library from my C\/C++ program. Although, I had done such kind of mixed-language programming in the past this time something went seriously wrong.\u00a0 To call a FORTRAN function from C\/C++ one has to provide a C\/C++ function prototype for each FORTRAN function.\u00a0 Thus the one-million dollar question was how does, for example, the FORTRAN function declaration<\/p>\n
DOUBLE COMPLEX FUNCTION ZDOTC(N, ZX, INCX, ZY, INCY)\n* .. Scalar Arguments ..\n INTEGER INCX, INCY, N\n* .. Array Arguments ..\n DOUBLE COMPLEX ZX(*), ZY(*)\n<\/pre>\ntranslate to a C\/C++ function prototype?\u00a0 (This BLAS function calculates the scalar product of two complex vectors.)<\/p>\n
Though there is no standard that defines inter-language operability between C\/C++ and FORTRAN the answer is: It depends.\u00a0 It depends on the employed FORTRAN and C\/C++ compilers and possibly on the operating system.<\/p>\n
First, one has to figure out which C\/C++ data types are binary compatible to the various FORTRAN data types.\u00a0 As mentioned before this is a compiler-dependent issue.\u00a0 Typically the following mapping applies<\/p>\n
INTEGER<\/code> -> signed int<\/code><\/li>\nREAL<\/code> -> float<\/code><\/li>\nDOUBLE PRECISION<\/code> -> double<\/code><\/li>\nCOMPLEX<\/code> -> struct { float z[2]; }<\/code> or float complex<\/code> (with C99 and header file complex.h<\/code>) or std::complex<float><\/code> (in C++ with header file complex<\/code>)<\/li>\nDOUBLE COMPLEX<\/code> -> struct { double z[2]; }<\/code> or double complex<\/code> (with C99 and header file complex.h<\/code>) or std::complex<double><\/code> (in C++ with header file complex<\/code>)<\/li>\nLOGICAL<\/code> -> int<\/code> (Only specific values may be valid representations of\u00a0 true and false.)<\/li>\n<\/ul>\nSecondly, the FORTRAN function’s name in C\/C++ representation has to be determined.\u00a0 Again there is no general rule.\u00a0 Most compilers, however, down-case the FORTRAN function name and add one or two underscores. Furthermore, FORTRAN function arguments are usually passed by pointers. Thus, the C++ function prototype for the ZDOTC<\/code> FORTRAN function shown above may be<\/p>\nextern \"C\" {\n std::complex<double> zdotc_(const int *n,\n const std::complex<double> *zx, const int *incx,\n const std::complex<double> *zy, const int *incy);\n}\n<\/pre>\nThe ZDOTC<\/code> function does not modify all its input parameters (so-called in-parameters).\u00a0 Therefore, the pointers in the C++ prototype have been declared as const.\u00a0 For parameters that may be modified by a FORTRAN function (so-called in-out-parameters) the corresponding C\/C++ pointers have to be declared as non-const.<\/p>\nWith the explanations given, the translation form the FORTRAN function declaration to the C++ function prototype of ZDOTC<\/code> looks straight forward.\u00a0 Some FORTRAN compilers, however, do something quite unexpected, which finally let me feel a little bit lost in translation after getting strange run-time errors when calling ZDOTC<\/code> from C++ as illustrated above.<\/p>\nSome FORTRAN compilers, in particular g77 and ifort, generate code that requires special treatment for complex return values.\u00a0 These are returned via an extra argument in the calling sequence that points to where to store the return value.\u00a0 Thus, the C++ function becomes<\/p>\n
extern \"C\" {\n void zdotc_(std::complex<double> *res, const int *n,\n const std::complex<double> *zx, const int *incx,\n const std::complex<double> *zy, const int *incy);\n}\n<\/pre>\nwith possibly a second underscore in the function name.<\/p>\n
All these different calling conventions make it hard to write portable C\/C++ programs that interact with FORTRAN libraries.\u00a0 Some FORTRAN compilers even allow to specify on compile-time how to deal with complex return values or to change the byte-width of INTEGER and REAL variables.\u00a0 This has to be taken into account when specifying the C\/C++ function prototypes of FORTRAN functions.<\/p>\n
Further reading:<\/p>\n
\n- GCC mixed language programming<\/a><\/li>\n
- Intel FORTRAN mixed language programming<\/a><\/li>\n
- cfortran.h : Interfacing C or C++ and FORTRAN<\/a><\/li>\n
- Mixed language programming using C++ and FORTRAN 77<\/a><\/li>\n
- Calling Fortran Subroutines from C\/C++<\/a><\/li>\n<\/ul>\n","protected":false},"excerpt":{"rendered":"