#

A Tour of NTL: Obtaining and Installing NTL for UNIX

This procedure should work on most Unix or Unix-like platorms (including Mac OSX, and Windows with MinGW or Cygwin tools).

To obtain the source code and documentation for NTL, download `ntl-xxx.tar.gz`, placing it a directory, and then, working in this directory, do the following. Here, "`xxx`" denotes the current version number.

       % gunzip ntl-xxx.tar.gz
       % tar xf ntl-xxx.tar
       % cd ntl-xxx/src
       % ./configure
       % make
       % make check
       % make install

This will build, test, and install NTL in `/usr/local`. For this to work, GMP must already be installed (most Unix distributions already come with GMP installed, but see this page for more details). If you really do not want to use GMP, you can pass the option `NTL_GMP_LIP=off` to `configure`.

After installation, you will find the NTL header files in `/usr/local/include/NTL` and the compiled binary in `/usr/local/lib/libntl.a` (this is a static library -- if you want a shared library, see below). Documentation is in `/usr/local/share/doc`, with the main entry-point at `/usr/local/share/doc/tour.html`.

If you want very high-performance for polynomial arithmetic over GF(2), you may want to consider using the `gf2x` library. To do this, `gf2x` must already be installed. In addition, you should invoke `configure` with the option `NTL_GF2X_LIB=on`. This page provides more details.

If you want to install NTL install NTL somewhere besides `/usr/local`, pass the option `PREFIX=/path/to/install/ntl` to `configure`. If GMP is installed somewhere besides `/usr/local`, pass the optopn `GMP_PREFIX=/path/to/gmp` to `configure`. You can also pass `GF2X_PREFIX=/path/to/gf2x` to `configure`, if `gf2x` is installed somewhere besides `/usr/local`. As a shorthand, you pass the option `DEF_PREFIX=/path/to/all/software`, which will override the default for `PREFIX`, `GMP_PREFIX`, and `GF2X_PREFIX`.

Now suppose you want to compile a program that uses NTL. Suppose you are working in some arbitrary directory and `foo.c` is your program. Assume that you have installed NTL in `/usr/local` as above. The following should work:

       % g++ -g -O2 foo.c -o foo -lntl -lgmp -lm

If you have installed NTL and/or GMP is a non-standard location, say `/path/to/sw`, then:

       % g++ -g -O2 -I/path/to/sw/include foo.c -o foo  -L/path/to/sw/lib -lntl -lgmp -lm

If you build NTL with `gf2x`, just add the option `-lgf2x` to the above, right after `-lgmp`.

If you are working in the NTL `src` directory itself, you can just run:

       % make foo

to compile a program `foo.c`, as above.

## More Details

What follows is a more detailed description of the installation process.

Step 1. Extract the source files by executing:

       % gunzip ntl-xxx.tar.gz
       % tar xvf ntl-xxx.tar

On most systems, the following shortcut works:

       % tar xzvf ntl-xxx.tar.gz

Note that this will unpack everything into a sub-directory `ntl-xxx`, creating this directory if necessary. Next:

       % cd ntl-xxx
       % ls

You should see a file "`README`", and directories "`include`", "`doc`", and "`src`". The directory "`doc`" contains all the documentation. The file "`doc/tour.html`" contains a copy of the on-line documentation. The directory "`include`" contains all the header files within a subdirectory "`include/NTL`". The directory "`src`" contains everything else. Go there now:

       % cd src

Step 2. Run the configuration script.

Execute the command

       % ./configure [ variable=value ]...

This configure script generates the file "`makefile`" and the file "`../include/NTL/config.h`", based upon the values assigned to the variables on the command line.

Here are the most important variables, and their default values.

    CXX=g++              # The C++ compiler

    CXXFLAGS=-g -O2      # C++ complilation flags

    NATIVE=on            # Compiles code targeted to the current hardware

    DEF_PREFIX=/usr/local# Default software directory

    PREFIX=$(DEF_PREFIX) # Directory in which to install NTL library components
    SHARED=off           # Generate a shared library (as well as static)

    NTL_THREADS=off      # compile in thread-safe mode
    NTL_THREAD_BOOST=off # compile with thread boosting enabled
    NTL_EXCEPTIONS=off   # compile with exceptions enabled

    NTL_GMP_LIP=on       # Switch to enable the use of GMP as primary
                         #   long integer package

    GMP_PREFIX=$(DEF_PREFIX) # Directory in which GMP components are installed

    NTL_GF2X_LIB=off     # Switch to enable the use of the gf2x package
                         #   for faster arithmetic GF(2)[X]

    GF2X_PREFIX=$(DEF_PREFIX) # Directory in which gf2x components are installed

Examples.

- If you are happy with all the default values, run:

         % ./configure

  Actually, the initially installed `makefile` and `config.h` files already reflect the default values, and you do not have to even run the configure script.

- If your C++ compilers is called CC, run:

         % ./configure CXX=CC

- If you want to use, say, the options `-g`, `-O3`, compiling `C++`, run:

         % ./configure "CXXFLAGS=-g -O3"

  If GMP was installed in `$HOME/sw`, run:

         % ./configure GMP_PREFIX=$HOME/sw

  Go here for complete details.

- If `gf2x` is installed in a standard system directory, and you want to use it to obtain better performance for polynomial arithemtic over GF(2), run:

         % ./configure NTL_GF2X_LIB=on

  If `gf2x` was installed in `$HOME/sw`, run:

         % ./configure NTL_GF2X_LIB=on GF2X_PREFIX=$HOME/sw

  Go here for complete details.

- If you want to install NTL in the directory `$HOME/sw`, run:

         % ./configure PREFIX=$HOME/sw

There are a number of more esoteric configuration variables that can be set. See `config.txt` for a complete description.

Note that many of these configuration options can also be set by editing the two files `makefile` and `../include/NTL/config.h` by hand. These files are fairly simple and well documented, and so this is not too hard to do.

Note that the file "`../include/NTL/def_config.h`" contains a backup copy of the original `config.h` file, and that the file "`def_makefile`" contains a backup copy of the original `makefile` file.

Step 3. Execute `make`.

Just type:

       % make

The build process after this point is fully automatic. But here is a description of what happens.

1. The makefile builds the file "`../include/NTL/mach_desc.h`", which defines some machine characteristics such as word size and machine precision. This is done by compiling and running a `C` program called `MakeDesc` that figures out these characteristics on its own, and prints some diagnostics to the terminal.

2. Several scripts are run to obtain more information about your system (e.g., to find a timing function, a "getpid" function, and to detect if things like Intel AVX intrinsics work).

3. The file "`../include/NTL/gmp_aux.h`" is generated for use with GMP. If not using GMP, this file is still created, but it is empty.

4. The configuration wizard script is run. This script works in a sub-directory, compiling several programs, and performing a number of timing experiments, in order to determine the optimal setting for a number of flags in the file `../include/NTL/config.h`. When the script finishes (it may take several minutes), you will be told what the wizard thinks are the best settings, and your `config.h` file will be automatically updated. Note that any flags you set in Step 2 will be in effect while the wizard runs, and will be retained in the updated `config.h` file, with the exception of the flags

          NTL_LONG_LONG NTL_AVOID_FLOAT NTL_TBL_REM NTL_TBL_REM_LL NTL_AVOID_BRANCHING
          NTL_SPMM_ULL NTL_SPMM_ASM NTL_GF2X_NOINLINE NTL_GF2X_ALTCODE
          NTL_GF2X_ALTCODE1 NTL_FFT_LAZYMUL NTL_FFT_BIGTAB NTL_PCLMUL

   which are set by the wizard. Also note that if you do not want the wizard to run, you should pass `WIZARD=off` to the configure script; however, this is not recommended.

5. The makefile will compile all the source files, and then creates the library "`ntl.a`" in the current directory.

Note that for finer control you can optionally break up this process into the five component steps:

       % make setup1
       % make setup2
       % make setup3
       % make setup4
       % make ntl.a

After NTL is built.

Executing `make check` runs a series of timing and test programs. It is a good idea to run this to see if everything really went well.

Executing `make install` copies a number of files to a directory `<prefix>` that you specify by passing `PREFIX=<prefix>` as an argument to `configure` at configuration time, or as an argument to `make install` at installation time (e.g., `make install PREFIX=/path/to/sw`). The default is `/usr/local`, so either you need root permissions, or you choose a `<prefix>` for which you have write permission. The files `../include/NTL/*` are copied into `<prefix>/include/NTL`. The file `ntl.a` is copied to `<prefix>/lib/libntl.a`. The files `../doc/*` are copied into `<prefix>/share/doc/NTL`.

You can also "fine tune" the installation procedure further. See the configure documentation for details.

Executing `make uninstall` undoes `make install`.

Executing `make clobber` essentially undoes `make`. Make sure you do this if you re-build NTL for a different architecture!

Executing `make clean` will remove object files, but not `ntl.a`. To rebuild after executing `make clean`, execute `make ntl.a`.

## Building a Shared Library

By default, the above installation procedure builds a static library only. Static libraries are nice because the procedures for building and using them are nearly identical across various flavors of Unix. However, static libraries have their drawbacks, and sometimes it is desirable to build a shared library. This can be done (in theory) by simply passing `SHARED=on` to NTL's `configure`.

If you set `SHARED=on`, then behind the scenes, the procedure used by the `makefile` changes a bit. In particular, the magical GNU program `libtool` is used to deal with all idiosyncracies of shared libraries. You may need to set the configuration variable `LIBTOOL`, to point to another version of `libtool`. For example, on Mac OSX, the built-in command called `libtool` is not actually the GNU `libtool` program; in this case, you will want to set `LIBTOOL=glibtool`. On other systems, it may be necssary to download and install a fresh copy of the libtool program (which can be obtained from here). Note that if `SHARED=on`, then in addition to using the `libtool` program, the `makefile` relies on features specific to GNU make.

Note that if you want to build NTL as a shared library, then if you use them, GMP and `gf2x` must also be built and installed as shared libraries. Also note that to use a shared library version of NTL, you may have to do something special, like set a special shell variable: the output generated by the `libtool` program during `make install` should give specific instructions. In addition, if NTL is built as a shared library, then you typically do not have to include `-lgmp` (if using GMP), or `-lgf2x` (if using `gf2x`), or corresponding `-L` flags, or `-lm` on the command line when compiling programs that use NTL.

## 32-bit and 64-bit ABIs

An ABI (Application Binary Interface) defines the sizes of various `C` data types. Typically, with a 32-bit ABI, int's and long's are 32 bits, while on a 64-bit ABI, int's are 32 bits and long's are 64 bits. Some platforms support both 64-bit and 32-bit ABI's; typically in such settings, the 64-bit ABI will yield much better performance, while the 32-bit ABI is available for backward compatibility. In addition, the 64-bit ABI may not be the default: if you are using `gcc`, you need to pass the `-m64` flag to the compiler to get the 64-bit ABI.

When compiling NTL, you may want to try running `configure` with `CFLAGS="-O2 -m64"` to force a 64-bit ABI -- this may yield a very marked performance improvement.

If you are using NTL with either the GMP or `gf2x` libraries, then these must be built with the same ABI as NTL. The installation script for GMP will typically select the 64-bit ABI automatically if it is available. The installation script for `gf2x` may need some hints.

When compiling programs that use NTL, you must also ensure that the program is compiled with the same ABI as NTL. Again, if you want a 64-bit ABI, then just pass the flag `-m64` to the compiler.