12 - C H A P T E R -

C H A P T E R 12

Using Libraries

Libraries provide a way to share code among several applications and a way to reduce the complexity of very large applications. The C++ compiler gives you access to a variety of libraries. This chapter explains how to use these libraries.

12.1 The C Libraries

The Solaris operating environment comes with several libraries installed in /usr/lib. Most of these libraries have a C interface. Of these, the libc, libm, and libw libraries are linked by the CC driver by default. The library libthread is linked if you use the -mt option. To link any other system library, use the appropriate -l option at link time. For example, to link the libdemangle library, pass -ldemangle on the CC command line at link time:

example% CC text.c -ldemangle

The C++ compiler has its own runtime support libraries. All C++ applications are linked to these libraries by the CC driver. The C++ compiler also comes with several other useful libraries, as explained in the following section.

12.2 Libraries Provided With the C++ Compiler

Several libraries are shipped with the C++ compiler. Some of these libraries are available only in compatibility mode (-compat=4), some are available only in the standard mode (-compat=5), and some are available in both modes. The libgc and libdemangle libraries have a C interface and can be linked to an application in either mode.

The following table lists the libraries that are shipped with the C++ compiler and the modes in which they are available.


Library	Description	Available Modes
`libCrun`	C++ runtime	`-compat=5`
`libCstd`	C++ standard library	`-compat=5`
`libiostream`	Classic `iostreams`	`-compat=5`
`libC`	C++ runtime, classic `iostreams`	`-compat=4`
`libcomplex`	`complex` library	`-compat=4`
`librwtool`	`Tools.h++` 7	`-compat=4`, `-compat=5`
`librwtool_dbg`	Debug-enabled `Tools.h++` 7	`-compat=4,-compat=5`
`libgc`	Garbage collection	C interface
`libgc_dbg`	Debug-enabled garbage collection	`-compat=4`, `-compat=5` C interface
`libdemangle`	Demangling	C interface

12.2.1 C++ Library Descriptions

A brief description of each of these libraries follows.

libCrun: This library contains the runtime support needed by the compiler in the standard mode (-compat=5). It provides support for new/delete, exceptions, and RTTI.

libCstd: This is the C++ standard library. In particular, it includes iostreams. If you have existing sources that use the classic iostreams and you want to make use of the standard iostreams, you have to modify your sources to conform to the new interface. See the C++ Standard Library Reference online manual for details. You can access this manual by pointing your web browser to:

file:/opt/SUNWspro/docs/index.html

If your compiler software is not installed in the /opt directory, ask your system administrator for the equivalent path on your system.

libiostream: This is the classic iostreams library built with -compat=5. If you have existing sources that use the classic iostreams and you want to compile these sources with the standard mode (-compat=5), you can use libiostream without modifying your sources. Use -library=iostream to get this library.

libC: This is the library needed in compatibility mode (-compat=4). It contains the C++ runtime support as well as the classic iostreams.

libcomplex: This library provides complex arithmetic in compatibility mode (-compat=4). In the standard mode, the complex arithmetic functionality is available in libCstd.

librwtool (Tools.h++): Tools.h++ is a C++ foundation class library from RogueWave. Version 7 of this library is provided with this release. This library is available in classic-iostreams form (-library=rwtools7) and standard-iostreams form (-library=rwtools7_std). For further information about this library, see the following online documentation.

Tools.h++ User's Guide (Version 7)

Tools.h++ Class Library Reference (Version 7)

You can access this documentation by pointing your web browser to:

file:/opt/SUNWspro/docs/index.html

If your compiler software is not installed in the /opt directory, ask your system administrator for the equivalent path on your system.

libgc: This library is used in deployment mode or garbage collection mode. Simply linking with the libgc library automatically and permanently fixes a program's memory leaks. When you link your program with the libgc library, you can program without calling free or delete while otherwise programming normally.

Additional information can be found in the gcFixPrematureFrees(3) and gcInitialize(3) man pages.

libdemangle: This library is used for demangling C++ mangled names.

12.2.2 Accessing the C++ Library Man Pages

The man pages associated with the libraries described in this section are located in:

/opt/SUNWspro/man/man1

/opt/SUNWspro/man/man3

/opt/SUNWspro/man/man3C++

/opt/SUNWspro/man/man3cc4

Note - If your compiler software is not installed in the /opt directory, ask your system administrator for the equivalent path on your system.

To access these man pages, ensure that your MANPATH includes /opt/SUNWspro/man (or the equivalent path on your system for the compiler software). For instructions on setting your MANPATH, see Accessing Forte Developer Man Pages in "Before You Begin" at the front of this book.

To access man pages for the C++ libraries, type:

example% man library-name

To access man pages for version 4.2 of the C++ libraries, type:

example% man -s 3CC4 library-name

You can also access the man pages by pointing your browser to:

file:/opt/SUNWspro/docs/index.html

12.2.3 Default C++ Libraries

Some of the C++ libraries are linked by default by the CC driver, while others need to be linked explicitly. In the standard mode, the following libraries are linked by default by the CC driver:

-lCstd -lCrun -lm -lw -lcx -lc

In compatibility mode (-compat), the following libraries are linked by default:

-lC -lm -lw -lcx -lc

See Section A.2.44, -library=l[,l...] for more information.

12.3 Related Library Options

The CC driver provides several options to help you use libraries.

Use the -l option to specify a library to be linked.

Use the -L option to specify a directory to be searched for the library.

Use the -mt option compile and link multithreaded code.

Use the -xia option to link the interval arithmetic libraries.

Use the -xlang option to link Fortran runtime libraries.

Use the -library option to specify the following libraries that are shipped with the Sun C++ compiler:

libCrun

libCstd

libiostream

libC

libcomplex

librwtool, librwtool_dbg

libgc, libgc_dbg

Note - To use the classic-iostreams form of librwtool, use the -library=rwtools7 option. To use the standard-iostreams form of librwtool, use the -library=rwtools7_std option.

A library that is specified using both -library and -staticlib options will be linked statically. Some examples:

The following command links the classic-iostreams form of Tools.h++ version 7 and libiostream libraries dynamically.

example% CC test.cc -library=rwtools7,iostream

The following command links the libgc library statically.

example% CC test.cc -library=gc -staticlib=gc

The following command compiles test.cc in compatibility mode and links libC statically. Because libC is linked by default in compatibility mode, you are not required to specify this library using the -library option.

example% CC test.cc -compat=4 -staticlib=libC

The following command excludes the libraries libCrun and libCstd, which would otherwise be included by default.

example% CC test.cc -library=no%Crun,no%Cstd

By default, CC links various sets of system libraries depending on the command line options. If you specify -xnolib (or -nolib), CC links only those libraries that are specified explicitly with the -l option on the command line. (When -xnolib or -nolib is used, the -library option is ignored, if present.)

The -R option allows you to build dynamic library search paths into the executable file. At execution time, the runtime linker searches these paths for the shared libraries needed by the application. The CC driver passes -R/opt/SUNWspro/lib to ld by default (if the compiler is installed in the standard location). You can use -norunpath to disable building the default path for shared libraries into the executable.

12.4 Using Class Libraries

Generally, two steps are involved in using a class library:

1. Include the appropriate header in your source code.

2. Link your program with the object library.

12.4.1 The `iostream` Library

The C++ compiler provides two implementations of iostreams:

Classic iostreams. This term refers to the iostreams library shipped with the C++ 4.0, 4.0.1, 4.1, and 4.2 compilers, and earlier with the cfront-based 3.0.1 compiler. There is no standard for this library, but a lot of existing code uses it. This library is part of libC in compatibility mode and is also available in libiostream in the standard mode.

Standard iostreams. This is part of the C++ standard library, libCstd, and is available only in standard mode. It is neither binary- nor source-compatible with the classic iostreams library.

If you have existing C++ sources, your code might look like the following example, which uses classic iostreams.

// file prog1.cc

#include <iostream.h>

int main() {

    cout << "Hello, world!" << endl;

    return 0;

The following command compiles in compatibility mode and links prog1.cc into an executable program called prog1. The classic iostream library is part of libC, which is linked by default in compatibility mode.

example% CC -compat prog1.cc -o prog1

The next example uses standard iostreams.

// file prog2.cc

#include <iostream>

int main() {

    std::cout << "Hello, world!" << std::endl;

    return 0;

The following command compiles and links prog2.cc into an executable program called prog2. The program is compiled in standard mode and libCstd, which includes the standard iostream library, is linked by default.

example% CC prog2.cc -o prog2

For more information about libCstd, see Chapter 13. For more information about libiostream, see Chapter 14.

12.4.2 The `complex` Library

The standard library provides a templatized complex library that is similar to the complex library provided with the C++ 4.2 compiler. If you compile in standard mode, you must use <complex> instead of <complex.h>. You cannot use <complex> in compatibility mode.

In compatibility mode, you must explicitly ask for the complex library when linking. In standard mode, the complex library is included in libCstd, and is linked by default.

There is no complex.h header for standard mode. In C++ 4.2, "complex" is the name of a class, but in standard C++, "complex" is the name of a template. It is not possible to provide typedefs that allow old code to work unchanged. Therefore, code written for 4.2 that uses complex numbers will need some straightforward editing to work with the standard library. For example, the following code was written for 4.2 and will compile in compatibility mode.

// file ex1.cc (compatibility mode)

#include <iostream.h>

#include <complex.h>

int main()

    complex x(3,3), y(4,4);

    complex z = x * y;

    cout << "x=" << x << ", y=" << y << ", z=" << z << endl;

The following example compiles and links ex1.cc in compatibility mode, and then executes the program.

example% CC -compat ex1.cc -library=complex

example% a.out

x=(3, 3), y=(4, 4), z=(0, 24)

Here is ex1.cc rewritten as ex2.cc to compile in standard mode:

// file ex2.cc (ex1.cc rewritten for standard mode)

#include <iostream>

#include <complex>

using std::complex;

int main()

     complex<double> x(3,3), y(4,4);

     complex<double> z = x * y;

     std::cout << "x=" << x << ", y=" << y << ", z=" << z <<

       std::endl;

The following example compiles and links the rewritten ex2.cc in standard mode, and then executes the program.

% CC ex2.cc

% a.out

x=(3,3), y=(4,4), z=(0,24)

For more information about using the complex arithmetic library, see Chapter 15.

12.4.3 Linking C++ Libraries

The following table shows the compiler options for linking the C++ libraries. See Section A.2.44, -library=l[,l...] for more information.


Library	Compile Mode	Option
Classic `iostream`	`-compat=4` `-compat=5`	None needed `-library=iostream`
`complex`	`-compat=4` `-compat=5`	`-library=complex` None needed
`Tools.h++` version 7	`-compat=4` `-compat=5`	`-library=rwtools7` `-library=rwtools7,iostream` `-library=rwtools7_std`
`Tools.h++` version 7 debug	`-compat=4` `-compat=5`	`-library=rwtools7_dbg` `-library=rwtools7_dbg,iostream` `-library=rwtools7_std_dbg`
Garbage collection	`-compat=4` `-compat=5`	`-library=gc` `-library=gc`
Garbage collection debug	`-compat=4` `-compat=5`	`-library=gc_dbg` `-library=gc_dbg`

12.5 Statically Linking Standard Libraries

The CC driver links in shared versions of several libraries by default, including libc and libm, by passing a -llib option for each of the default libraries to the linker. (See Section 12.2.3, Default C++ Libraries for the list of default libraries for compatibility mode and standard mode.)

If you want any of these default libraries to be linked statically, you can use the -library option along with the -staticlib option to link a C++ library statically. This alternative is much easier than the one described earlier. For example:

example% CC test.c -staticlib=Crun

In this example, the -library option is not explicitly included in the command. In this case the -library option is not necessary because the default setting for -library is Cstd,Crun in standard mode (the default mode).

Alternately, you can use the -xnolib compiler option. With the -xnolib option, the driver does not pass any -l options to ld; you must pass these options yourself. The following example shows how you would link statically with libCrun, and dynamically with libw, libm, and libc in the Solaris 2.6, Solaris 7, or Solaris 8 environment:

example% CC test.c -xnolib -lCstd -Bstatic -lCrun \

-Bdynamic -lm -lw -lcx -lc

The order of the -l options is important. The -lCstd, -lCrun, -lm, -lw, and -lcx options appear before -lc.

Note - The -lcx option does not exist on the IA platform.

Some CC options link to other libraries. These library links are also suppressed by -xnolib. For example, using the -mt option causes the CC driver to pass -lthread to ld. However, if you use both -mt and -xnolib, the CC driver does not pass -lthread to ld. See Section A.2.127, -xnolib for more information. See Linker and Libraries Guide for more information about ld.

12.6 Using Shared Libraries

The following shared libraries are included with the C++ compiler:

libCrun.so.1

libC.so.5

libcomplex.so.5

librwtool.so.2

libgc.so.1

libgc_dbg.so.1

libCstd.so.1

libiostream.so.1

libCstd.so

libiostream.so

Note - To use the libCstd and libiostream shared libraries, you must follow the steps in Section 14.1, Shared libiostream.

The occurrence of each shared object linked with the program is recorded in the resulting executable (a.out file); this information is used by ld.so to perform dynamic link editing at runtime. Because the work of incorporating the library code into an address space is deferred, the runtime behavior of the program using a shared library is sensitive to an environment change--that is, moving a library from one directory to another. For example, if your program is linked with libcomplex.so.5 in /opt/SUNWspro/lib, and the libcomplex.so.5 library is later moved into /opt2/SUNWspro/lib, the following message is displayed when you run the binary code:

ld.so: libcomplex.so.5: not found

You can still run the old binary code without recompiling it by setting the environment variable LD_LIBRARY_PATH to the new library directory.

In a C shell:

example% setenv LD_LIBRARY_PATH \

/opt2/SUNWspro/release/lib:${LD_LIBRARY_PATH}

In a Bourne shell:

example$ LD_LIBRARY_PATH=\

/opt2/SUNWspro/release/lib:${LD_LIBRARY_PATH}

example$ export LD_LIBRARY_PATH

Note - release is specific for each release of the compiler software.

The LD_LIBRARY_PATH has a list of directories, usually separated by colons. When you run a C++ program, the dynamic loader searches the directories in LD_LIBRARY_PATH before it searches the default directories.

Use the ldd command as shown in the following example to see which libraries are linked dynamically in your executable:

example% ldd a.out

This step should rarely be necessary, because the shared libraries are seldom moved.

Note - When shared libraries are opened with dlopen, RTLD_GLOBAL must be used for exceptions to work.

See Linker and Libraries Guide for more information on using shared libraries.

12.7 Replacing the C++ Standard Library

Replacing the standard library that is distributed with the compiler is risky, and good results are not guaranteed. The basic operation is to disable the standard headers and library supplied with the compiler, and to specify the directories where the new header files and library are found, as well as the name of the library itself.

12.7.1 What Can Be Replaced

You can replace most of the standard library and its associated headers. The replaced library is libCstd, and the associated headers are listed in the following table:

<algorithm> <bitset> <complex> <deque> <fstream <functional>

<iomanip> <ios> <iosfwd> <iostream> <istream> <iterator> <limits>

<list> <locale> <map> <memory> <numeric> <ostream> <queue> <set>

<sstream> <stack> <stdexcept> <streambuf> <string> <strstream>

<utility> <valarray> <vector>

The replaceable part of the library consists of what is loosely known as "STL", plus the string classes, the iostream classes, and their helper classes. Because these classes and headers are interdependent, replacing just a portion of them is unlikely to work. You should replace all of the headers and all of libCstd if you replace any part.

12.7.2 What Cannot Be Replaced

The standard headers <exception>, <new>, and <typeinfo> are tied tightly to the compiler itself and to libCrun, and cannot reliably be replaced. The library libCrun contains many "helper" functions that the compiler depends on, and cannot be replaced.

The 17 standard headers inherited from C (<stdlib.h>, <stdio.h>, <string.h>, and so forth) are tied tightly to the Solaris operating environment and the basic Solaris runtime library libc, and cannot reliably be replaced. The C++ versions of those headers (<cstdlib>, <cstdio>, <cstring>, and so forth) are tied tightly to the basic C versions and cannot reliably be replaced.

12.7.3 Installing the Replacement Library

To install the replacement library, you must first decide on the locations for the replacement headers and on the replacement for libCstd. For purposes of discussion, assume the headers are placed in /opt/mycstd/include and the library is placed in /opt/mycstd/lib. Assume the library is called libmyCstd.a. (It is often convenient if the library name starts with "lib".)

12.7.4 Using the Replacement Library

On each compilation, use the -I option to point to the location where the headers are installed. In addition, use the -library=no%Cstd option to prevent finding the compiler's own versions of the libCstd headers. For example:

example% CC -I/opt/mycstd/include -library=no%Cstd ... (compile)

During compiling, the -library=no%Cstd option prevents searching the directory where the compiler's own version of these headers is located.

On each program or library link, use the -library=no%Cstd option to prevent finding the compiler's own libCstd, the -L option to point to the directory where the replacement library is, and the -l option to specify the replacement library. Example:

example% CC -library=no%Cstd -L/opt/mycstd/lib -lmyCstd ... (link)

Alternatively, you can use the full path name of the library directly, and omit using the -L and -l options. For example:

example% CC -library=no%Cstd /opt/mycstd/lib/libmyCstd.a ... (link)

During linking, the -library=no%Cstd option prevents linking the compiler's own version of libCstd.

12.7.5 Standard Header Implementation

C has 17 standard headers (<stdio.h>, <string.h>, <stdlib.h>, and others). These headers are delivered as part of the Solaris operating environment, in the directory /usr/include. C++ has those same headers, with the added requirement that the various declared names appear in both the global namespace and in namespace std. On versions of the Solaris operating environment prior to Solaris 8, the C++ compiler supplies its own versions of these headers instead of replacing those in the /usr/include directory.

C++ also has a second version of each of the C standard headers (<cstdio>, <cstring>, and <cstdlib>, and others) with the various declared names appearing only in namespace std. Finally, C++ adds 32 of its own standard headers (<string>, <utility>, <iostream>, and others).

The obvious implementation of the standard headers would use the name found in C++ source code as the name of a text file to be included. For example, the standard headers <string> (or <string.h>) would refer to a file named string (or string.h) in some directory. That obvious implementation has the following drawbacks:

You cannot search for just header files or create a makefile rule for the header files if they do not have file name suffixes.

If you put -I/usr/include on the compiler command line, you do not get the correct version of the standard C headers on Solaris 2.6 and Solaris 7 operating environments because /usr/include is searched before the compiler's own include directory is searched.

If you have a directory or executable program named string, it might erroneously be found instead of the standard header file.

On versions of the Solaris operating environment prior to Solaris 8, the default dependencies for makefiles when .KEEP_STATE is enabled can result in attempts to replace standard headers with an executable program. (A file without a suffix is assumed by default to be a program to be built.)

To solve these problems, the compiler include directory contains a file with the same name as the header, along with a symbolic link to it that has the unique suffix .SUNWCCh (SUNW is the prefix for all compiler-related packages, CC is the C++ compiler, and h is the usual suffix for header files). When you specify <string>, the compiler rewrites it to <string.SUNWCCh> and searches for that name. The suffixed name will be found only in the compiler's own include directory. If the file so found is a symbolic link (which it normally is), the compiler dereferences the link exactly once and uses the result (string in this case) as the file name for error messages and debugger references. The compiler uses the suffixed name when emitting file dependency information.

The name rewriting occurs only for the two forms of the 17 standard C headers and the 32 standard C++ headers, only when they appear in angle brackets and without any path specified. If you use quotes instead of angle brackets, specify any path components, or specify some other header, no rewriting occurs.

The following table illustrates common situations.


Source Code	Compiler Searches For	Comments
`<string>`	`string.SUNWCCh`	C++ string templates
`<cstring>`	`cstring.SUNWCCh`	C++ version of C `string.h`
`<string.h>`	`string.h.SUNWCCh`	C `string.h`
`<fcntl.h>`	`fcntl.h`	Not a standard C or C++ header
`"string"`	`string`	Double-quotation marks, not angle brackets
`<../string>`	`../string`	Path specified

If the compiler does not find header.SUNWCCh, the compiler restarts the search looking for the name as provided in the #include directive. For example, given the directive #include <string>, the compiler attempts to find a file named string.SUNWCCh. If that search fails, the compiler looks for a file named string.

12.7.5.1 Replacing Standard C++ Headers

Because of the search algorithm described in Section 12.7.5, Standard Header Implementation, you do not need to supply SUNWCCh versions of the replacement headers described in Section 12.7.3, Installing the Replacement Library. But you might run into some of the described problems. If so, the recommended solution is to add symbolic links having the suffix .SUNWCCh for each of the unsuffixed headers. That is, for file utility, you would run the command

example% ln -s utility utility.SUNWCCh

When the compiler looks first for utility.SUNWCCh, it will find it, and not be confused by any other file or directory called utility.

12.7.5.2 Replacing Standard C Headers

Replacing the standard C headers is not supported. If you nevertheless wish to provide your own versions of standard headers, the recommended procedure is as follows:

Put all the replacement headers in one directory.

Create a .SUNWCCh symbolic link to each of the replacement headers in that directory.

Cause the directory that contains the replacement headers to be searched by using the -I directives on each invocation of the compiler.

For example, suppose you have replacements for <stdio.h> and <cstdio>. Put the files stdio.h and cstdio in directory /myproject/myhdr. In that directory, run these commands:

example% ln -s stdio.h stdio.h.SUNWCCh

example% ln -s cstdio cstdio.SUNWCCh

Use the option -I/myproject/mydir on every compilation.

Caveats:

If you replace any C headers, you must replace them in pairs. For example, if you replace <time.h>, you should also replace <ctime>.

Replacement headers must have the same effects as the versions being replaced. That is, the various runtime libraries such as libCrun, libC, libCstd, libc, and librwtool are built using the definitions in the standard headers. If your replacements do not match, your program is unlikely to work.