Quick Navigation Bar
debugging techniques :: creating libraries :: tips and tricks
[ toc | forums ]

Note: If the document URL does not begin with http://randu.org/tutorials/c/ then you are viewing a copy. Please direct your browser to the correct location for the most recent version.

Creating Libraries

If you have a bunch of files that contain just functions, you can turn these source files into libraries that can be used statically or dynamically by programs. This is good for program modularity, and code re-use. Write Once, Use Many.
A library is basically just an archive of object files.

Creating Libraries :: Static Library Setup

First thing you must do is create your C source files containing any functions that will be used. Your library can contain multiple object files.
After creating the C source files, compile the files into object files.
To create a library:
```
  ar rc libmylib.a objfile1.o objfile2.o objfile3.o
```
This will create a static library called libname.a. Rename the "mylib" portion of the library to whatever you want.
Next:
```
  ranlib libmylib.a
```
This creates an index inside the library. That should be it! If you plan on copying the library, remember to use the -p option with cp to preserve permissions.

Creating Libraries :: Static Library Usage

Remember to prototype your library function calls so that you do not get implicit declaration errors.
When linking your program to the libraries, make sure you specify where the library can be found:
```
  gcc -o foo -L. -lmylib foo.o
```
The -L. piece tells gcc to look in the current directory in addition to the other library directories for finding libmylib.a.
You can easily integrate this into your Makefile (even the Static Library Setup part)!

Creating Libraries :: Shared Library Setup

Creating shared or dynamic libraries is simple also. Using the previous example, to create a shared library:
```
  gcc -fPIC -c objfile1.c
  gcc -fPIC -c objfile2.c
  gcc -fPIC -c objfile3.c
  gcc -shared -o libmylib.so objfile1.o objfile2.o objfile3.o
```
The -fPIC option is to tell the compiler to create Position Independent Code (create libraries using relative addresses rather than absolute addresses because these libraries can be loaded multiple times). The -shared option is to specify that an architecture-dependent shared library is being created. However, not all platforms support this flag.
Now we have to compile the actual program using the libraries:
```
  gcc -o foo -L. -lmylib foo.o
```
Notice it is exactly the same as creating a static library. Although, it is compiled in the same way, none of the actual library code is inserted into the executable, hence the dynamic/shared library.
Note: You can automate this process using Makefiles!

Creating Libraries :: Shared Library Usage

Since programs that use static libraries already have the library code compiled into the program, it can run on its own. Shared libraries dynamically access libraries at run-time thus the program needs to know where the shared library is stored. What's the advantage of creating executables using Dynamic Libraries? The executable is much smaller than with static libraries. If it is a standard library that can be installed, there is no need to compile it into the executable at compile time!
The key to making your program work with dynamic libraries is through the LD_LIBRARY_PATH enviornment variable. To display this variable, at a shell:
```
  echo $LD_LIBRARY_PATH
```
Will display this variable if it is already defined. If it isn't, you can create a wrapper script for your program to set this variable at run-time. Depending on your shell, simply use setenv (tcsh, csh) or export (bash, sh, etc) commands. If you already have LD_LIBRARY_PATH defined, make sure you append to the variable, not overwrite it! For example:
```
  setenv LD_LIBRARY_PATH /path/to/library:${LD_LIBRARY_PATH}
```
would be the command you would use if you had tcsh/csh and already had an existing LD_LIBRARY_PATH. If you didn't have it already defined, just remove everything right of the :. An example with bash shells:
```
  export LD_LIBRARY_PATH=/path/to/library:${LD_LIBRARY_PATH}
```
Again, remove the stuff right of the : and the : itself if you don't already have an existing LD_LIBRARY_PATH.
If you have administrative rights to your computer, you can install the particular library to the /usr/local/lib directory and permanently add an LD_LIBRARY_PATH into your .tcshrc, .cshrc, .bashrc, etc. file.

Notice: Please do not replicate or copy these pages and host them elsewhere. This is to ensure that the latest version can always be found here.

Disclaimer: The document author has published these pages with the hope that it may be useful to others. However, the document author does not guarantee that all information contained on these webpages are correct or accurate. There is no warranty, expressed or implied, of merchantability or fitness for any purpose. The author does not assume any liability or responsibility for the use of the information contained on these webpages.

If you see an error, please send an email to the address below indicating the error. Your feedback is greatly appreciated and will help to continually improve these pages.