Detailed Descriptions of the XL Fortran Compiler Options

The following alphabetical list of options provides all the information you should need to use each option effectively.

How to read the syntax information:

-# Option

Syntax

-#

Generates information on the progress of the compilation without actually running the individual components.

Rules

At the points where the compiler executes commands to perform different compilation steps, this option displays a simulation of the system calls it would do and the system argument lists it would pass, but it does not actually perform these actions.

Examining the output of this option can help you quickly and safely determine the following information for a particular compilation:

It avoids the overhead of compiling the source code and avoids overwriting any existing files, such as .lst files. (For those who are familiar with the make command, it is similar to make -n.)

Note that if you specify this option with -qipa, the compiler does not display linker information subsequent to the IPA link step. This is because the compiler does not actually call IPA.

Related Information

The -v Option and -V Option produce the same output but also performs the compilation.

-1 Option

Syntax

-1
ONETRIP | NOONETRIP

Executes each DO loop in the compiled program at least once if its DO statement is executed, even if the iteration count is 0. This option provides compatibility with FORTRAN 66. The default is to follow the behavior of later Fortran standards, where DO loops are not performed if the iteration count is 0.

Restrictions

It has no effect on FORALL statements, FORALL constructs, or array constructor implied-DO loops.

Related Information

-qonetrip is the long form of -1.

-B Option

Syntax

-Bprefix

Determines a substitute path name for executable files used during compilation, such as the compiler or linker. It can be used in combination with the -t option, which determines which of these components are affected by -B.

Arguments

prefix is the name of a directory where the alternative executable files reside. It must end in a / (slash).

Rules

To form the complete path name for each component, the driver program adds prefix to the standard program names. You can restrict the components that are affected by this option by also including one or more -tmnemonic options.

You can also specify default path names for these commands in the configuration file.

This option allows you to keep multiple levels of some or all of the XL Fortran components or to try out an upgraded component before installing it permanently. When keeping multiple levels of XL Fortran available, you might want to put the appropriate -B and -t options into a configuration-file stanza and to use the -F option to select the stanza to use.

Examples

In this example, an earlier level of the XL Fortran components is installed in the directory /opt/ibmcmp/xlf/8.1/exe. To test the upgraded product before making it available to everyone, the system administrator restores the latest install image under the directory /Users/jim and then tries it out with commands similar to:

/Users/jim/opt/ibmcmp/xlf/8.1/bin/xlf95 \
      -tFcbhIz -B/Users/jim/opt/ibmcmp/xlf/8.1/exe/ test_suite.f

Once the upgrade meets the acceptance criteria, the system administrator installs it over the old level in /opt/ibmcmp/xlf/8.1.

Related Information

See -t Option, -F Option, and Customizing the Configuration File.

-C Option

Syntax

-C
CHECK | NOCHECK

Checks each reference to an array element, array section, or character substring for correctness.

Rules

At compile time, if the compiler can determine that a reference goes out of bounds, the severity of the error reported is increased to S (severe) when this option is specified.

At run time, if a reference goes out of bounds, the program generates a SIGTRAP signal. By default, this signal ends the program and produces a core dump.

Because the run-time checking can slow execution, you should decide which is the more important factor for each program: the performance impact or the possibility of incorrect results if an error goes undetected. You might decide to use this option only while testing and debugging a program (if performance is more important) or also for compiling the production version (if safety is more important).

Related Information

The -C option prevents some of the optimizations that the -qhot Option performs. You may want to remove the -C option after debugging of your code is complete and to add the -qhot option to achieve a more thorough optimization.

The valid bounds for character substring expressions differ depending on the setting of the -qzerosize option. See -qzerosize Option.

-qsigtrap Option and Installing an Exception Handler describe how to detect and recover from SIGTRAP signals without ending the program.

-qcheck is the long form of -C.

-c Option

Syntax

-c

Prevents the completed object file from being sent to the ld command for link-editing. With this option, the output is a .o file for each source file.

Using the -o option in combination with -c selects a different name for the .o file. In this case, you can only compile one source file at a time.

Related Information

See -o Option.

-D Option

Syntax

-D
DLINES | NODLINES

Specifies whether the compiler compiles fixed source form lines with a D in column 1 or treats them as comments.

If you specify -D, the fixed source form lines that have a D in column 1 are compiled. The default action is to treat these lines as comment lines. They are typically used for sections of debugging code that need to be turned on and off.

Related Information

-qdlines is the long form of -D.

-d Option

Syntax

-d

Causes preprocessed source files that are produced by cpp to be kept rather than to be deleted.

Rules

The files that this option produces have names of the form Ffilename.f, derived from the names of the original source files.

Related Information

See Passing Fortran Files through the C Preprocessor.

-F Option

Syntax

-Fconfig_file | -Fconfig_file:stanza | -F:stanza

Specifies an alternative configuration file, which stanza to use within the configuration file, or both.

The configuration file specifies different kinds of defaults, such as options for particular compilation steps and the locations of various files that the compiler requires. A default configuration file (/etc/opt/ibmcmp/xlf/8.1/xlf.cfg) is supplied at installation time. The default stanza depends on the name of the command used to invoke the compiler (xlf90, xlf90_r, xlf95, xlf95_r, xlf, xlf_r, f77, or fort77).

A simple way to customize the way the compiler works, as an alternative to writing complicated compilation scripts, is to add new stanzas to /etc/opt/ibmcmp/xlf/8.1/xlf.cfg, giving each stanza a different name and a different set of default compiler options. You may find the single, centralized file easier to maintain than many scattered compilation scripts and makefiles.

By running the compiler with an appropriate -F option, you can select the set of options that you want. You might have one set for full optimization, another set for full error checking, and so on.

Restrictions

Because the default configuration file is replaced each time a new compiler release is installed, make sure to save a copy of any new stanzas or compiler options that you add.

Examples

 # Use stanza debug in default xlf.cfg.
   xlf95 -F:debug t.f
 
# Use stanza xlf95 in /Users/fred/xlf.cfg.
   xlf95 -F/Users/fred/xlf.cfg t.f
 
# Use stanza myxlf in /Users/fred/xlf.cfg.
   xlf95 -F/Users/fred/xlf.cfg:myxlf t.f

Related Information

Customizing the Configuration File explains the contents of a configuration file and tells how to select different stanzas in the file without using the -F option.

-g Option

Syntax

-g
DBG | NODBG

Generates debug information for use by a symbolic debugger.

Related Information

See Debugging a Fortran 90 or Fortran 95 Program and Symbolic Debugger Support.

-qdbg is the long form of -g.

-I Option

Syntax

-Idir

Adds a directory to the search path for include files and .mod files. If XL Fortran calls cpp, this option adds a directory to the search path for #include files. Before checking the default directories for include and .mod files, the compiler checks each directory in the search path. For include files, this path is only used if the file name in an INCLUDE line is not provided with an absolute path. For #include files, refer to the cpp documentation for the details of the -I option.

Arguments

dir must be a valid path name (for example, /home/dir, /tmp, or ./subdir).

Rules

The compiler appends a / to the dir and then concatenates that with the file name before making a search. If you specify more than one -I option on the command line, files are searched in the order of the dir names as they appear on the command line.

The following directories are searched, in this order, after any paths that are specified by -I options:

  1. The current directory (from which the compiler is executed)
  2. The directory where the source file is (if different from 1)
  3. /usr/include.

Also, the compiler will search /opt/ibmcmp/xlf/8.1/include where include and .mod files shipped with the compiler are located.

Related Information

The -qmoddir Option puts .mod files in a specific directory when you compile a file that contains modules.

-k Option

Syntax

-k
FREE(F90)

Specifies that the program is in free source form.

Applicable Product Levels

The meaning of this option has changed from XL Fortran Version 2. To get the old behavior of -k, use the option -qfree=ibm instead.

Related Information

See -qfree Option and Free Source Form in the XL Fortran Advanced Edition for Mac OS X Language Reference.

This option is the short form of -qfree=f90.

-L Option

Syntax

-Ldir

Looks in the specified directory for libraries that are specified by the -l option. If you use libraries other than the default ones in /opt/ibmcmp/xlf/8.1/lib, you can specify one or more -L options that point to the locations of the other libraries.

Rules

This option is passed directly to the ld command and is not processed by XL Fortran at all.

Related Information

See Options That Control Linking and Linking XL Fortran Programs.

-l Option

Syntax

-lkey

Searches the specified library file, where key selects the library libkey.dylib or libkey.a.

Rules

This option is passed directly to the ld command and is not processed by XL Fortran at all.

Related Information

See Options That Control Linking and Linking XL Fortran Programs.

-N Option

Syntax

-NSbytes
SPILLSIZE(bytes)

Specifies the size of internal program storage areas.

Rules

It defines the number of bytes of stack space to reserve in each subprogram, in case there are too many variables to hold in registers and the program needs temporary storage for register contents.

Defaults

By default, each subprogram stack has 512 bytes of spill space reserved.

If you need this option, a compile-time message informs you of the fact.

Related Information

-qspillsize is the long form of -NS.

-O Option

Syntax

-O[level]
OPTimize[(level)] | NOOPTimize

Specifies whether to optimize code during compilation and, if so, at which level:

Arguments

not specified
Almost all optimizations are disabled. This is equivalent to specifying -O0 or -qnoopt.

-O
For each release of XL Fortran, -O enables the level of optimization that represents the best combination of compilation speed and run-time performance. If you need a specific level of optimization, specify the appropriate numeric value. Currently, -O is equivalent to -O2.

-O0
Almost all optimizations are disabled. This option is equivalent to -qnoopt.

-O1
Reserved for future use. This form does not currently do any optimization and is ignored. In past releases, it was interpreted as a combination of the -O and -1 options, which may have had unintended results.

-O2
Performs a set of optimizations that are intended to offer improved performance without an unreasonable increase in time or storage that is required for compilation.

-O3
Performs additional optimizations that are memory intensive, compile-time intensive, and may change the semantics of the program slightly, unless -qstrict is specified. We recommend these optimizations when the desire for run-time speed improvements outweighs the concern for limiting compile-time resources.

This level of optimization also affects the setting of the -qfloat option, turning on the fltint and rsqrt suboptions by default, and sets -qmaxmem=-1.

-O4
Aggressively optimizes the source program, trading off additional compile time for potential improvements in the generated code. You can specify the option at compile time or at link time. If you specify it at link time, it will have no effect unless you also specify it at compile time for at least the file that contains the main program.

-O4 implies the following other options:

Note that the auto setting of -qarch, -qtune, and -qcache implies that the execution environment will be the same as the compilation environment.

This option follows the "last option wins" conflict resolution rule, so any of the options that are modified by -O4 can be subsequently changed. Specifying -O4 -qarch=ppcv allows aggressive intraprocedural optimization while maintaining code portability.

-O5
Provides all of the functionality of the -O4 option, but also provides the functionality of the -qipa=level=2 option.

Restrictions

Generally, use the same optimization level for both the compile and link steps. This is important when using either the -O4 or -O5 optimization level to get the best run-time performance. For the -O5 level, all loop transformations (as specified via the -qhot option) are done at the link step.

Increasing the level of optimization may or may not result in additional performance improvements, depending on whether the additional analysis detects any further optimization opportunities.

An optimization level of -O3 or higher can change the behavior of the program and potentially cause exceptions that would not otherwise occur. Use of the -qstrict option can eliminate potential changes and exceptions.

Compilations with optimization may require more time and machine resources than other compilations.

The more the compiler optimizes a program, the more difficult it is to debug the program with a symbolic debugger.

Related Information

-qstrict Option shows how to turn off the effects of -O3 that might change the semantics of a program.

-qipa Option, -qhot Option, and -qpdf Option turn on additional optimizations that may improve performance for some programs.

Optimizing XL Fortran Programs discusses technical details of the optimization techniques the compiler uses and some strategies you can use to get maximum performance from your code.

-qOPTimize is the long form of -O.

-o Option

Syntax

-o name

Specifies a name for the output object, executable, or assembler source file.

To choose the name for an object file, use this option in combination with the -c option.

Defaults

The default name for an executable file is a.out. The default name for an object source file is the same as the source file except that it has a .o extension.

Rules

Except when you specify the -c option, the -o option is passed directly to the ld command, instead of being processed by XL Fortran.

Examples

xlf95 t.f                    # Produces "a.out"
xlf95 -c t.f                 # Produces "t.o"
xlf95 -o test_program t.f    # Produces "test_program"
 

-p Option

Syntax

-p[g]

Sets up the object file for profiling.

-p or -pg prepares the program for profiling. When you execute the program, it produces a gmon.out file with the profiling information. You can then use the gprof command to generate a run-time profile.

Rules

For profiling, the compiler produces monitoring code that counts the number of times each routine is called. The compiler replaces the startup routine of each subprogram with one that calls the monitor subroutine at the start. When the program ends normally, it writes the recorded information to the gmon.out file.

Examples


$ xlf95 -pg needs_tuning.f
$ a.out
$ gprof
 .
 .
 .
 
detailed and verbose profiling data
 .
 .
 .
 

Related Information

For more information on profiling and the gprof command, see the man pages for this command.

-qalias Option

Syntax

-qalias={[no]aryovrlp | [no]intptr | [no]pteovrlp | [no]std}...
ALIAS( {[NO]ARYOVRLP | [NO]INTPTR | [NO]PTEOVRLP | [NO]STD}... )

Indicates whether a program contains certain categories of aliasing. The compiler limits the scope of some optimizations when there is a possibility that different names are aliases for the same storage locations.

Arguments

aryovrlp | noaryovrlp
Indicates whether the compilation units contain any array assignments between storage-associated arrays. If not, specify noaryovrlp to improve performance.

intptr | nointptr
Indicates whether the compilation units contain any integer POINTER statements. If so, specify INTPTR.

pteovrlp | nopteovrlp
Indicates whether any pointee variables may be used to refer to any data objects that are not pointee variables, or whether two pointee variables may be used to refer to the same storage location. If not, specify NOPTEOVRLP.

std | nostd
Indicates whether the compilation units contain any nonstandard aliasing (which is explained below). If so, specify nostd.

Rules

An alias exists when an item in storage can be referred to by more than one name. The Fortran 90 and Fortran 95 standards allow some types of aliasing and disallow some others. The sophisticated optimizations that the XL Fortran compiler performs increase the likelihood of undesirable results when nonstandard aliasing is present, as in the following situations:

Applicable Product Levels

The introduction of the -qipa option does not remove the need for -qalias.

Examples of aryovrlp/noaryovrlp/pteovrlp

If the following subroutine is compiled with -qalias=nopteovrlp, the compiler may be able to generate more efficient code. You can compile this subroutine with -qalias=nopteovrlp, because the integer pointers, ptr1 and ptr2, point at dynamically allocated memory only.

  subroutine sub(arg)
      real arg
      pointer(ptr1, pte1)
      pointer(ptr2, pte2)
      real pte1, pte2
 
      ptr1 = malloc(%val(4))
      ptr2 = malloc(%val(4))
      pte1 = arg*arg
      pte2 = int(sqrt(arg))
      arg = pte1 + pte2
      call free(%val(ptr1))
      call free(%val(ptr2))
  end subroutine 

If most array assignments in a compilation unit involve arrays that do not overlap but a few assignments do involve storage-associated arrays, you can code the overlapping assignments with an extra step so that the NOARYOVRLP suboption is still safe to use.

@PROCESS ALIAS(NOARYOVRLP)
! The assertion that no array assignments involve overlapping
! arrays allows the assignment to be done without creating a
! temporary array.
      program test
        real(8) a(100)
        integer :: j=1, k=50, m=51, n=100
 
        a(1:50) = 0.0d0
        a(51:100) = 1.0d0
 
        ! Timing loop to achieve accurate timing results
        do i = 1, 1000000
           a(j:k) = a(m:n)    ! Here is the array assignment
        end do
 
        print *, a
      end program

In Fortran, this aliasing is not permitted if J or K are updated, and, if it is left undetected, it can have unpredictable results.

! We cannot assert that this unit is free
! of array-assignment aliasing because of the assignments below.
      subroutine sub1
      integer a(10), b(10)
      equivalence (a, b(3))
      a = b          ! a and b overlap.
      a = a(10:1:-1) ! The elements of a are reversed.
      end subroutine
 
! When the overlapping assignment is recoded to explicitly use a
! temporary array, the array-assignment aliasing is removed.
! Although ALIAS(NOARYOVRLP) does not speed up this assignment,
! subsequent assignments of non-overlapping arrays in this unit
! are optimized.
@PROCESS ALIAS(NOARYOVRLP)
      subroutine sub2
      integer a(10), b(10), t(10)
      equivalence (a, b(3))
      t = b; a = t
      t = a(10:1:-1); a = t
      end subroutine

When SUB1 is called, an alias exists between J and K. J and K refer to the same item in storage.

       CALL SUB1(I,I)
       ...
       SUBROUTINE SUB1(J,K)

In the following example, the program might store 5 instead of 6 into J unless -qalias=nostd indicates that an alias might exist.

       INTEGER BIG(1000)
       INTEGER SMALL(10)
       COMMON // BIG
       EQUIVALENCE(BIG,SMALL)
       ...
       BIG(500) = 5
       SMALL (I) = 6   ! Where I has the value 500
       J = BIG(500)

Restrictions

Because this option inhibits some optimizations of some variables, using it can lower performance.

Programs that contain nonstandard or integer POINTER aliasing may produce incorrect results if you do not compile them with the correct -qalias settings. The xlf90, xlf90_r, xlf95, and xlf95_r commands assume that a program contains only standard aliasing (-qalias=aryovrlp:pteovrlp:std:nointptr), while the xlf_r, xlf, and f77/fort77 commands assume that integer POINTERs may be present (-qalias=aryovrlp:pteovrlp:std:intptr).

-qalign Option

Syntax

-qalign={[no]4k|struct={natural|packed|port}}
ALIGN({[NO]4K|STRUCT{(natural)|(packed)|(port)}})

Specifies the alignment of data objects in storage, which avoids performance problems with misaligned data. Both the [no]4k and struct options can be specified and are not mutually exclusive. The default setting is -qalign=no4k:struct=natural. The [no]4K option is useful primarily in combination with logical volume I/O and disk striping.

Arguments

[no]4K
Specifies whether to align large data objects on page (4 KB) boundaries, for improved performance with data-striped I/O. Objects are affected depending on their representation within the object file. The affected objects are arrays and structures that are 4 KB or larger and are in static or bss storage and also CSECTs (typically COMMON blocks) that are 8 KB or larger. A large COMMON block, equivalence group containing arrays, or structure is aligned on a page boundary, so the alignment of the arrays depends on their position within the containing object. Inside a structure of non-sequence derived type, the compiler adds padding to align large arrays on page boundaries.

struct
The struct option specifies how objects or arrays of a derived type declared using a record structure are stored, and whether or not padding is used between components. All program units must be compiled with the same settings of the -qalign=struct option. The three suboptions available are:

packed
If the packed suboption of the struct option is specified, objects of a derived type are stored with no padding between components, other than any padding represented by %FILL components. The storage format is the same as would result for a sequence structure whose derived type was declared using a standard derived type declaration.

natural
If the natural suboption of the struct option is specified, objects of a derived type are stored with sufficient padding that components will be stored on their natural alignment boundaries, unless storage association requires otherwise. The natural alignment boundaries for objects of a type that appears in the left-hand column of the following table is shown in terms of a multiple of some number of bytes in the corresponding entry in the right-hand column of the table.
Type Natural Alignment (in multiples of bytes)
INTEGER(1), LOGICAL(1), BYTE, CHARACTER 1
INTEGER(2), LOGICAL(2) 2
INTEGER(4), LOGICAL(4), REAL(4) 4
INTEGER(8), LOGICAL(8), REAL(8), COMPLEX(4) 8
REAL(16), COMPLEX(8), COMPLEX(16) 16
Derived Maximum alignment of its components

If the natural suboption of the struct option is specified, arrays of derived type are stored so that each component of each element is stored on its natural alignment boundary, unless storage association requires otherwise.

port

If the port suboption of the struct option is specified,

  • Storage padding is the same as described above for the natural suboption, with the exception that the alignment of components of type complex is the same as the alignment of components of type real of the same kind.
  • The padding for an object that is immediately followed by a union is inserted at the begining of the first map component for each map in that union.

Restrictions

The port suboption does not affect any arrays or structures with the AUTOMATIC attribute or arrays that are allocated dynamically. Because this option may change the layout of non-sequence derived types, when compiling programs that read or write such objects with unformatted files, use the same setting for this option for all source files.

Related Information

You can tell if an array has the AUTOMATIC attribute and is thus unaffected by -qalign=4k if you look for the keywords AUTOMATIC or CONTROLLED  AUTOMATIC in the listing of the -qattr Option. This listing also shows the offsets of data objects.

-qarch Option

Syntax

-qarch=architecture

Controls which instructions the compiler can generate. Changing the default can improve performance but might produce code that can only be run on specific machines.

Arguments

The choices for architecture are:

auto
Automatically detects the specific architecture of the compiling machine. It assumes that the execution environment will be the same as the compilation environment.

g5
Generates instructions specific to G5 processors. This is currently equivalent to specifying -qarch=ppc970.

ppc970
Generates instructions specific to PowerPC 970 processors.

ppcv
Generates instructions for generic PowerPC chips with AltiVec vector processors. This is the default.
Note:
The -qarch setting determines the allowed choices and defaults for the -qtune setting.You can use -qarch and -qtune to target your program to particular machines.

If you intend your program to run only on a particular architecture, you can use the -qarch option to instruct the compiler to generate code specific to that architecture. This allows the compiler to take advantage of machine-specific instructions that can improve performance. The -qarch option provides arguments for you to specify certain chip models; for example, you can specify -qarch=ppc970 to indicate that your program will be executed on Power PC 970 hardware platforms.

For a given application program, make sure that you specify the same -qarch setting when you compile each of its source files.

You can further enhance the performance of programs intended for specific machines by using other perfomance-related options like the -qcache and -qhot options.

Use these guidelines to help you decide whether to use this option:

Related Information

See Compiling for PowerPC Systems, -qtune Option, and -qcache Option.

-qassert Option

Syntax

-qassert={
   deps | nodeps |
   itercnt=n}

Provides information about the characteristics of the files that can help to fine-tune optimizations.

Arguments

nodeps
Specifies that no loop-carried dependencies exist.

itercnt
Specifies a value for unknown loop iteration counts.

Related Information

See Cost Model for Loop Transformations for background information and instructions for using these assertions. See also the description of the ASSERT directive in the XL Fortran Advanced Edition for Mac OS X Language Reference.

-qattr Option

Syntax

-qattr[=full] | -qnoattr
ATTR[(FULL)] | NOATTR

Specifies whether to produce the attribute component of the attribute and cross-reference section of the listing.

Arguments

If you specify only -qattr, only identifiers that are used are reported. If you specify -qattr=full, all identifiers, whether referenced or not, are reported.

If you specify -qattr after -qattr=full, the full attribute listing is still produced.

You can use the attribute listing to help debug problems caused by incorrectly specified attributes or as a reminder of the attributes of each object while writing new code.

Related Information

See Options That Control Listings and Messages and Attribute and Cross-Reference Section.

-qautodbl Option

Syntax

-qautodbl=setting
AUTODBL(setting

Compatibility Benefits

Provides an automatic means of converting single-precision floating-point calculations to double-precision and of converting double-precision calculations to extended-precision.

You might find this option helpful in porting code where storage relationships are significant and different from the XL Fortran defaults. For example, programs that are written for the IBM VS FORTRAN compiler may rely on that compiler's equivalent option.

Suboptions

The -qautodbl suboptions offer different strategies to preserve storage relationships between objects that are promoted or padded and those that are not.

The settings you can use are as follows:

none
Does not promote or pad any objects that share storage. This setting is the default.

dbl4
Promotes floating-point objects that are single-precision (4 bytes in size) or that are composed of such objects (for example, COMPLEX or array objects):

This suboption requires the libxlfpmt4.a library during linking.

dbl8
Promotes floating-point objects that are double-precision (8 bytes in size) or that are composed of such objects:

This suboption requires the libxlfpmt8.a library during linking.

dbl
Combines the promotions that dbl4 and dbl8 perform.

This suboption requires the libxlfpmt4.a and libxlfpmt8.a libraries during linking.

dblpad4
Performs the same promotions as dbl4 and pads objects of other types (except CHARACTER) if they could possibly share storage with promoted objects.

This suboption requires the libxlfpmt4.a and libxlfpad.a libraries during linking.

dblpad8
Performs the same promotions as dbl8 and pads objects of other types (except CHARACTER) if they could possibly share storage with promoted objects.

This suboption requires the libxlfpmt8.a and libxlfpad.a libraries during linking.

dblpad
Combines the promotions done by dbl4 and dbl8 and pads objects of other types (except CHARACTER) if they could possibly share storage with promoted objects.

This suboption requires the libxlfpmt4.a, libxlfpmt8.a, and libxlfpad.a libraries during linking.

Linking

If the appropriate -qautodbl option is specified during linking, the program is automatically linked with the necessary extra libraries. Otherwise, you must link them in manually.

Usage

By using dbl4 or dblpad4, you can increase the size of REAL(4) objects without turning REAL(8) objects into REAL(16)s. REAL(16) is less efficient in calculations than REAL(8) is.

The -qautodbl option handles calls to intrinsics with arguments that are promoted; when necessary, the correct higher-precision intrinsic function is substituted. For example, if single-precision items are being promoted, a call in your program to SIN automatically becomes a call to DSIN.

Restrictions

Related Information

For background information on promotion, padding, and storage/value relationships and for some source examples, see Implementation Details for -qautodbl Promotion and Padding.

-qrealsize Option describes another option that works like -qautodbl, but it only affects items that are of default kind type and does not do any padding. If you specify both the -qrealsize and the -qautodbl options, only -qautodbl takes effect. Also, -qautodbl overrides the -qdpc option.

-qcache Option

Syntax

-qcache=
{
   assoc=number |
   auto |
   cost=cycles |
   level=level |
   line=bytes |
   size=Kbytes |
   type={C|c|D|d|I|i}
}[:...]

Specifies the cache configuration for a specific execution machine. The compiler uses this information to tune program performance, especially for loop operations that can be structured (or blocked) to process only the amount of data that can fit into the data cache.

If you know exactly what type of system a program is intended to be executed on and that system has its instruction or data cache configured differently from the default case (as governed by the -qtune setting), you can specify the exact characteristics of the cache to allow the compiler to compute more precisely the benefits of particular cache-related optimizations.

For the -qcache option to have any effect, you must include the level and type suboptions and specify at least level 2 of -O.

Guidelines

Suboptions

assoc=number
Specifies the set associativity of the cache:

0
Direct-mapped cache

1
Fully associative cache

n > 1
n-way set-associative cache

auto
Automatically detects the specific cache configuration of the compiling machine. It assumes that the execution environment will be the same as the compilation environment.

cost=cycles
Specifies the performance penalty that results from a cache miss so that the compiler can decide whether to perform an optimization that might result in extra cache misses.

level=level
Specifies which level of cache is affected:

1
Basic cache

2
Level-2 cache or the table lookaside buffer (TLB) if the machine has no level-2 cache

3
TLB in a machine that does have a level-2 cache

Other levels are possible but are currently undefined. If a system has more than one level of cache, use a separate -qcache option to describe each level.

line=bytes
Specifies the line size of the cache.

size=Kbytes
Specifies the total size of this cache.

type={C|c| D|d|I|i}
Specifies the type of cache that the settings apply to, as follows:

Restrictions

If you specify the wrong values for the cache configuration or run the program on a machine with a different configuration, the program may not be as fast as possible but will still work correctly. Remember, if you are not sure of the exact values for cache sizes, use a conservative estimate.

Currently, the -qcache option only has an effect when you also specify the -qhot option.

Examples

To tune performance for a system with a combined instruction and data level-1 cache where the cache is two-way associative, 8 KB in size, and has 64-byte cache lines:

  xlf95 -O3 -qhot -qcache=type=c:level=1:size=8:line=64:assoc=2 file.f

To tune performance for a system with two levels of data cache, use two -qcache options:

  xlf95 -O3 -qhot -qcache=type=D:level=1:size=256:line=256:assoc=4 \
        -qcache=type=D:level=2:size=512:line=256:assoc=2 file.f

To tune performance for a system with two types of cache, again use two -qcache options:

  xlf95 -O3 -qhot -qcache=type=D:level=1:size=256:line=256:assoc=4 \
        -qcache=type=I:level=1:size=512:line=256:assoc=2 file.f

Related Information

See -qtune Option, -qarch Option, and -qhot Option.

-qcclines Option

Syntax

-qcclines | -qnocclines
CCLINES |  NOCCLINES

Determines whether the compiler recognizes conditional compilation lines in fixed source form and F90 free source form. IBM free source form is not supported.

Defaults

The default is -qnocclines.

Related Information

See Conditional Compilation in the Language Elements section of the XL Fortran Advanced Edition for Mac OS X Language Reference.

-qcharlen Option

Syntax

-qcharlen=length
CHARLEN(length)

Obsolete. It is still accepted, but it has no effect. The maximum length for character constants and subobjects of constants is 32 767 bytes (32 KB). The maximum length for character variables is 268 435 456 bytes (256 MB).

-qcheck Option

Syntax

-qcheck | -qnocheck
CHECK | NOCHECK

-qcheck is the long form of the -C Option.

-qci Option

Syntax

-qci=numbers
CI(numbers)

Specifies the identification numbers (from 1 to 255) of the INCLUDE lines to process. If an INCLUDE line has a number at the end, the file is only included if you specify that number in a -qci option. The set of identification numbers that is recognized is the union of all identification numbers that are specified on all occurrences of the -qci option.

This option allows a kind of conditional compilation because you can put code that is only sometimes needed (such as debugging WRITE statements, additional error-checking code, or XLF-specific code) into separate files and decide for each compilation whether to process them.

Examples

REAL X /1.0/
INCLUDE 'print_all_variables.f' 1
X = 2.5
INCLUDE 'print_all_variables.f' 1
INCLUDE 'test_value_of_x.f' 2
END

In this example, compiling without the -qci option simply declares X and assigns it a value. Compiling with -qci=1 includes two instances of an include file, and compiling with -qci=1:2 includes both include files.

Restrictions

Because the optional number in INCLUDE lines is not a widespread Fortran feature, using it may restrict the portability of a program.

Related Information

See the section on the INCLUDE directive in the XL Fortran Advanced Edition for Mac OS X Language Reference.

-qcommon Option

Syntax

-qcommon | -qnocommon
COMMON| NOCOMMON

Controls whether global variables are allocated in the common or data section of object file.

By default, all uninitialized global variables are allocated in the common section. When -qnocommon is set, global variables are allocated in the data section of the object file. Setting -qnocommon prevents global variables from being simultaneously defined in different object files. Common symbols cannot be used in shared libraries.

-qcompact Option

Syntax

-qcompact | -qnocompact
COMPACT | NOCOMPACT

Reduces optimizations that increase code size.

By default, some techniques the optimizer uses to improve performance may also make the program larger. For systems with limited storage, you can use -qcompact to reduce the expansion that takes place.

Rules

With -qcompact in effect, other optimization options still work; the reductions in code size come from limiting code replication that is done automatically during optimization.

-qcr Option

Syntax

-qcr | -qnocr
 

Allows you to control how the compiler interprets the CR (carriage return) character. By default, the CR (Hex value X'0d') or LF (Hex value X'0a') character, or the CRLF (Hex value X'0d0a') combination indicates line termination in a source file. This allows you to compile code written using a Mac OS or DOS/Windows editor.

If you specify -qnocr, the compiler recognizes only the LF character as a line terminator. You must specify -qnocr if you use the CR character for a purpose other than line termination.

-qctyplss Option

Syntax

-qctyplss[(=[no]arg)] | -qnoctyplss
CTYPLSS[([NO]ARG)]| NOCTYPLSS
 

Specifies whether character constant expressions are allowed wherever typeless constants may be used. This language extension might be needed when you are porting programs from other platforms.

Arguments

arg | noarg
Suboptions retain the behavior of -qctyplss. Additionally, arg specifies that Hollerith constants used as actual arguments will be treated as integer actual arguments.

Rules

With -qctyplss, character constant expressions are treated as if they were Hollerith constants and thus can be used in logical and arithmetic expressions.

Restrictions

Examples

Example 1: In the following example, the compiler option -qctyplss allows the use of a character constant expression.

@PROCESS CTYPLSS
      INTEGER I,J
      INTEGER, PARAMETER :: K(1) = (/97/)
      CHARACTER, PARAMETER :: C(1) = (/'A'/)
 
      I = 4HABCD          ! Hollerith constant
      J = 'ABCD'          ! I and J have the same bit representation
 
! These calls are to routines in other languages.
      CALL SUB(%VAL('A')) ! Equivalent to CALL SUB(97)
      CALL SUB(%VAL(1HA)) ! Equivalent to CALL SUB(1627389952)"
 
! These statements are not allowed because of the constant-array
! restriction.
!     I = C // C
!     I = C(1)
!     I = CHAR(K(1))
      END

Example 2: In the following example, the variable J is passed by reference. The suboption arg specifies that the Hollerith constant is passed as if it were an integer actual argument.

@PROCESS CTYPLSS(ARG)
      INTEGER :: J
 
      J = 3HIBM
! These calls are to routines in other languages.
      CALL SUB(J)
      CALL SUB(3HIBM)   ! The Hollerith constant is passed as if
                        ! it were an integer actual argument
 

Related Information

See Hollerith Constants in the XL Fortran Advanced Edition for Mac OS X Language Reference and Passing Arguments By Reference or By Value.

-qdbg Option

Syntax

-qdbg | -qnodbg
DBG | NODBG

-qdbg is the long form of the -g Option.

-qddim Option

Syntax

-qddim | -qnoddim
DDIM | NODDIM

Specifies that the bounds of pointee arrays are re-evaluated each time the arrays are referenced and removes some restrictions on the bounds expressions for pointee arrays.

Rules

By default, a pointee array can only have dimension declarators containing variable names if the array appears in a subprogram, and any variables in the dimension declarators must be dummy arguments, members of a common block, or use- or host-associated. The size of the dimension is evaluated on entry to the subprogram and remains constant during execution of the subprogram.

With the -qddim option:

Examples

@PROCESS DDIM
INTEGER PTE, N, ARRAY(10)
POINTER (P, PTE(N))
DO I=1, 10
   ARRAY(I)=I
END DO
N = 5
P = LOC(ARRAY(2))
PRINT *, PTE   ! Print elements 2 through 6.
N = 7          ! Increase the size.
PRINT *, PTE   ! Print elements 2 through 8.
END

-qdirective Option

Syntax

-qdirective[=directive_list] | -qnodirective[=directive_list]
DIRECTIVE[(directive_list)] | NODIRECTIVE[(directive_list)]

Specifies sequences of characters, known as trigger constants, that identify comment lines as compiler comment directives.

Background Information

A directive is a line that is not a Fortran statement but is recognized and acted on by the compiler. The compiler always recognizes some directives, such as @PROCESS. To allow you maximum flexibility, any new directives that might be provided with the XL Fortran compiler in the future will be placed inside comment lines. This avoids portability problems if other compilers do not recognize the directives.

Defaults

The compiler recognizes the default trigger constant IBM*.

Arguments

The -qnodirective option with no directive_list turns off all previously specified directive identifiers; with a directive_list, it turns off only the selected identifiers.

-qdirective with no directive_list turns on the default trigger constant IBM* if it has been turned off by a previous -qnodirective.

Notes

Examples

@PROCESS FREE
PROGRAM DIRECTV
INTEGER A, B, C, D, E, F
A = 1 ! Begin in free source form.
B = 2
!OLDSTYLE SOURCEFORM(FIXED)
! Switch to fixed source form for this include file that has not
! been converted yet.
      INCLUDE 'set_c_and_d.inc'
!IBM* SOURCEFORM(FREE)
E = 5 ! Back to free source form.
F = 6
END

For this example, compile with the option -qdirective=oldstyle to ensure that the compiler recognizes the SOURCEFORM directive before the INCLUDE line. After converting the include file to use free source form, you can compile with the -qnodirective option, and the SOURCEFORM(FIXED) directive is ignored.

Related Information

See the section on the SOURCEFORM directive in the XL Fortran Advanced Edition for Mac OS X Language Reference.

As the use of incorrect trigger constants can generate warning messages or error messages or both, you should check the particular directive statement in the Directives section of the XL Fortran Advanced Edition for Mac OS X Language Reference for the suitable associated trigger constant.

-qdlines Option

Syntax

-qdlines | -qnodlines
DLINES | NODLINES

-qdlines is the long form of the -D Option.

-qdpc Option

Syntax

-qdpc[=e] | -qnodpc
DPC[(E)] | NODPC

Increases the precision of real constants, for maximum accuracy when assigning real constants to DOUBLE PRECISION variables. This language extension might be needed when you are porting programs from other platforms.

Rules

If you specify -qdpc, all basic real constants (for example, 1.1) are treated as double-precision constants; the compiler preserves some digits of precision that would otherwise be lost during the assignment to the DOUBLE PRECISION variable. If you specify -qdpc=e, all single-precision constants, including constants with an e exponent, are treated as double-precision constants.

This option does not affect constants with a kind type parameter specified.

Examples

@process nodpc
        subroutine nodpc
        real x
        double precision y
        data x /1.000000000001/  ! The trailing digit is lost
        data y /1.000000000001/  ! The trailing digit is lost
 
        print *, x, y, x .eq. y  ! So x is considered equal to y
        end
 
@process dpc
        subroutine dpc
        real x
        double precision y
        data x /1.000000000001/  ! The trailing digit is lost
        data y /1.000000000001/  ! The trailing digit is preserved
 
        print *, x, y, x .eq. y  ! So x and y are considered different
        end
 
        program testdpc
        call nodpc
        call dpc
        end

When compiled, this program prints the following:

   1.000000000       1.00000000000000000     T
   1.000000000       1.00000000000100009     F

showing that with -qdpc the extra precision is preserved.

Related Information

-qautodbl Option and -qrealsize Option are more general-purpose options that can also do what -qdpc does. -qdpc has no effect if you specify either of these options.

-qescape Option

Syntax

-qescape | -qnoescape
ESCAPE | NOESCAPE

Specifies how the backslash is treated in character strings, Hollerith constants, H edit descriptors, and character string edit descriptors. It can be treated as an escape character or as a backslash character. This language extension might be needed when you are porting programs from other platforms.

Defaults

By default, the backslash is interpreted as an escape character in these contexts. If you specify -qnoescape, the backslash is treated as the backslash character.

The default setting is useful for the following:

If you are writing or porting code that depends on backslash characters being passed through unchanged, specify -qnoescape so that they do not get any special interpretation. You could also write \\ to mean a single backslash character under the default setting.

Examples


$ # Demonstrate how backslashes can affect the output
$ cat escape.f
       PRINT *,'a\bcde\fg'
       END
$ xlf95 escape.f
** _main === End of Compilation 1 ===
1501-510  Compilation successful for file escape.f.
$ a.out
cde
    g
$ xlf95 -qnoescape escape.f
** _main === End of Compilation 1 ===
1501-510  Compilation successful for file escape.f.
 $ a.out
  a\bcde\fg  

In the first compilation, with the default setting of -qescape, \b is printed as a backspace, and \f is printed as a formfeed character. With the -qnoescape option specified, the backslashes are printed like any other character.

Related Information

The list of escape sequences that XL Fortran recognizes is shown in Table 19.

-qextern Option

Syntax

-qextern=names

Allows user-written procedures to be called instead of XL Fortran intrinsics. names is a list of procedure names separated by colons. The procedure names are treated as if they appear in an EXTERNAL statement in each compilation unit being compiled. If any of your procedure names conflict with XL Fortran intrinsic procedures, use this option to call the procedures in the source code instead of the intrinsic ones.

Arguments

Separate the procedure names with colons.

Applicable Product Levels

Because of the many Fortran 90 and Fortran 95 intrinsic functions and subroutines, you might need to use this option even if you did not need it for FORTRAN 77 programs.

Examples

       subroutine matmul(res, aa, bb, ext)
         implicit none
         integer ext, i, j, k
         real aa(ext, ext), bb(ext, ext), res(ext, ext), temp
         do i = 1, ext
           do j = 1, ext
             temp = 0
             do k = 1, ext
               temp = temp + aa(i, k) * bb(k, j)
             end do
             res(i, j) = temp
           end do
         end do
       end subroutine
 
       implicit none
       integer i, j, irand
       integer, parameter :: ext = 100
       real ma(ext, ext), mb(ext, ext), res(ext, ext)
 
       do i = 1, ext
         do j = 1, ext
           ma(i, j) = float(irand())
           mb(i, j) = float(irand())
         end do
       end do
 
       call matmul(res, ma, mb, ext)
       end
 

Compiling this program with no options fails because the call to MATMUL is actually calling the intrinsic subroutine, not the subroutine defined in the program. Compiling with -qextern=matmul allows the program to be compiled and run successfully.

-qextname Option

Syntax

-qextname[=name1[:name2...]] | -qnoextname
EXTNAME[(name1: name2:...)] | NOEXTNAME

Adds an underscore to the names of all global entities, which helps in porting programs from systems where this is a convention for mixed-language programs. Use -qextname=name1[:name2...] to identify a specific global entity (or entities). For a list of named entities, separate each name with a colon.

The name of a main program is not affected.

The -qextname option helps to port mixed-language programs to XL Fortran without modifications. Use of this option avoids naming problems that might otherwise be caused by:

Restrictions

You must compile all the source files for a program, including the source files of any required module files, with the same -qextname setting.

If you use the xlfutility module to ensure that the Service and Utility subprograms are correctly declared, you must change the name to xlfutility_extname when compiling with -qextname.

If there is more than one Service and Utility subprogram referenced in a compilation unit, using -qextname with no names specified and the xlfutility_extname module may cause the procedure declaration check not to work accurately.

Examples

@PROCESS EXTNAME
        SUBROUTINE STORE_DATA
        CALL FLUSH(10)  ! Using EXTNAME, we can drop the final underscore.
        END SUBROUTINE
@PROCESS(EXTNAME(sub1))
program main
  external :: sub1, sub2
  call sub1()               ! An underscore is added.
  call sub2()               ! No underscore is added.
end program
 

Related Information

This option also affects the names that are specified in several other options, so you do not have to include underscores in their names on the command line. The affected options are -qextern Option and -qsigtrap Option.

-qfixed Option

Syntax

-qfixed[=right_margin]
FIXED[(right_margin)]

Indicates that the input source program is in fixed source form and optionally specifies the maximum line length.

The source form specified when executing the compiler applies to all of the input files, although you can switch the form for a compilation unit by using a FREE or FIXED @PROCESS directive or switch the form for the rest of the file by using a SOURCEFORM comment directive (even inside a compilation unit).

For source code from some other systems, you may find you need to specify a right margin larger than the default. This option allows a maximum right margin of 132.

Defaults

-qfixed=72 is the default for the xlf, xlf_r, f77, and fort77 commands. -qfree=f90 is the default for the xlf90, xlf90_r, xlf95, and xlf95_r commands.

Related Information

See -qfree Option.

For the precise specifications of this source form, see Fixed Source Form in the XL Fortran Advanced Edition for Mac OS X Language Reference.

-qflag Option

Syntax

-qflag=listing_severity:terminal_severity
FLAG(listing_severity,terminal_severity)

You must specify both listing_severity and terminal_severity.

Limits the diagnostic messages to those of a specified level or higher. Only messages with severity listing_severity or higher are written to the listing file. Only messages with severity terminal_severity or higher are written to the terminal. -w is a short form for -qflag=e:e.

Arguments

The severity levels (from lowest to highest) are:

i
Informational messages. They explain things that you should know, but they usually do not require any action on your part.

l
Language-level messages, such as those produced under the -qlanglvl option. They indicate possible nonportable language constructs.

w
Warning messages. They indicate error conditions that might require action on your part, but the program is still correct.

e
Error messages. They indicate error conditions that require action on your part to make the program correct, but the resulting program can probably still be executed.

s
Severe error messages. They indicate error conditions that require action on your part to make the program correct, and the resulting program will fail if it reaches the location of the error. You must change the -qhalt setting to make the compiler produce an object file when it encounters this kind of error.

u
Unrecoverable error messages. They indicate error conditions that prevent the compiler from continuing. They require action on your part before you can compile your program.

q
No messages. A severity level that can never be generated by any defined error condition. Specifying it prevents the compiler from displaying messages, even if it encounters unrecoverable errors.

The -qflag option overrides any -qlanglvl or -qsaa options specified.

Defaults

The default for this option is i:i so that you do not miss any important informational messages.

Related Information

See -qlanglvl Option and Understanding XL Fortran Error Messages.

-qfloat Option

Syntax

-qfloat=options
FLOAT(options)

Selects different strategies for speeding up or improving the accuracy of floating-point calculations.

This option replaces several separate options. For any new code, you should use it instead of -qfold, -qmaf, or related options.

You should be familiar with the information in XL Fortran Floating-Point Processing and the IEEE standard before attempting to change any -qfloat settings.

Defaults

The default setting uses the suboptions nocomplexgcc, nofltint, fold, maf, nonans, norrm, norsqrt, and nostrictnmaf. Some options change this default, as explained below.

The default setting of each suboption remains in effect unless you explicitly change it. For example, if you select -qfloat=nofold, the settings for related options are not affected.

Arguments

The available suboptions each have a positive and negative form, such as fold and nofold, where the negative form is the opposite of the positive.

The suboptions are as follows:

complexgcc | nocomplexgcc
Use Mac OS X conventions when passing or returning complex numbers. This option preserves compatibility with gcc-compiled code.

fltint | nofltint
Speeds up floating-point-to-integer conversions by using an inline sequence of code instead of a call to a library function.

The library function, which is called by default if -qfloat=fltint is not specified or implied by another option, checks for floating-point values outside the representable range of integers and returns the minimum or maximum representable integer if passed an out-of-range floating-point value.

The Fortran language does not require checking for floating-point values outside the representable range of integers. In order to improve efficiency, the inline sequence used by -qfloat=fltint does not perform this check. If passed a value that is out of range, the inline sequence will produce undefined results.

Although this suboption is turned off by default, it is turned on by the -O3 optimization level unless you also specify -qstrict.

fold | nofold
Evaluates constant floating-point expressions at compile time, which may yield slightly different results from evaluating them at run time. The compiler always evaluates constant expressions in specification statements, even if you specify nofold.

maf | nomaf
Makes floating-point calculations faster and more accurate by using multiply-add instructions where appropriate. The possible disadvantage is that results may not be exactly equivalent to those from similar calculations that are performed at compile time or on other types of computers.

nans | nonans
Allows you to use the -qflttrap=invalid:enable option to detect and deal with exception conditions that involve signaling NaN (not-a-number) values. Use this suboption only if your program explicitly creates signaling NaN values, because these values never result from other floating-point operations.

rrm | norrm
Turns off compiler optimizations that require the rounding mode to be the default, round-to-nearest, at run time. Use this option if your program changes the rounding mode by any means, such as by calling the fpsets procedure. Otherwise, the program may compute incorrect results.

rsqrt | norsqrt
Speeds up some calculations by replacing division by the result of a square root with multiplication by the reciprocal of the square root.

Although this suboption is turned off by default, specifying -O3 turns it on unless you also specify -qstrict.

strictnmaf | nostrictnmaf
Turns off floating-point transformations that are used to introduce negative MAF instructions, as these transformations do not preserve the sign of a zero value. By default, the compiler enables these types of transformations.

To ensure strict semantics, specify both -qstrict and -qfloat=strictnmaf.

-qflttrap Option

Syntax

-qflttrap[=suboptions] | -qnoflttrap
FLTTRAP[(suboptions)] | NOFLTTRAP

Determines what types of floating-point exception conditions to detect at run time. The program receives a SIGFPE signal when the corresponding exception occurs.

Arguments

OVerflow
Detect and trap on floating-point overflow if exception-checking is enabled.

UNDerflow
Detect and trap on floating-point underflow if exception-checking is enabled.

ZEROdivide
Detect and trap on floating-point division by zero if exception-checking is enabled.

INValid
Detect and trap on floating-point invalid operations if exception-checking is enabled.

INEXact
Detect and trap on floating-point inexact if exception-checking is enabled. Because inexact results are very common in floating-point calculations, you usually should not need to turn this type of exception on.

ENable
Turn on checking for the specified exceptions in the main program so that the exceptions generate SIGFPE signals. You must specify this suboption if you want to turn on exception trapping without modifying your source code.

IMPrecise
Only check for the specified exceptions on subprogram entry and exit. This suboption improves performance, but it can make the exact spot of the exception difficult to find.

Defaults

The -qflttrap option without suboptions is equivalent to -qflttrap=ov:und:zero:inv:inex. However, because this default does not include enable, it is probably only useful if you already use fpsets or similar subroutines in your source. If you specify -qflttrap more than once, both with and without suboptions, the -qflttrap without suboptions is ignored.

Examples

When you compile this program:

        REAL X, Y, Z
        DATA X /5.0/, Y /0.0/
        Z = X / Y
        END

with the command:

xlf95 -qflttrap=zerodivide:enable -qsigtrap divide_by_zero.f

the program stops when the division is performed.

The zerodivide suboption identifies the type of exception to guard against. The enable suboption causes a SIGFPE signal when the exception occurs. The -qsigtrap option produces informative output when the signal stops the program.

Related Information

See -qsigtrap Option.

See Detecting and Trapping Floating-Point Exceptions for full instructions on how and when to use the -qflttrap option, especially if you are just starting to use it.

-qfree Option

Syntax

-qfree[={f90|ibm}]
FREE[({F90|IBM})]

Indicates that the source code is in free source form. The ibm and f90 suboptions specify compatibility with the free source form defined for VS FORTRAN and Fortran 90, respectively. Note that the free source form defined for Fortran 90 also applies to Fortran 95.

The source form specified when executing the compiler applies to all of the input files, although you can switch the form for a compilation unit by using a FREE or FIXED @PROCESS directive or for the rest of the file by using a SOURCEFORM comment directive (even inside a compilation unit).

Defaults

-qfree by itself specifies Fortran 90 free source form.

-qfixed=72 is the default for the xlf, xlf_r, f77, and fort77 commands. -qfree=f90 is the default for the xlf90, xlf90_r, xlf95, and xlf95_r commands.

Related Information

See -qfixed Option.

-k is equivalent to -qfree=f90.

Fortran 90 free source form is explained in Free Source Form in the XL Fortran Advanced Edition for Mac OS X Language Reference. It is the format to use for maximum portability across compilers that support Fortran 90 and Fortran 95 features now and in the future.

IBM free source form is equivalent to the free format of the IBM VS FORTRAN compiler, and it is intended to help port programs from the z/OS(R) platform. It is explained in IBM Free Source Form in the XL Fortran Advanced Edition for Mac OS X Language Reference.

-qfullpath Option

Syntax

-qfullpath | -qnofullpath

Records the full, or absolute, path names of source and include files in object files compiled with debugging information (-g option).

If you need to move an executable file into a different directory before debugging it or have multiple versions of the source files and want to ensure that the debugger uses the original source files, use the -qfullpath option in combination with the -g option so that source-level debuggers can locate the correct source files.

Defaults

By default, the compiler records the relative path names of the original source file in each .o file. It may also record relative path names for include files.

Restrictions

Although -qfullpath works without the -g option, you cannot do source-level debugging unless you also specify the -g option.

Examples

In this example, the executable file is moved after being created, but the debugger can still locate the original source files:


$ xlf95 -g -qfullpath file1.f file2.f file3.f -o debug_version
...
$ mv debug_version $HOME/test_bucket
$ cd $HOME/test_bucket
$ gdb debug_version

Related Information

See -g Option.

-qhalt Option

Syntax

-qhalt=severity
HALT(severity)

Stops before producing any object, executable, or assembler source files if the maximum severity of compile-time messages equals or exceeds the specified severity. severity is one of i, l, w, e, s, u, or q, meaning informational, language, warning, error, severe error, unrecoverable error, or a severity indicating "don't stop".

Arguments

The severity levels (from lowest to highest) are:

i
Informational messages. They explain things that you should know, but they usually do not require any action on your part.

l
Language-level messages, such as those produced under the -qlanglvl option. They indicate possible nonportable language constructs.

w
Warning messages. They indicate error conditions that might require action on your part, but the program is still correct.

e
Error messages. They indicate error conditions that require action on your part to make the program correct, but the resulting program can probably still be executed.

s
Severe error messages. They indicate error conditions that require action on your part to make the program correct, and the resulting program will fail if it reaches the location of the error. You must change the -qhalt setting to make the compiler produce an object file when it encounters this kind of error.

u
Unrecoverable error messages. They indicate error conditions that prevent the compiler from continuing. They require action on your part before you can compile your program.

q
A severity level that can never be generated by any defined error condition. Specifying it prevents the compiler from halting, even if it encounters unrecoverable errors.

Defaults

The default is -qhalt=s, which prevents the compiler from generating an object file when compilation fails.

Restrictions

The -qhalt option can override the -qobject option, and -qnoobject can override -qhalt.

-qhot Option

Syntax

-qhot[=suboptions] | -qnohot
HOT[=suboptions] | NOHOT

Determines whether to perform high-order transformations on loops and array language during optimization and whether to pad array dimensions and data objects to avoid cache misses.

Because of the implementation of the cache architecture, array dimensions that are powers of two can lead to decreased cache utilization. The optional arraypad suboption permits the compiler to increase the dimensions of arrays where doing so might improve the efficiency of array-processing loops. If you have large arrays with some dimensions (particularly the first one) that are powers of 2 or if you find that your array-processing programs are slowed down by cache misses or page faults, consider specifying -qhot=arraypad.

If you do not specify at least level 2 of -O for -qhot, the compiler assumes -O2.

Arguments

arraypad
The compiler will pad any arrays where it infers there may be a benefit and will pad by whatever amount it chooses. Not all arrays will necessarily be padded, and different arrays may be padded by different amounts.

arraypad=n
The compiler will pad every array in the code. The pad amount must be a positive integer value. Each array will be padded by an integral number of elements.

Because n is an integral value, we recommend that pad values be multiples of the largest array element size, typically 4, 8, or 16.

For both the arraypad and arraypad=n options, no checking for reshaping or equivalences is performed. If padding takes place, your compiled program may produce unpredictable results.

Restrictions

The -C option turns off the transformations.

Related Information

Optimizing Loops and Array Language lists the transformations that are performed.

-qieee Option

Syntax

-qieee={Near | Minus | Plus | Zero}
IEEE({Near | Minus | Plus | Zero})

Specifies the rounding mode for the compiler to use when it evaluates constant floating-point expressions at compile time.

Arguments

The choices are:

Near
Round to nearest representable number.

Minus
Round toward minus infinity.

Plus
Round toward plus infinity.

Zero
Round toward zero.

This option is intended for use in combination with the XL Fortran subroutine fpsets or some other method of changing the rounding mode at run time. It sets the rounding mode that is used for compile-time arithmetic (for example, evaluating constant expressions such as 2.0/3.5). By specifying the same rounding mode for compile-time and run-time operations, you can avoid inconsistencies in floating-point results.

Note:
Compile-time arithmetic is most extensive when you also specify the -O option.

If you change the rounding mode to other than the default (round-to-nearest) at run time, be sure to also specify -qfloat=rrm to turn off optimizations that only apply in the default rounding mode.

Related Information

See Selecting the Rounding Mode, -O Option, and -qfloat Option.

-qinit Option

Syntax

-qinit=f90ptr
INIT(F90PTR)

Makes the initial association status of pointers disassociated. Note that this applies to Fortran 95 as well as Fortran 90.

You can use this option to help locate and fix problems that are due to using a pointer before you define it.

Related Information

See Pointer Association in the XL Fortran Advanced Edition for Mac OS X Language Reference.

-qinitauto Option

Syntax

-qinitauto[=hex_value] | -qnoinitauto

Initializes each byte or word (4 bytes) of storage for automatic variables to a specific value, depending on the length of the hex_value. This helps you to locate variables that are referenced before being defined. For example, by using both the -qinitauto option to initialize REAL variables with a signaling NAN value and the -qflttrap option, it is possible to identify references to uninitialized REAL variables at run time.

Setting hex_value to zero ensures that all automatic variables are cleared before being used. Some programs assume that variables are initialized to zero and do not work when they are not. Other programs may work if they are not optimized but fail when they are optimized. Typically, setting all the variables to all zero bytes prevents such run-time errors. It is better to locate the variables that require zeroing and insert code in your program to do so than to rely on this option to do it for you. Using this option will generally zero more things than necessary and may result in slower programs.

To locate and fix these errors, set the bytes to a value other than zero, which will consistently reproduce incorrect results. This method is especially valuable in cases where adding debugging statements or loading the program into a symbolic debugger makes the error go away.

Setting hex_value to FF (255) gives REAL and COMPLEX variables an initial value of "negative not a number", or -quiet NAN. Any operations on these variables will also result in quiet NAN values, making it clear that an uninitialized variable has been used in a calculation.

This option can help you to debug programs with uninitialized variables in subprograms; for example, you can use it to initialize REAL variables with a signaling NAN value. You can initialize 8-byte REAL variables to double-precision signaling NAN values by specifying an 8-digit hexadecimal number, that, when repeated, has a double-precision signaling NAN value. For example, you could specify a number such as 7FBFFFFF, that, when stored in a REAL(4) variable, has a single-precision signaling NAN value. The value 7FF7FFFF, when stored in a REAL(4) variable, has a single-precision quiet NAN value. If the same number is stored twice in a REAL(8) variable (7FF7FFFF7FF7FFFF), it has a double-precision signaling NAN value.

Arguments

Defaults

Restrictions

Examples

The following example shows how to perform word initialization of automatic variables:

subroutine sub()
integer(4), automatic :: i4
character, automatic :: c
real(4), automatic :: r4
real(8), automatic :: r8
end subroutine

When you compile the code with the following option, the compiler performs word initialization, as the hex_value is longer than 2 digits:

-qinitauto=0cf

The compiler initializes the variables as follows, padding the hex_value with zeros in the cases of the i4, r4, and r8 variables and truncating the first hexadecimal digit in the case of the c variable:

Variable Value
i4 000000CF
c CF
r4 000000CF
r8 000000CF000000CF

Related Information

See -qflttrap Option and the section on the AUTOMATIC directive in the XL Fortran Advanced Edition for Mac OS X Language Reference.

-qintlog Option

Syntax

-qintlog | -qnointlog
INTLOG | NOINTLOG

Specifies that you can mix integer and logical data entities in expressions and statements. Logical operators that you specify with integer operands act upon those integers in a bit-wise manner, and integer operators treat the contents of logical operands as integers.

Restrictions

The following operations do not allow the use of logical variables:

Examples

INTEGER I, MASK, LOW_ORDER_BYTE, TWOS_COMPLEMENT
I = 32767
MASK = 255
! Find the low-order byte of an integer.
LOW_ORDER_BYTE = I .AND. MASK
! Find the twos complement of an integer.
TWOS_COMPLEMENT = .NOT. I
END

Related Information

You can also use the intrinsic functions IAND, IOR, IEOR, and NOT to perform bitwise logical operations.

-qintsize Option

Syntax

-qintsize=bytes
INTSIZE(bytes)

Sets the size of default INTEGER and LOGICAL data entities (that is, those for which no length or kind is specified).

Background Information

The specified size 1 applies to these data entities:

Allowed sizes for bytes are:

This option is intended to allow you to port programs unchanged from systems that have different default sizes for data. For example, you might need -qintsize=2 for programs that are written for a 16-bit microprocessor or -qintsize=8 for programs that are written for a CRAY computer. The default value of 4 for this option is suitable for code that is written specifically for many 32-bit computers.

Restrictions

This option is not intended as a general-purpose method for increasing the sizes of data entities. Its use is limited to maintaining compatibility with code that is written for other systems.

You might need to add PARAMETER statements to give explicit lengths to constants that you pass as arguments.

Examples

In the following example, note how variables, literal constants, intrinsics, arithmetic operators, and input/output operations all handle the changed default integer size.

@PROCESS INTSIZE(8)
      PROGRAM INTSIZETEST
      INTEGER I
      I = -9223372036854775807    ! I is big enough to hold this constant.
      J = ABS(I)                  ! So is implicit integer J.
      IF (I .NE. J) THEN
        PRINT *, I, '.NE.', J
      END IF
      END

The following example only works with the default size for integers:

      CALL SUB(17)
      END
 
      SUBROUTINE SUB(I)
      INTEGER(4) I                ! But INTSIZE may change "17"
                                  ! to INTEGER(2) or INTEGER(8).
      ...
      END

If you change the default value, you must either declare the variable I as INTEGER instead of INTEGER(4) or give a length to the actual argument, as follows:

@PROCESS INTSIZE(8)
      INTEGER(4) X
      PARAMETER(X=17)
      CALL SUB(X)      ! Use a parameter with the right length, or
      CALL SUB(17_4)   ! use a constant with the right kind.
      END

Related Information

See -qrealsize Option and Type Parameters and Specifiers in the XL Fortran Advanced Edition for Mac OS X Language Reference.

-qipa Option

Syntax

-qipa[=suboptions]
-qnoipa

Enhances -O optimization by doing detailed analysis across procedures (interprocedural analysis or IPA).

You must also specify the -O, -O2, -O3, -O4, or -O5 option when you specify -qipa. (Specifying the -O5 option is equivalent to specifying the -O4 option plus -qipa=level=2.) The -qipa option extends the area that is examined during optimization and inlining from a single procedure to multiple procedures (possibly in different source files) and the linkage between them.

You can fine-tune the optimizations that are performed by specifying suboptions.

To use this option, the necessary steps are:

  1. Do preliminary performance analysis and tuning before compiling with the -qipa option. This is necessary because interprocedural analysis uses a two-phase mechanism (a compile-time phase and a link-time phase), which increases link time. (You can use the noobject suboption to reduce this overhead.)
  2. Specify the -qipa option on both the compile and link steps of the entire application or on as much of it as possible. Specify suboptions to indicate what assumptions to make about the parts of the program that are not compiled with -qipa. (If your application contains C or C++ code compiled with IBM C/C++ compilers, you must compile with the -qipa option to allow for additional optimization opportunities at link time.)

    During compilation, the compiler stores interprocedural analysis information in the .o file. During linking, the -qipa option causes a complete reoptimization of the entire application.

Note that if you specify this option with -#, the compiler does not display linker information subsequent to the IPA link step. This is because the compiler does not actually call IPA.

Arguments

IPA uses the following suboptions during its compile-time phase:

object | noobject
Specifies whether to include standard object code in the object files. Specifying the noobject suboption can substantially reduce overall compilation time, by not generating object code during the first IPA phase.

If compiling and linking are performed in the same step and you do not specify any listing option, -qipa=noobject is implied.

If your program contains object files created with the noobject suboption, you must use the -qipa option to compile any files containing an entry point (the main program for an executable program or an exported procedure for a library) before linking your program with -qipa.

IPA uses the following suboptions during its link-time phase:

exits=procedure_names
Specifies a list of procedures, each of which always ends the program. The compiler can optimize calls to these procedures (for example, by eliminating save/restore sequences), because the calls never return to the program. These procedures must not call any other parts of the program that are compiled with -qipa.

inline=inline-options
The -qipa=inline= command can take a colon-separated list of inline options, as listed below:

inline=auto | noauto
Specifies whether to automatically inline procedures.

inline=limit=number
Changes the size limits that the inline=auto option uses to determine how much inline expansion to do. This established "limit" is the size below which the calling procedure must remain. number is the optimizer's approximation of the number of bytes of code that will be generated. Larger values for this number allow the compiler to inline larger subprograms, more subprogram calls, or both. This argument is implemented only when inline=auto is on.

inline=procedure_names
Specifies a list of procedures to try to inline.

inline=threshold=number
Specifies the upper size limit on procedures to be inlined, where number is a value as defined under the inline suboption "limit". This argument is implemented only when "inline=auto" is on.
Note:
By default, the compiler will try to inline all procedures, not just those that you specified with the inline=procedure_names suboption. If you want to turn on inlining for only certain procedures, specify inline=noauto after you specify inline=procedure_names. (You must specify the suboptions in this order.) For example, to turn off inlining for all procedures other than for sub1, specify -qipa=inline=sub1:inline=noauto.

isolated=procedure_names
Specifies a comma-separated list of procedures that are not compiled with -qipa. Procedures that you specify as "isolated" or procedures within their call chains cannot refer directly to any global variable.

level=level
Determines the amount of interprocedural analysis and optimization that is performed:
0
Does only minimal interprocedural analysis and optimization.
1
Turns on inlining, limited alias analysis, and limited call-site tailoring.
2
Full interprocedural data flow and alias analysis. Specifying -O5 is equivalent to specifying -O4 and -qipa=level=2.

The default level is 1.

list=[filename | short | long]

Specifies an output listing file name during the link phase, in the event that an object listing has been requested using either the -qlist or the -qipa=list compiler option and allows the user to direct the type of output. If you do not specify the filename suboption, the default file name is "a.lst".

If you specify short, the Object File Map, Source File Map, and Global Symbols Map sections are included. If you specify long, the preceding sections appear in addition to the Object Resolution Warnings, Object Reference Map, Inliner Report, and Partition Map sections.

If you specify the -qipa and -qlist options together, IPA generates an a.lst file that overwrites any existing a.lst file. If you have a source file named a.f, the IPA listing will overwrite the regular compiler listing a.lst. You can use the list=filename suboption to specify an alternative listing file name.

lowfreq=procedure_names
Specifies a list of procedures that are likely to be called infrequently during the course of a typical program run. For example, procedures for initialization and cleanup might only be called once, and debugging procedures might not be called at all in a production-level program. The compiler can make other parts of the program faster by doing less optimization for calls to these procedures.

missing={unknown | safe | isolated | pure}
Specifies the interprocedural behavior of procedures that are not compiled with -qipa and are not explicitly named in an unknown, safe, isolated, or pure suboption. The default is to assume unknown, which greatly restricts the amount of interprocedural optimization for calls to those procedures.

noinline=procedure_names
Specifies a list of procedures that are not to be inlined.

partition={small | medium | large}
Specifies the size of the regions within the program to analyze. Larger partitions contain more procedures, which result in better interprocedural analysis but require more storage to optimize. Reduce the partition size if compilation takes too long because of paging.

pdfname=[filename]

Specifies the name of the profile data file containing the PDF profiling information. If you do not specify a filename, the default file name is __pdf. The profile is placed in the current working directory or in the directory that the PDFDIR environment variable names. This allows the programmer to do simultaneous runs of multiple executables using the same PDFDIR. This is especially useful when tuning with PDF on dynamic libraries. (See -qpdf Option for more information on tuning optimizations.)

pure=procedure_names
Specifies a list of procedures that are not compiled with -qipa. Any procedure that you specified as "pure" must be "isolated" and "safe". It must not alter the internal state nor have side-effects, which are defined as potentially altering any data object visible to the caller.

safe=procedure_names
Specifies a list of procedures that are not compiled with -qipa. Any procedure that you specified as "safe" may modify global variables and dummy arguments. No calls to procedures that are compiled with -qipa may be made from within a "safe" procedure's call chain.

stdexits | nostdexits
Specifies that certain predefined routines can be optimized as with the exits suboption. The procedures are: abort, exit, _exit, and _assert.

unknown=procedure_names
Specifies a list of procedures that are not compiled with -qipa. Any procedure specified as "unknown" may make calls to other parts of the program compiled with -qipa and modify global variables and dummy arguments.

The primary use of isolated, missing, pure, safe, and unknown is to specify how much optimization can safely be performed on calls to library routines that are not compiled with -qipa.

The following compiler options have an effect on the link-time phase of -qipa:

-qlibansi | -qnolibansi
Assumes that all functions with the name of an ANSI C defined library function are, in fact, the library functions.

-qlibposix | -qnolibposix
Assumes that all functions with the name of an IEEE 1003.1-2001 (POSIX) defined library function are, in fact, the system functions.

Rules

Regular expressions are supported for the following suboptions:

Syntax rules for regular expressions are described below.

Table 13. Regular expression syntax

Expression Description