United States    
COMPAQ STORE | PRODUCTS |
SERVICES | SUPPORT | CONTACT US | SEARCH
Compaq C

Compaq C
User's Guide for OpenVMS Systems


Previous Contents Index


Chapter 6
Predefined Macros and Built-In Functions

This chapter describes the following topics:

Predefined macros and built-in functions are extensions to the ANSI C Standard and are specific to Compaq C for OpenVMS Systems. The macros assist in transporting code and performing simple tasks that are common to many programs. The built-in functions allow you to efficiently access processor instructions.

6.1 Predefined Macros

In addition to the ANSI-compliant, implementation-independent macros described in the Compaq C Language Reference Manual, Compaq C for OpenVMS Systems provides the predefined macros described in the following sections.

6.1.1 CC$gfloat (G_Floating Identification Macro)

This macro is provided for compatibility with VAX C. The __g_float predefined macro should be used instead. See Section 6.1.4.

6.1.2 System Identification Macros

Each implementation of the Compaq C compiler automatically defines macros that can be used to identify the system on which the program is running. These macros can assist in writing code that executes conditionally, depending on the architecture or operating system on which the program is running.

Table 6-1 lists the traditional (non-ANSI) and new (ANSI) spellings of these predefined macro names for Compaq C for OpenVMS Systems. Both spellings are defined for each macro unless strict ANSI C mode (/STANDARD=ANSI89) is in effect, in which case only the new spellings are defined.

Table 6-1 Predefined System Identification Macros
  Traditional Spelling New Spelling
Operating system name: vms __vms
  vms __vms
  vms_version __vms_version
  vms_version __vms_version
    __vms_ver
    __decc_ver
Architecture name: vax (VAX ONLY) __vax (VAX ONLY)
  vax (VAX ONLY) __vax (VAX ONLY)
    __alpha (ALPHA ONLY)
    __alpha (ALPHA ONLY)
    __alpha_axp (ALPHA ONLY)
    __32bits (ALPHA ONLY)
Product name: vaxc __vaxc
  vaxc __vaxc
  vax11c __vax11c
  vax11c __vax11c
    __decc
ANSI C version of the compiler:   __stdc__ 1
ISOC94 version of the compiler   __stdc_version__ =199409L 2
MIA version of the compiler:   __mia 3


1__stdc__ is defined only in strict or relaxed ANSI C mode, and MIA mode.
2__stdc_version__ is defined only when compiling with /STANDARD=ISOC94
3__mia is defined only in MIA mode.

Most of these macros are defined as 1 or 0, as appropriate to the processor and compilation qualifiers. For example, if you are compiling with /STANDARD=VAXC on an OpenVMS VAX system, the following macros are defined as if the preprocessor directives shown were included by the compiler before every compilation source group (the new spellings are shown):


#define __vax           1            
#define __VAX           1 
#define __vms           1 
#define __VMS           1 
#define __vaxc          1 
#define __VAXC          1 
#define __vax11c        1 
#define __VAX11C        1 
#define __vms_version   version_number (example: V6.0) 
#define __VMS_VERSION   version_number (example: V6.0) 
#define __STDC__       1 
#define __MIA           0 (1 if /STANDARD=MIA was specified.) 
#define __DECC          1 

You can use these system identification macros to separate portable and nonportable code in any of your Compaq C programs or to conditionally compile Compaq C programs used on more than one operating system to take advantage of system-specific features. For example:


#ifdef    VMS 
#include  rms           /* Include RMS definitions.  */ 
#endif 

See the Compaq C Language Reference Manual for more information about using the preprocessor conditional-compilation directives.

6.1.2.1 The __DECC_VER Macro

The __decc_ver macro provides an integer encoding of the compiler version-identifier string that is suitable for use in a preprocessor #if expression, such that a larger number corresponds to a more recent version.

The format of the compiler version-identifier string is:


TMM.mm-eee

Where:

The format of the integer encoding for __decc_ver is:


vvuuteeee

Where:

The following describes how the __decc_ver integer value is calculated from the compiler version-identifier string:

  1. The major version is multiplied by 10000000.
  2. The minor version (the digits between the '.' and any edit suffix) is multiplied by 100000 and added to the suffix value (The suffix value has a range of 0-999).
  3. If the character immediately preceding the first digit of the major version number is one of the ones listed in Table 6-2, its numerical encoding is multiplied by 10000.
  4. The preceding values are added together.

The following examples show how different compiler version-identifier strings map to __decc_ver encodings:


ident           __DECC_VER 
string          vvuuteeee
 
T5.2-003   -->   50260003 
V6.0-001   -->   60090001 

6.1.2.2 The __VMS_VER Macro

The __vms_ver macro provides an integer encoding of the OpenVMS version-identifier string that is suitable for use in a preprocessor #if expression, such that a larger number corresponds to a more recent version.

The format of the OpenVMS version-identifier string is:


TMM.mm-epp

Where:

The format of the integer encoding for __vms_ver is:


vvuuepptt

Where:

The following describes how the __vms_ver integer value is calculated from the OpenVMS version-identifier string:

  1. The major version is multiplied by 10000000.
  2. The minor version (the digits between the '.' and any edit/patch suffix) is multiplied by 100000 and added to the suffix value.
    The suffix value is the optional edit number multiplied by 10000, added to the optional patch letter's alphabetic ordinal multiplied by 100.
  3. The preceding values are added together, along with the alphabetic ordinal of the version type.

The following examples show how different OpenVMS version-identifier strings map to __vms_ver encodings:


ident           __VMS_VER 
string          vvuuepptt
 
V6.1      -->    60100022 
V6.1-1H   -->    60110822 
E6.2      -->    60200005  ("IFT") 
F6.2      -->    60200006  ("FT1") 
G6.2      -->    60200007  ("FT2") 
V6.2      -->    60200022 
T6.2-1H   -->    60210820 
V6.2-1I   -->    60210922 
V5.5-1H1  -->    50510822 (extra trailing digit ignored) 

6.1.3 Standards Conformance Macros

The Compaq C RTL contains functions whose support and syntax conform to various industry standards or levels of product or operating system support.

Table 6-3 lists macros that you can explicitly define (using the /DEFINE qualifier or the #define preprocessor directive) to control which Compaq C RTL functions are declared in header files and to obtain standards conformance checking.

Table 6-3 Standards Macros---All platforms
Macro Standard
_xopen_source_extended XPG4-UNIX
_xopen_source XPG4
_posix_c_source POSIX
_ansi_c_source ISO C and ANSI C
_vms_v6_source OpenVMS Version 6 compatibility
_decc_v4_source DEC C Version 4.0 compatibility
_bsd44_curses 4.4BSD Curses
_vms_curses VAX C Curses
_sockaddr_len 4.4BSD sockets

These macros, with the exception of _posix_c_source , can be defined to 0 or 1.

The _posix_c_source macro can be defined to one of the following values:

0
1
2
199506

See the Compaq C Run-Time Library Reference Manual for OpenVMS Systems for more information about these feature-test macros.

6.1.4 Floating-Point Macros

Compaq C for OpenVMS Systems automatically defines the following macros that pertain to the format of floating-point variables. They can be used to identify the format with which you are compiling your program.

One of the first three macros listed is defined to have a value of 1 when the corresponding option of the /FLOAT qualifier is specified, or the appropriate /[NO]G_FLOAT qualifier is used. (The /G_FLOAT qualifier is kept only for compatibility with VAX C.) If the corresponding option was not specified, the associated macro is defined to have a value of 0.

On OpenVMS Alpha systems, the __x_float macro is defined to have a value of 1 when /L_DOUBLE_SIZE=128 (the default), and a value of 0 when /L_DOUBLE_SIZE=64.

These macros can assist in writing code that executes conditionally, depending on whether the program is running using D_floating, G_floating, or IEEE_floating (ALPHA ONLY) precision.

For example, if you compiled using G_floating format, then __d_float and __ieee_float (ALPHA ONLY) are predefined to be 0, and __g_float is predefined as if the following were included before every compilation unit:


#define  __G_FLOAT  1 

You can conditionally assign values to variables of type double without causing an error and without being certain of how much storage was allocated for the variable. For example, you may assign values to external variables as follows:


#ifdef __G_FLOAT  
double x = 0.12e308;        /* Range to 10 to the 308th power */ 
#else 
double x = 0.12e38;         /* Range to 10 to the 38th power  */ 
#endif 

All predefined macro names, such as __g_float , are reserved by DIGITAL.

You can remove the effect of predefined macro definitions by explicitly undefining the conflicting name. For more information about undefining macros, see the #undefine directive in the Compaq C Language Reference Manual. For more information about the G_floating representation of the double data type, see Chapter 4.

6.1.5 Compiler-Mode Macros

The following predefined macros are defined if the corresponding compiler mode is selected:

6.1.6 Pointer-Size Macro

The following predefined macro is defined if the /POINTER_SIZE command-line qualifier is specified:

__initial_pointer_size

Specifying /POINTER_SIZE, /POINTER_SIZE=32, or /POINTER_SIZE=SHORT defines __initial_pointer_size to 32.

Specifying /POINTER_SIZE=64, or /POINTER_SIZE=LONG defines __initial_pointer_size to 64.

If /POINTER_SIZE is not specified, __initial_pointer_size is defined to 0. This lets you use #ifdef __initial_pointer_size to test whether or not the compiler supports 64-bit pointers, because compilers lacking pointer-size controls will not define this macro at all.

6.1.7 The __HIDE_FORBIDDEN_NAMES Macro

The ANSI C standard specifies exactly what identifiers in the normal name space are declared by the standard header files. A compiler is not free to declare additional identifiers in a header file unless the identifiers follow defined rules (the identifier must begin with an underscore followed by an uppercase letter or another underscore).

When running the Compaq C compiler for OpenVMS systems in strict ANSI C mode (/STANDARD=ANSI89), versions of the standard header files are included that hide many identifiers that do not follow the rules. The header file <stdio.h> , for example, hides the definition of the macro TRUE. The compiler accomplishes this by predefining the macro __hide_forbidden_names in strict ANSI mode.

You can use the /UNDEFINE="__HIDE_FORBIDDEN_NAMES" command-line qualifier to prevent the compiler from predefining this macro and, thereby, including macro definitions of the forbidden names.

The header files are modified to only define additional VAX C names if __hide_forbidden_names is undefined. For example, <stdio.h> might contain the following:


#ifndef __HIDE_FORBIDDEN_NAMES 
#define TRUE 1 
#endif 

6.2 Built-In Functions

Sections 6.2.1 and 6.2.2 describe the Compaq C built-in functions available in all compiler modes on OpenVMS Alpha and OpenVMS VAX systems.

These functions allow you to directly access hardware and machine instructions to perform operations that are cumbersome, slow, or impossible in other C compilers.

These functions are very efficient because they are built into the Compaq C compiler. This means that a call to one of these functions does not result in a reference to a function in the Compaq C Run-Time Library (RTL) or to a function in your program. Instead, the compiler generates the machine instructions necessary to carry out the function directly at the call site. Because most of these built-in functions closely correspond to single VAX or Alpha machine instructions, the result is small, fast code.

Some of these built-in functions (such as those that operate on strings or bits) are of general interest. Others (such as the functions dealing with process context) are of interest if you are writing device drivers or other privileged software. Some of the functions discussed in the following sections are privileged and unavailable to user mode programs.

Be sure to include the <builtins.h> header file in your source program to access these built-in functions. VAX C required you to place the #pragma builtins preprocessor directive, rather than #include <builtins.h> , in your source file before using one or more built-in functions. Compaq C supports #pragma builtins for compatibility with VAX C, but using #include <builtins.h> is recommended.

Note

Compaq C implements #pragma builtins as if it were #include <builtins.h> ; if you get an error from #pragma builtins , it is the same kind of error you would get if you specified #include <builtins.h> .

Also see Section 5.4.2.

Some of the built-in functions have optional arguments or allow a particular argument to have one of many different types. To describe all valid combinations of arguments, the following built-in function descriptions list several different prototypes for the function. As long as a call to a built-in function matches one of the prototypes listed, the call is valid. Furthermore, any valid call to a built-in function behaves as if the corresponding prototype were in scope of the call. The compiler, therefore, performs the argument checking and conversions specified by that prototype.

The majority of the built-in functions are named after the processor instruction that they generate. The built-in functions provide direct and unencumbered access to those VAX instructions. Any inherent limitations to those instructions are limitations to the built-in functions as well. For instance, the MOVC3 instruction and the _MOVC3 built-in function can move at most 65,535 characters.

For more information on these built-in functions, see the corresponding machine instruction in the VAX MACRO and Instruction Set Reference Manual, Alpha Architecture Handbook, or Alpha Architecture Reference Manual. In particular, refer to the structure of queue entries manipulated by the built-in queue functions.


Previous Next Contents Index
  

1.800.AT.COMPAQ

privacy and legal statement