11 - C H A P T E R -

C H A P T E R 11

C-Fortran Interface

This chapter treats issues regarding Fortran and C interoperability and applies only to the specifics of the Forte Developer Fortran 95, and C compilers.

11.1 Compatibility Issues

Most C-Fortran interfaces must agree in all of these aspects:

Function and subroutine definitions and calls

Data type compatibility

Argument passing, either by reference or by value

Order of arguments

Procedure name, either uppercase, lowercase, or with a trailing underscore (_)

Passing the right library references to the linker

Some C-Fortran interfaces must also agree on:

Array indexing and order

File descriptors and stdio

File permissions

11.1.1 Function or Subroutine?

The word function has different meanings in C and Fortran. Depending on the situation, the choice is important:

In C, all subprograms are functions; however, some may return a null (void) value.

In Fortran, a function passes a return value, but a subroutine does not.

When a Fortran routine calls a C function:

If the called C function returns a value, call it from Fortran as a function.

If the called C function does not return a value, call it as a subroutine.

When a C function calls a Fortran subprogram:

If the called Fortran subprogram is a function, call it from C as a function that returns a compatible data type.

If the called Fortran subprogram is a subroutine, call it from C as a function that returns a value of int (compatible to Fortran INTEGER*4) or void. A value is returned if the Fortran subroutine uses alternate returns, in which case it is the value of the expression on the RETURN statement. If no expression appears on the RETURN statement, and alternate returns are declared on the SUBROUTINE statement, a zero is returned.

11.1.2 Data Type Compatibility

The tables below summarize the data sizes and default alignments for Fortran 95 data types compared with C. In both tables, note the following:

C data types int, long int, and long are equivalent (4 bytes) in a 32-bit environment. However, in a 64-bit environment and when compiling with -xarch=v9 or v9a, long and pointers are 8 bytes. This is referred to as the LP64 data model.

REAL*16 and COMPLEX*32, in a 64-bit environment and when compiling with -xarch=v9 or v9a, are aligned on 16-byte boundaries.

Alignments marked 4/8 indicate that alignment is 8-bytes by default, but on 4-byte boundaries in COMMON blocks. The maximum alignment in COMMON is 4-bytes.

The elements and fields of arrays and structures must be compatible.

You cannot pass arrays, character strings, or structures by value.

You can pass arguments by value from a Fortran 95 routine to a C routine by using %VAL(arg) at the call site. You can pass arguments by value from C to Fortran 95 provided the Fortran routine has an explicit interface block that declares the dummy argument with the VALUE attribute.

11.1.2.1 Fortran 95 and C Data Types

The following table compares Fortran 95 data types with C. It assumes no compilation options affecting alignment or promoting default data sizes are applied.


Fortran 95 Data Type		C Data Type	Size	Alignment
BYTE x		char x	1	1
CHARACTER x		`unsigned char x ;`	1	1
	CHARACTER (LEN=n) x	`unsigned char x[`n`] ;`	n	1
COMPLEX x		`struct {float r,i;} x;`	8	4
	`COMPLEX (KIND=4) x` `COMPLEX (KIND=8) x` `COMPLEX (KIND=16) x`	`struct {float r,i;} x;` `struct {double dr,di;} x;` `struct {long double, dr,di;} x;`	8 16 32	4 4/8 4/8/16
DOUBLE COMPLEX x		struct {double dr, di;} x;	16	4/8
DOUBLE PRECISION x		`double x ;`	8	4
REAL x		`float x ;`	4	4
	`REAL (KIND=4) x` `REAL (KIND=8) x` `REAL (KIND=16) x`	`float x ;` `double x ;` `long double x ;`	4 8 16	4 4/8 4/8/16
INTEGER x		`int x ;`	4	4
	`INTEGER (KIND=1) x` `INTEGER (KIND=2) x` `INTEGER (KIND=4) x` `INTEGER (KIND=8) x`	`signed char x ;` `short x ;` `int x ;` `long long int x;`	1 2 4 8	4 4 4 4
LOGICAL x		`int x ;`	4	4
	`LOGICAL (KIND=1) x` `LOGICAL (KIND=2) x` `LOGICAL (KIND=4) x` `LOGICAL (KIND=8) x`	`signed char x ;` `short x ;` `int x ;` `long long int x;`	1 2 4 8	4 4 4 4

11.1.3 Case Sensitivity

C and Fortran take opposite perspectives on case sensitivity:

C is case sensitive--case matters.

Fortran ignores case by default.

The f95 default is to ignore case by converting subprogram names to lowercase. It converts all uppercase letters to lowercase letters, except within character-string constants.

There are two usual solutions to the uppercase/lowercase problem:

In the C subprogram, make the name of the C function all lowercase.

Compile the Fortran program with the -U option, which tells the compiler to preserve existing uppercase/lowercase distinctions on function/subprogram names.

Use one of these two solutions, but not both.

Most examples in this chapter use all lowercase letters for the name in the C function, and do not use the f95 -U compiler option.

11.1.4 Underscores in Routine Names

The Fortran compiler normally appends an underscore (_) to the names of subprograms appearing both at entry point definition and in calls. This convention differs from C procedures or external variables with the same user-assigned name. Almost all Fortran library procedure names have double leading underscores to reduce clashes with user-assigned subroutine names.

There are three usual solutions to the underscore problem:

In the C function, change the name of the function by appending an underscore to that name.

Use the C() pragma to tell the Fortran compiler to omit those trailing underscores.

Use the f95 -ext_names option to compile references to external names without underscores.

Use only one of these solutions.

The examples in this chapter could use the C() compiler pragma to avoid underscores. The C() pragma directive takes the names of external functions as arguments. It specifies that these functions are written in the C language, so the Fortran compiler does not append an underscore as it ordinarily does with external names. The C()directive for a particular function must appear before the first reference to that function. It must also appear in each subprogram that contains such a reference. The conventional usage is:

      EXTERNAL ABC, XYZ      !$PRAGMA C( ABC, XYZ )

If you use this pragma, the C function does not need an underscore appended to the function name. (Pragma directives are described in the Fortran User's Guide.)

11.1.5 Argument-Passing by Reference or Value

In general, Fortran routines pass arguments by reference. In a call, if you enclose an argument with the nonstandard function %VAL(), the calling routine passes it by value.

The standard Fortran 95 way to pass arguments by value is the VALUE attribute and through INTERFACE blocks. See Passing Data Arguments by Value.

In general, C passes arguments by value. If you precede an argument by the ampersand operator (&), C passes the argument by reference using a pointer. C always passes arrays and character strings by reference.

11.1.6 Argument Order

Except for arguments that are character strings, Fortran and C pass arguments in the same order. However, for every argument of character type, the Fortran routine passes an additional argument giving the length of the string. These are long int quantities in C, passed by value.

The order of arguments is:

Address for each argument (datum or function)

A long int for each character argument (the whole list of string lengths comes after the whole list of other arguments)

Example:

This Fortran code fragment:	Is equivalent to this in C:
`CHARACTER*7 S` `INTEGER B(3)` `...` `CALL SAM( S, B(2) )`	`char s[7];` `int b[3];` `...` `sam_( s, &b[1], 7L ) ;`

This Fortran code fragment:

Is equivalent to this in C:

CHARACTER*7 S

INTEGER B(3)

...

CALL SAM( S, B(2) )

char s[7];

int b[3];

...

sam_( s, &b[1], 7L ) ;

11.1.7 Array Indexing and Order

Array indexing and order differ between Fortran and C.

11.1.7.1 Array Indexing

C arrays always start at zero, but by default Fortran arrays start at 1. There are two usual ways of approaching indexing.

You can use the Fortran default, as in the preceding example. Then the Fortran element B(2) is equivalent to the C element b[1].

You can specify that the Fortran array B starts at B(0) as follows:

      INTEGER B(0:2)

This way, the Fortran element B(1) is equivalent to the C element b[1].

11.1.7.2 Array Order

Fortran arrays are stored in column-major order: A(3,2)

A(1,1)  A(2,1)  A(3,1)  A(1,2)  A(2,2)  A(3,2)

C arrays are stored in row-major order: A[3][2]

A[0][0] A[0][1] A[1][0] A[1][1] A[2][0] A[2][1]

This does not present a problem for one-dimensional arrays. However, with multi-dimensional arrays, be aware of how subscripts appear and are used in all references and declarations--some adjustments might be necessary.

For example, it may be confusing to do part of a matrix manipulation in C and the rest in Fortran. It might be preferable to pass an entire array to a routine in the other language and perform all the matrix manipulation in that routine to avoid doing part in C and part in Fortran.

11.1.8 File Descriptors and `stdio`

Fortran I/O channels are in terms of unit numbers. The underlying SunOS operating system does not deal with unit numbers but with file descriptors. The Fortran runtime system translates from one to the other, so most Fortran programs do not have to recognize file descriptors.

Many C programs use a set of subroutines, called standard I/O (or stdio). Many functions of Fortran I/O use standard I/O, which in turn uses operating system I/O calls. Some of the characteristics of these I/O systems are listed in the following table.


	Fortran Units	Standard I/O File Pointers	File Descriptors
Files Open	Opened for reading and writing	Opened for reading, or for writing, or for both; or opened for appending; See `open`(2)	Opened for reading, or for writing, or opened for both
Attributes	Formatted or unformatted	Always unformatted, but can be read or written with format-interpreting routines	Always unformatted
Access	Direct or sequential	Direct access if the physical file representation is direct access, but can always be read sequentially	Direct access if the physical file representation is direct access, but can always be read sequentially
Structure	Record	Byte stream	Byte stream
Form	Arbitrary nonnegative integers from 0-2147483647	Pointers to structures in the user's address space	Integers from 0-1023

11.1.9 Libraries and Linking With the `f95` Command

To link the proper Fortran and C libraries, use the f95 command to invoke the linker.

Example 1: Use the compiler to do the linking:

demo% cc -c someCroutine.c

demo% f95 theF95routine.f someCroutine.o   The linking step

demo% a.out

 4.0 4.5

 8.0 9.0

demo%

11.2 Fortran Initialization Routines

Main programs compiled by f95 call dummy initialization routine f90_init in the library at program start up. The routines in the library are dummies that do nothing. The calls the compilers generate pass pointers to the program's arguments and environment. These calls provide software hooks you can use to supply your own routines, in C, to initialize a program in any customized manner before the program starts up.

One possible use of these initialization routines to call setlocale for an internationalized Fortran program. Because setlocale does not work if libc is statically linked, only Fortran programs that are dynamically linked with libc should be internationalized.

The source code for the init routines in the library is

void f90_init(int *argc_ptr, char ***argv_ptr, Char ***envp_ptr) {}

f90_init is called by f95 main programs. The arguments are set to the address of argc, the address of argv, and the address of envp.

11.3 Passing Data Arguments by Reference

The standard method for passing data between Fortran routines and C procedures is by reference. To a C procedure, a Fortran subroutine or function call looks like a procedure call with all arguments represented by pointers. The only peculiarity is the way Fortran handles character strings and functions as arguments and as the return value from a CHARACTER*n function.

11.3.1 Simple Data Types

For simple data types (not COMPLEX or CHARACTER strings), define or pass each associated argument in the C routine as a pointer:


Fortran calls C	C calls Fortran
`integer i` `real r` `external CSim` `i = 100` `call CSim(i,r)` `...` `----------------------------` `void csim_(int i, float r)` `{` `r = i;` `}`	`int i=100;` `float r;` `extern void fsim_(int i, float r);` `fsim_(&i, &r);` `...` `------------------------------` `subroutine FSim(i,r)` `integer i` `real r` `r = i` `return` `end`

11.3.2 COMPLEX Data

Pass a Fortran COMPLEX data item as a pointer to a C struct of two float or two double data types:


Fortran calls C	C calls Fortran
`complex w` `double complex z` `external CCmplx` `call CCmplx(w,z)` `...` `------------------------------` `struct cpx {float r, i;};` `struct dpx {double r,i;};` `void ccmplx_(` `struct cpx w,` `struct dpx z)` `{` `w -> r = 32.;` `w -> i = .007;` `z -> r = 66.67;` `z -> i = 94.1;` `}`	`struct cpx {float r, i;};` `struct cpx d1;` `struct cpx w = &d1;` `struct dpx {double r, i;};` `struct dpx d2;` `struct dpx z = &d2;` `fcmplx_( w, z );` `...` `---------------` `subroutine FCmplx( w, z )` `complex w` `double complex z` `w = (32., .007)` `z = (66.67, 94.1)` `return` `end`

In 64-bit environments and compiling with -xarch=v9, COMPLEX values are returned in registers.

11.3.3 Character Strings

Passing strings between C and Fortran routines is not recommended because there is no standard interface. However, note the following:

All C strings are passed by reference.

Fortran calls pass an additional argument for every argument with character type in the argument list. The extra argument gives the length of the string and is equivalent to a C long int passed by value. (This is implementation dependent.) The extra string-length arguments appear after the explicit arguments in the call.

A Fortran call with a character string argument is shown in the next example with its C equivalent:


Fortran call:	C equivalent:
`CHARACTER*7 S` `INTEGER B(3)` `...` `CALL CSTRNG( S, B(2) )` `...`	`char s[7];` `int b[3];` `...` `cstrng_( s, &b[1], 7L );` `...`

If the length of the string is not needed in the called routine, the extra arguments may be ignored. However, note that Fortran does not automatically terminate strings with the explicit null character that C expects. This must be added by the calling program.

The call for a character array looks identical to the call for a single character variable. The starting address of the array is passed, and the length that it uses is the length of a single element in the array.

11.3.4 One-Dimensional Arrays

Array subscripts in C start with 0.


Fortran calls C	C calls Fortran
`integer i, Sum` `integer a(9)` `external FixVec` `...` `call FixVec ( a, Sum )` `...` `------------------------------` `void fixvec_ (` `int v[9], int sum )` `{` `int i;` `sum = 0;` `for ( i = 0; i <= 8; i++ )` `sum = sum + v[i];` `}`	`extern void vecref_` `( int[], int * );` `...` `int i, sum;` `int v[9] = ...` `vecref_( v, &sum );` `...` `------------------------------` `subroutine VecRef( v, total)` `integer i, total, v(9)` `total = 0` `do i = 1,9` `total = total + v(i)` `end do` `...`

11.3.5 Two-Dimensional Arrays

Rows and columns between C and Fortran are switched.


Fortran calls C	C calls Fortran
`REAL Q(10,20)` `...` `Q(3,5) = 1.0` `CALL FIXQ(Q)` `...` `------------------------------` `void fixq_( float a[20][10] )` `{` `...` `a[5][3] = a[5][3] + 1.;` `...` `}`	`extern void` `qref_( int[][10], int *);` `...` `int m[20][10] = ... ;` `int sum;` `...` `qref_( m, &sum );` `...` `------------------------------` `SUBROUTINE QREF(A,TOTAL)` `INTEGER A(10,20), TOTAL` `DO I = 1,10` `DO J = 1,20` `TOTAL = TOTAL + A(I,J)` `END DO` `END DO` `...`

11.3.6 Structures

C and Fortran 95 derived types can be passed to each other's routines as long as the corresponding elements are compatible.(Forte Developer f95 accepts legacy STRUCTURE statements.)


Fortran calls C	C calls Fortran
`STRUCTURE /POINT/` `REAL X, Y, Z` `END STRUCTURE` `RECORD /POINT/ BASE` `EXTERNAL FLIP` `...` `CALL FLIP( BASE )` `...` `------------------------------` `struct point {` `float x,y,z;` `};` `void flip_( struct point v )` `{` `float t;` `t = v -> x;` `v -> x = v -> y;` `v -> y = t;` `v -> z = -2.(v -> z);` `}`	`struct point {` `float x,y,z;` `};` `void fflip_ ( struct point ) ;` `...` `struct point d;` `struct point ptx = &d;` `...` `fflip_ (ptx);` `...` `------------------------------` `SUBROUTINE FFLIP(P)` `STRUCTURE /POINT/` `REAL X,Y,Z` `END STRUCTURE` `RECORD /POINT/ P` `REAL T` `T = P.X` `P.X = P.Y` `P.Y = T` `P.Z = -2.*P.Z` `...`


Fortran 95 calls C	C calls Fortran 95
`TYPE point` `SEQUENCE` `REAL :: x, y, z` `END TYPE point` `TYPE (point) base` `EXTERNAL flip` `...` `CALL flip( base)` `...` `------------------------------` `struct point {` `float x,y,z;` `};` `void flip_( struct point v )` `{` `float t;` `t = v -> x;` `v -> x = v -> y;` `v -> y = t;` `v -> z = -2.(v -> z);` `}`	`struct point {` `float x,y,z;` `};` `extern void fflip_ (` `struct point ) ;` `...` `struct point d;` `struct point ptx = &d;` `...` `fflip_ (ptx);` `...` `------------------------------` `SUBROUTINE FFLIP( P )` `TYPE POINT` SEQUENCE `REAL :: X, Y, Z` `END TYPE POINT` `TYPE (POINT) P` `REAL :: T` `T = P%X` `P%X = P%Y` `P%Y = T` `P%Z = -2.*P%Z` `...`

Note that the Fortran 95 standard requires the SEQUENCE statement in the definition of the derived type to insure that storage sequence order be preserved by the compiler.

11.3.7 Pointers

A FORTRAN 77 (Cray) pointer can be passed to a C routine as a pointer to a pointer because the Fortran routine passes arguments by reference.


Fortran calls C	C calls Fortran
`REAL X` `POINTER (P2X, X)` `EXTERNAL PASS` `P2X = MALLOC(4)` `X = 0.` `CALL PASS(P2X)` `...` `------------------------------` `void pass_(p)` `float p;` `{` `p = 100.1;` `}`	`extern void fpass_( float** );` `...` `float *p2x;` `...` `fpass_(&p2x) ;` `...` `------------------------------` `SUBROUTINE FPASS (P2X)` `REAL X` `POINTER (P2X, X)` `X = 0.` `...`

C pointers are compatible with Fortran 95 scalar pointers, but not array pointers.

Fortran 95 calls C with a scalar pointer
Fortran 95 routine: `INTERFACE` `SUBROUTINE PASS(P)` `REAL, POINTER :: P` `END SUBROUTINE` `END INTERFACE` `REAL, POINTER :: P2X` `ALLOCATE (P2X)` `P2X = 0` `CALL PASS(P2X)` `PRINT, P2X` `END` C routine:* `void pass_(p);` `float p;` `{` `p = 100.1;` `}`

Fortran 95 calls C with a scalar pointer

Fortran 95 routine:

INTERFACE

SUBROUTINE PASS(P)

REAL, POINTER :: P

END SUBROUTINE

END INTERFACE

REAL, POINTER :: P2X

ALLOCATE (P2X)

P2X = 0

CALL PASS(P2X)

PRINT*, P2X

END

C routine:

void pass_(p);

float **p;

{

**p = 100.1;

}

The major difference between Cray and Fortran 95 pointers is that the target of a Cray pointer is always named. In many contexts, declaring a Fortran 95 pointer automatically identifies its target. Also, an explicit INTERFACE block is required for the called C routine.

To pass a Fortran 95 pointer to an array or array section requires a specific INTERFACE block, as in this example:

Fortran 95 routine:

INTERFACE

  SUBROUTINE S(P)

    integer P(*)

  END SUBROUTINE S

END INTERFACE

integer, target:: A(0:9)

integer, pointer :: P(:)

P => A(0:9:2) !! pointer selects every other element of A

call S(P)

...

C routine:

void s_(int p[])

   /* change middle element */

   p[2] = 444;

Note that since the C routine S is not a Fortran 95 routine, you cannot define it to be assumed shape (integer P(:)) in the interface block. If the C routine needs to know the actual size of the array it must be passed as an argument to the C routine.

Again, keep in mind that subscripting between C and Fortran differs in that C arrays start at subscript 0.

11.4 Passing Data Arguments by Value

Fortran 95 programs should use the VALUE attribute in dummy arguments when being called from C, and supply an INTERFACE block for C routines that are called from Fortran 95.


Fortran 95 calls C	C calls Fortran 95
`PROGRAM callc INTERFACE INTEGER FUNCTION crtn(I)` `!$pragma C(crtn) INTEGER, VALUE, INTENT(IN) :: I END FUNCTION crtn END INTERFACE M = 20 MM = crtn(M) WRITE (,) M, MM END PROGRAM` `---------------------------------` `int crtn(int x)` `{` `int y;` `printf("%d input \n", x);` `y = x + 1;` `printf("%d returning \n",y);` `return(y);` `}` `---------------------------------` `Results:` `20 input` `21 returning` `20 21`	`#include <stdlib.h> int main(int ac, char av[]) {` `to_fortran_(12);` `}` `--------------------------------` `SUBROUTINE to_fortran(i)` `INTEGER, VALUE :: i` `PRINT , i` `END` `--------------------------------`

Note that if the C routine will be called with different data types as an actual argument, you should include a !$PRAGMA IGNORE_TKR I in the interface block to inhibit the compiler from requiring a match in type, kind, and rank between the actual and dummy argument.

With legacy Fortran 77, call by value was available only for simple data, and only by Fortran 77 routines calling C routines. There was no way for a C routine to call a Fortran 77 routine and pass arguments by value. Arrays, character strings, or structures are best passed by reference.

To pass a value to a C routine from a Fortran 77 routine, use the nonstandard Fortran function %VAL(arg) as an argument in the call.

In the following example, the Fortran 77 routine passes x by value and y by reference. The C routine incremented both x and y, but only y is changed.

Fortran calls C
Fortran routine: `REAL x, y` `x = 1.` `y = 0.` `PRINT , x,y` `CALL value( %VAL(x), y)` `PRINT , x,y` `END` C routine: `void value_( float x, float y)` `{` `printf("%f, %f\n",x,y);` `x = x + 1.;` `y = y + 1.;` `printf("%f, %f\n",x,y);` `}` Compiling and running produces output:* `1.00000 0.` x and y from Fortran `1.000000, 0.000000` x and y from C `2.000000, 1.000000` new x and y from C `1.00000 1.00000` new x and y from Fortran

Fortran calls C

Fortran routine:

REAL x, y

x = 1.

y = 0.

PRINT *, x,y

CALL value( %VAL(x), y)

PRINT *, x,y

END

C routine:

void value_( float x, float *y)

{

printf("%f, %f\n",x,*y);

x = x + 1.;

*y = *y + 1.;

printf("%f, %f\n",x,*y);

}

Compiling and running produces output:

1.00000 0. x and y from Fortran

1.000000, 0.000000 x and y from C

2.000000, 1.000000 new x and y from C

1.00000 1.00000 new x and y from Fortran

11.5 Functions That Return a Value

A Fortran function that returns a value of type BYTE , INTEGER, REAL, LOGICAL, DOUBLE PRECISION, or REAL*16 is equivalent to a C function that returns a compatible type (see TABLE 11-1). There are two extra arguments for the return values of character functions, and one extra argument for the return values of complex functions.

11.5.1 Returning a Simple Data Type

The following example returns a REAL or float value. BYTE, INTEGER, LOGICAL, DOUBLE PRECISION, and REAL*16 are treated in a similar way:


Fortran calls C	C calls Fortran
`real ADD1, R, S` `external ADD1` `R = 8.0` `S = ADD1( R )` `...` `------------------------------` `float add1_( pf )` `float pf;` `{` `float f ;` `f = pf;` `f++;` `return ( f );` `}`	`float r, s;` `extern float fadd1_() ;` `r = 8.0;` `s = fadd1_( &r );` `...` `------------------------------` `real function fadd1 (p)` `real p` `fadd1 = p + 1.0` `return` `end`

11.5.2 Returning COMPLEX Data

A Fortran function returning COMPLEX or DOUBLE COMPLEX on SPARC V8 platforms is equivalent to a C function with an additional first argument that points to the return value in memory. The general pattern for the Fortran function and its corresponding C function is:

Fortran function	C function
`COMPLEX FUNCTION CF(`a1, a2, ..., an)	`cf_ (`return, a1, a2, ..., an) `struct { float r, i; } `return*

Fortran function

C function

COMPLEX FUNCTION CF(a1, a2, ..., an)

cf_ (return, a1, a2, ..., an)

struct { float r, i; } *return


Fortran calls C	C calls Fortran
`COMPLEX U, V, RETCPX` `EXTERNAL RETCPX` `U = ( 7.0, -8.0)` `V = RETCPX(U)` `...` `------------------------------` `struct complex { float r, i; };` `void retcpx_( temp, w )` `struct complex temp, w;` `{` `temp->r = w->r + 1.0;` `temp->i = w->i + 1.0;` `return;` `}`	`struct complex { float r, i; };` `struct complex c1, c2;` `struct complex u=&c1, v=&c2;` `extern retfpx_();` `u -> r = 7.0;` `u -> i = -8.0;` `retfpx_( v, u );` `...` `------------------------------` `COMPLEX FUNCTION RETFPX(Z)` `COMPLEX Z` `RETFPX = Z + (1.0, 1.0)` `RETURN` `END`

In 64-bit environments and compiling with -xarch=v9, COMPLEX values are returned in floating-point registers: COMPLEX and DOUBLE COMPLEX in %f0 and %f1, and COMPLEX*32 in %f0, %f1, %f2, and %f3. These registers are not directly accessible to C programs, preventing such interoperability between Fortran and C on SPARC V9 platforms for this case.

11.5.3 Returning a CHARACTER String

Passing strings between C and Fortran routines is not encouraged. However, a Fortran character-string-valued function is equivalent to a C function with two additional first arguments--data address and string length. The general pattern for the Fortran function and its corresponding C function is:

Fortran function	C function
`CHARACTER`n `FUNCTION C(`a1, ..., an)*	`void c_ (`result, length, a1, ..., an`)` `char` result`[ ];` `long length;`

Fortran function

C function

CHARACTER*n FUNCTION C(a1, ..., an)

void c_ (result, length, a1, ..., an)

char result[ ];

long length;

Here is an example:


Fortran calls C	C calls Fortran
`CHARACTER STRING16, CSTR9` `STRING = ' '` `STRING = '123' // CSTR('',9)` `...` `------------------------------` `void cstr_( char p2rslt,` `long rslt_len,` `char p2arg,` `int p2n,` `long arg_len )` `{ /* return n copies of arg /` `int count, i;` `char cp;` `count = p2n;` `cp = p2rslt;` `for (i=0; i<count; i++) {` `cp++ = *p2arg ;` `}` `}`	`void fstr_( char , long,` `char , int , long );` `char sbf[9] = "123456789";` `char p2rslt = sbf;` `int rslt_len = sizeof(sbf);` `char ch = '';` `int n = 4;` `int ch_len = sizeof(ch);` ... `/ make n copies of ch in sbf` `/` `fstr_( p2rslt, rslt_len,` `&ch, &n, ch_len );` `...` `------------------------------` `FUNCTION FSTR( C, N)` `CHARACTER FSTR(*), C` `FSTR = ''` `DO I = 1,N` `FSTR(I:I) = C` `END DO` `FSTR(N+1:N+1) = CHAR(0)` `END`

In this example, the C function and calling C routine must accommodate two initial extra arguments (a pointer to the result string and the length of the string) and one additional argument at the end of the list (length of character argument). Note that in the Fortran routine called from C, it is necessary to explicitly add a final null character. Fortran strings are not null-terminated by default.

11.6 Labeled COMMON

Fortran labeled COMMON can be emulated in C by using a global struct.


Fortran COMMON Definition	C "COMMON" Definition
`COMMON /BLOCK/ ALPHA,NUM` `...`	`extern struct block {` `float alpha;` `int num;` `};` `extern struct block block_ ;` `main ()` `{` `...` `block_.alpha = 32.;` `block_.num += 1;` `...` `}`

Note that the external name established by the C routine must end in an underscore to link with the block created by the Fortran program. Note also that the C directive #pragma pack may be needed to get the same padding as with Fortran.

f95 aligns data in common blocks to at most 4-byte boundaries by default. To obtain the natural alignment for all data elements inside a common block and match the default structure alignment, use -aligncommon=16 when compiling the Fortran routines.

11.7 Sharing I/O Between Fortran and C

Mixing Fortran I/O with C I/O (issuing I/O calls from both C and Fortran routines) is not recommended. It is better to do all Fortran I/O or all C I/O, not both.

The Fortran I/O library is implemented largely on top of the C standard I/O library. Every open unit in a Fortran program has an associated standard I/O file structure. For the stdin, stdout, and stderr streams, the file structure need not be explicitly referenced, so it is possible to share them.

If a Fortran main program calls C to do I/O, the Fortran I/O library must be initialized at program startup to connect units 0, 5, and 6 to stderr, stdin, and stdout, respectively. The C function must take the Fortran I/O environment into consideration to perform I/O on open file descriptors.

However, if a C main program calls a Fortran subprogram to do I/O, the automatic initialization of the Fortran I/O library to connect units 0, 5, and 6 to stderr, stdin, and stdout is lacking. This connection is normally made by a Fortran main program. If a Fortran function attempts to reference the stderr stream (unit 0) without the normal Fortran main program I/O initialization, output will be written to fort.0 instead of to the stderr stream.

The C main program can initialize Fortran I/O and establish the preconnection of units 0, 5, and 6 by calling the f_init() library routine at the start of the program and, optionally, f_exit() at termination.

Remember: even though the main program is in C, you should link with f95.

11.8 Alternate Returns

Fortran 77's alternate returns mechanism is obsolete and should not be used if portability is an issue. There is no equivalent in C to alternate returns, so the only concern would be for a C routine calling a Fortran routine with alternate returns. Forte Developer Fortran 95 will accept Fortran 77 alternate returns, but its use should be discouraged.

The implementation returns the int value of the expression on the RETURN statement. This is implementation dependent and its use should be avoided.


C calls Fortran	Running the Example
`int altret_ ( int * );` `main ()` `{` `int k, m ;` `k =0;` `m = altret_( &k ) ;` `printf( "%d %d\n", k, m);` `}` `------------------------------` `SUBROUTINE ALTRET( I, , )` `INTEGER I` `I = I + 1` `IF(I .EQ. 0) RETURN 1` `IF(I .GT. 0) RETURN 2` `RETURN` `END`	`demo%` `cc -c tst.c` `demo%` `f95 -o alt alt.f tst.o` `alt.f:` `altret:` `demo%` `alt` `1 2` The C routine receives the return value 2 from the Fortran routine because it executed the RETURN 2 statement.