Chapter 17. Creating libraries with GCC
Chapter 17. Creating libraries with GCC This chapter describes steps for creating libraries and explains the necessary concepts used by the Linux operating system for libraries. 17.1. Library Naming Conventions A special file name convention is used for libraries: A library known as foo is expected to exist as the file lib foo .so or lib foo .a . This convention is automatically understood by the linking input options of gcc , but not by the output options: When linking against the library, the library can be specified only by its name foo with the -l option as -l foo : When creating the library, the full file name lib foo .so or lib foo .a must be specified. Additional Resources Section 17.2, "The soname Mechanism" 17.2. The soname Mechanism Dynamically loaded libraries (shared objects) use a mechanism called soname to manage multiple compatible versions of a library. Prerequisites Understanding of dynamic linking and libraries Understanding of the concept of ABI compatibility Understanding of library naming conventions Understanding of symbolic links Problem Introduction A dynamically loaded library (shared object) exists as an independent executable file. This makes it possible to update the library without updating the applications that depend on it. However, the following problems arise with this concept: The identification of the actual version of the library The need for multiple versions of the same library present The signalling of ABI compatibility of each of the multiple versions The soname Mechanism To resolve this, Linux uses a mechanism called soname. A library foo version X.Y is ABI-compatible with other versions with the same value of X in the version number. Minor changes preserving compatibility increase the number Y . Major changes that break compatibility increase the number X . The actual library foo version X.Y exists as the file libfoo.so. x . y . Inside the library file, a soname is recorded with the value libfoo.so.x to signal the compatibility. When applications are built, the linker looks for the library by searching for the file libfoo.so . A symbolic link with this name must exist, pointing to the actual library file. The linker then reads the soname from the library file and records it into the application executable file. Finally, the linker creates the application so that it declares dependency on the library using the soname, not name or file name. When the runtime dynamic linker links an application before running, it reads the soname from the executable file of the application. This soname is libfoo.so. x . A symbolic link with this name must exist, pointing to the actual library file. This allows loading the library, regardless of the Y component of the version, because the soname does not change. Note The Y component of the version number is not limited to just a single number. Additionally, some libraries encode the version in their name. Reading soname from a File To display the soname of a library file somelibrary : Replace somelibrary with the actual file name of the library you wish to examine. 17.3. Creating Dynamic Libraries with GCC Dynamically linked libraries (shared objects) allow resource conservation through code reuse and increased security by easier updates of the library code. This section describes the steps to build and install a dynamic library from source. Prerequisites Understanding of the soname mechanism GCC is installed on the system Source code for a library Procedure Change to the directory with library sources. Compile each source file to an object file with the position-independent code option -fPIC : The object files have the same file names as the original source code files, but their extension is .o . Link the shared library from the object files: The used major version number is X and the minor version number is Y. Copy the libfoo.so.x.y file to an appropriate location where the system's dynamic linker can find it. On Red Hat Enterprise Linux, the directory for libraries is /usr/lib64 : Note that you need root permissions to manipulate files in this directory. Create the symlink structure for the soname mechanism: Additional Resources The Linux Documentation Project - Program Library HOWTO - 3. Shared Libraries 17.4. Creating Static Libraries with GCC and ar Creating libraries for static linking is possible through the conversion of object files into a special type of archive file. Note Red Hat discourages the use of static linking for security reasons. Use static linking only when necessary, especially against libraries provided by Red Hat. See Section 16.2, "Static and dynamic linking" . Prerequisites GCC and binutils are installed on the system Understanding of static and dynamic linking A source file with functions to be shared as a library Procedure Create intermediate object files with GCC. Append more source files as required. The resulting object files share the file name but use the .o file name extension. Turn the object files into a static library (archive) using the ar tool from the binutils package. The file libfoo.a is created. Use the nm command to inspect the resulting archive: Copy the static library file to the appropriate directory. When linking against the library, GCC will automatically recognize from the .a file name extension that the library is an archive for static linking. Additional Resources The Linux manual page for the ar tool:
gcc ... -l foo objdump -p somelibrary | grep SONAME gcc ... -c -fPIC some_file.c gcc -shared -o libfoo.so.x.y -Wl,-soname, libfoo.so.x some_file.o cp libfoo.so.x.y /usr/lib64 ln -s libfoo.so.x.y libfoo.so.x ln -s libfoo.so.x libfoo.so gcc -c source_file.c ar rcs lib foo .a source_file.o nm libfoo.a gcc ... -l foo man ar