Chris@42: @node Installation and Customization, Acknowledgments, Upgrading from FFTW version 2, Top
Chris@42: @chapter Installation and Customization
Chris@42: @cindex installation
Chris@42: 
Chris@42: This chapter describes the installation and customization of FFTW, the
Chris@42: latest version of which may be downloaded from
Chris@42: @uref{http://www.fftw.org, the FFTW home page}.
Chris@42: 
Chris@42: In principle, FFTW should work on any system with an ANSI C compiler
Chris@42: (@code{gcc} is fine).  However, planner time is drastically reduced if
Chris@42: FFTW can exploit a hardware cycle counter; FFTW comes with cycle-counter
Chris@42: support for all modern general-purpose CPUs, but you may need to add a
Chris@42: couple of lines of code if your compiler is not yet supported
Chris@42: (@pxref{Cycle Counters}).  (On Unix, there will be a warning at the end
Chris@42: of the @code{configure} output if no cycle counter is found.)
Chris@42: @cindex cycle counter
Chris@42: @cindex compiler
Chris@42: @cindex portability
Chris@42: 
Chris@42: 
Chris@42: Installation of FFTW is simplest if you have a Unix or a GNU system,
Chris@42: such as GNU/Linux, and we describe this case in the first section below,
Chris@42: including the use of special configuration options to e.g. install
Chris@42: different precisions or exploit optimizations for particular
Chris@42: architectures (e.g. SIMD).  Compilation on non-Unix systems is a more
Chris@42: manual process, but we outline the procedure in the second section.  It
Chris@42: is also likely that pre-compiled binaries will be available for popular
Chris@42: systems.
Chris@42: 
Chris@42: Finally, we describe how you can customize FFTW for particular needs by
Chris@42: generating @emph{codelets} for fast transforms of sizes not supported
Chris@42: efficiently by the standard FFTW distribution.
Chris@42: @cindex codelet
Chris@42: 
Chris@42: @menu
Chris@42: * Installation on Unix::
Chris@42: * Installation on non-Unix systems::
Chris@42: * Cycle Counters::
Chris@42: * Generating your own code::
Chris@42: @end menu
Chris@42: 
Chris@42: @c ------------------------------------------------------------
Chris@42: 
Chris@42: @node Installation on Unix, Installation on non-Unix systems, Installation and Customization, Installation and Customization
Chris@42: @section Installation on Unix
Chris@42: 
Chris@42: FFTW comes with a @code{configure} program in the GNU style.
Chris@42: Installation can be as simple as:
Chris@42: @fpindex configure
Chris@42: 
Chris@42: @example
Chris@42: ./configure
Chris@42: make
Chris@42: make install
Chris@42: @end example
Chris@42: 
Chris@42: This will build the uniprocessor complex and real transform libraries
Chris@42: along with the test programs.  (We recommend that you use GNU
Chris@42: @code{make} if it is available; on some systems it is called
Chris@42: @code{gmake}.)  The ``@code{make install}'' command installs the fftw
Chris@42: and rfftw libraries in standard places, and typically requires root
Chris@42: privileges (unless you specify a different install directory with the
Chris@42: @code{--prefix} flag to @code{configure}).  You can also type
Chris@42: ``@code{make check}'' to put the FFTW test programs through their paces.
Chris@42: If you have problems during configuration or compilation, you may want
Chris@42: to run ``@code{make distclean}'' before trying again; this ensures that
Chris@42: you don't have any stale files left over from previous compilation
Chris@42: attempts.
Chris@42: 
Chris@42: The @code{configure} script chooses the @code{gcc} compiler by default,
Chris@42: if it is available; you can select some other compiler with:
Chris@42: @example
Chris@42: ./configure CC="@r{@i{<the name of your C compiler>}}"
Chris@42: @end example
Chris@42: 
Chris@42: The @code{configure} script knows good @code{CFLAGS} (C compiler flags)
Chris@42: @cindex compiler flags
Chris@42: for a few systems.  If your system is not known, the @code{configure}
Chris@42: script will print out a warning.  In this case, you should re-configure
Chris@42: FFTW with the command
Chris@42: @example
Chris@42: ./configure CFLAGS="@r{@i{<write your CFLAGS here>}}"
Chris@42: @end example
Chris@42: and then compile as usual.  If you do find an optimal set of
Chris@42: @code{CFLAGS} for your system, please let us know what they are (along
Chris@42: with the output of @code{config.guess}) so that we can include them in
Chris@42: future releases.
Chris@42: 
Chris@42: @code{configure} supports all the standard flags defined by the GNU
Chris@42: Coding Standards; see the @code{INSTALL} file in FFTW or
Chris@42: @uref{http://www.gnu.org/prep/standards/html_node/index.html, the GNU web page}.
Chris@42: Note especially @code{--help} to list all flags and
Chris@42: @code{--enable-shared} to create shared, rather than static, libraries.
Chris@42: @code{configure} also accepts a few FFTW-specific flags, particularly:
Chris@42: 
Chris@42: @itemize @bullet
Chris@42: 
Chris@42: @item
Chris@42: @cindex precision
Chris@42: @code{--enable-float}: Produces a single-precision version of FFTW
Chris@42: (@code{float}) instead of the default double-precision (@code{double}).
Chris@42: @xref{Precision}.
Chris@42: 
Chris@42: @item
Chris@42: @cindex precision
Chris@42: @code{--enable-long-double}: Produces a long-double precision version of
Chris@42: FFTW (@code{long double}) instead of the default double-precision
Chris@42: (@code{double}).  The @code{configure} script will halt with an error
Chris@42: message if @code{long double} is the same size as @code{double} on your
Chris@42: machine/compiler.  @xref{Precision}.
Chris@42: 
Chris@42: @item
Chris@42: @cindex precision
Chris@42: @code{--enable-quad-precision}: Produces a quadruple-precision version
Chris@42: of FFTW using the nonstandard @code{__float128} type provided by
Chris@42: @code{gcc} 4.6 or later on x86, x86-64, and Itanium architectures,
Chris@42: instead of the default double-precision (@code{double}).  The
Chris@42: @code{configure} script will halt with an error message if the
Chris@42: compiler is not @code{gcc} version 4.6 or later or if @code{gcc}'s
Chris@42: @code{libquadmath} library is not installed.  @xref{Precision}.
Chris@42: 
Chris@42: @item
Chris@42: @cindex threads
Chris@42: @code{--enable-threads}: Enables compilation and installation of the
Chris@42: FFTW threads library (@pxref{Multi-threaded FFTW}), which provides a
Chris@42: simple interface to parallel transforms for SMP systems.  By default,
Chris@42: the threads routines are not compiled.
Chris@42: 
Chris@42: @item
Chris@42: @code{--enable-openmp}: Like @code{--enable-threads}, but using OpenMP
Chris@42: compiler directives in order to induce parallelism rather than
Chris@42: spawning its own threads directly, and installing an @samp{fftw3_omp} library
Chris@42: rather than an @samp{fftw3_threads} library (@pxref{Multi-threaded           
Chris@42: FFTW}).  You can use both @code{--enable-openmp} and @code{--enable-threads}
Chris@42: since they compile/install libraries with different names.  By default,
Chris@42: the OpenMP routines are not compiled.
Chris@42: 
Chris@42: @item
Chris@42: @code{--with-combined-threads}: By default, if @code{--enable-threads}
Chris@42: is used, the threads support is compiled into a separate library that
Chris@42: must be linked in addition to the main FFTW library.  This is so that
Chris@42: users of the serial library do not need to link the system threads
Chris@42: libraries.  If @code{--with-combined-threads} is specified, however,
Chris@42: then no separate threads library is created, and threads are included
Chris@42: in the main FFTW library.  This is mainly useful under Windows, where
Chris@42: no system threads library is required and inter-library dependencies
Chris@42: are problematic.
Chris@42: 
Chris@42: @item
Chris@42: @cindex MPI
Chris@42: @code{--enable-mpi}: Enables compilation and installation of the FFTW
Chris@42: MPI library (@pxref{Distributed-memory FFTW with MPI}), which provides
Chris@42: parallel transforms for distributed-memory systems with MPI.  (By
Chris@42: default, the MPI routines are not compiled.)  @xref{FFTW MPI
Chris@42: Installation}.
Chris@42: 
Chris@42: @item
Chris@42: @cindex Fortran-callable wrappers
Chris@42: @code{--disable-fortran}: Disables inclusion of legacy-Fortran
Chris@42: wrapper routines (@pxref{Calling FFTW from Legacy Fortran}) in the standard
Chris@42: FFTW libraries.  These wrapper routines increase the library size by
Chris@42: only a negligible amount, so they are included by default as long as
Chris@42: the @code{configure} script finds a Fortran compiler on your system.
Chris@42: (To specify a particular Fortran compiler @i{foo}, pass
Chris@42: @code{F77=}@i{foo} to @code{configure}.)
Chris@42: 
Chris@42: @item
Chris@42: @code{--with-g77-wrappers}: By default, when Fortran wrappers are
Chris@42: included, the wrappers employ the linking conventions of the Fortran
Chris@42: compiler detected by the @code{configure} script.  If this compiler is
Chris@42: GNU @code{g77}, however, then @emph{two} versions of the wrappers are
Chris@42: included: one with @code{g77}'s idiosyncratic convention of appending
Chris@42: two underscores to identifiers, and one with the more common
Chris@42: convention of appending only a single underscore.  This way, the same
Chris@42: FFTW library will work with both @code{g77} and other Fortran
Chris@42: compilers, such as GNU @code{gfortran}.  However, the converse is not
Chris@42: true: if you configure with a different compiler, then the
Chris@42: @code{g77}-compatible wrappers are not included.  By specifying
Chris@42: @code{--with-g77-wrappers}, the @code{g77}-compatible wrappers are
Chris@42: included in addition to wrappers for whatever Fortran compiler
Chris@42: @code{configure} finds.
Chris@42: @fpindex g77
Chris@42: 
Chris@42: @item
Chris@42: @code{--with-slow-timer}: Disables the use of hardware cycle counters,
Chris@42: and falls back on @code{gettimeofday} or @code{clock}.  This greatly
Chris@42: worsens performance, and should generally not be used (unless you don't
Chris@42: have a cycle counter but still really want an optimized plan regardless
Chris@42: of the time).  @xref{Cycle Counters}.
Chris@42: 
Chris@42: @item
Chris@42: @code{--enable-sse} (single precision),
Chris@42: @code{--enable-sse2} (single, double),
Chris@42: @code{--enable-avx} (single, double),
Chris@42: @code{--enable-avx2} (single, double),
Chris@42: @code{--enable-avx512} (single, double),
Chris@42: @code{--enable-avx-128-fma},
Chris@42: @code{--enable-kcvi} (single),
Chris@42: @code{--enable-altivec} (single),
Chris@42: @code{--enable-vsx} (single, double),
Chris@42: @code{--enable-neon} (single, double on aarch64),
Chris@42: @code{--enable-generic-simd128},
Chris@42: and
Chris@42: @code{--enable-generic-simd256}:
Chris@42: 
Chris@42: Enable various SIMD instruction sets.  You need compiler that supports
Chris@42: the given SIMD extensions, but FFTW will try to detect at runtime
Chris@42: whether the CPU supports these extensions.  That is, you can compile
Chris@42: with@code{--enable-avx} and the code will still run on a CPU without AVX
Chris@42: support.
Chris@42: 
Chris@42: @itemize @minus
Chris@42: @item
Chris@42: These options require a compiler supporting SIMD extensions, and
Chris@42: compiler support is always a bit flaky: see the FFTW FAQ for a list of
Chris@42: compiler versions that have problems compiling FFTW.
Chris@42: @item
Chris@42: Because of the large variety of ARM processors and ABIs, FFTW
Chris@42: does not attempt to guess the correct @code{gcc} flags for generating
Chris@42: NEON code.  In general, you will have to provide them on the command line.
Chris@42: This command line is known to have worked at least once:
Chris@42: @example
Chris@42: ./configure --with-slow-timer --host=arm-linux-gnueabi \
Chris@42:   --enable-single --enable-neon \
Chris@42:   "CC=arm-linux-gnueabi-gcc -march=armv7-a -mfloat-abi=softfp"
Chris@42: @end example
Chris@42: @end itemize
Chris@42: 
Chris@42: @end itemize
Chris@42: 
Chris@42: @cindex compiler
Chris@42: To force @code{configure} to use a particular C compiler @i{foo}
Chris@42: (instead of the default, usually @code{gcc}), pass @code{CC=}@i{foo} to the 
Chris@42: @code{configure} script; you may also need to set the flags via the variable
Chris@42: @code{CFLAGS} as described above.
Chris@42: @cindex compiler flags
Chris@42: 
Chris@42: @c ------------------------------------------------------------
Chris@42: @node Installation on non-Unix systems, Cycle Counters, Installation on Unix, Installation and Customization
Chris@42: @section Installation on non-Unix systems
Chris@42: 
Chris@42: It should be relatively straightforward to compile FFTW even on non-Unix
Chris@42: systems lacking the niceties of a @code{configure} script.  Basically,
Chris@42: you need to edit the @code{config.h} header (copy it from
Chris@42: @code{config.h.in}) to @code{#define} the various options and compiler
Chris@42: characteristics, and then compile all the @samp{.c} files in the
Chris@42: relevant directories.  
Chris@42: 
Chris@42: The @code{config.h} header contains about 100 options to set, each one
Chris@42: initially an @code{#undef}, each documented with a comment, and most of
Chris@42: them fairly obvious.  For most of the options, you should simply
Chris@42: @code{#define} them to @code{1} if they are applicable, although a few
Chris@42: options require a particular value (e.g. @code{SIZEOF_LONG_LONG} should
Chris@42: be defined to the size of the @code{long long} type, in bytes, or zero
Chris@42: if it is not supported).  We will likely post some sample
Chris@42: @code{config.h} files for various operating systems and compilers for
Chris@42: you to use (at least as a starting point).  Please let us know if you
Chris@42: have to hand-create a configuration file (and/or a pre-compiled binary)
Chris@42: that you want to share.
Chris@42: 
Chris@42: To create the FFTW library, you will then need to compile all of the
Chris@42: @samp{.c} files in the @code{kernel}, @code{dft}, @code{dft/scalar},
Chris@42: @code{dft/scalar/codelets}, @code{rdft}, @code{rdft/scalar},
Chris@42: @code{rdft/scalar/r2cf}, @code{rdft/scalar/r2cb},
Chris@42: @code{rdft/scalar/r2r}, @code{reodft}, and @code{api} directories.
Chris@42: If you are compiling with SIMD support (e.g. you defined
Chris@42: @code{HAVE_SSE2} in @code{config.h}), then you also need to compile
Chris@42: the @code{.c} files in the @code{simd-support},
Chris@42: @code{@{dft,rdft@}/simd}, @code{@{dft,rdft@}/simd/*} directories.
Chris@42: 
Chris@42: Once these files are all compiled, link them into a library, or a shared
Chris@42: library, or directly into your program.
Chris@42: 
Chris@42: To compile the FFTW test program, additionally compile the code in the
Chris@42: @code{libbench2/} directory, and link it into a library.  Then compile
Chris@42: the code in the @code{tests/} directory and link it to the
Chris@42: @code{libbench2} and FFTW libraries.  To compile the @code{fftw-wisdom}
Chris@42: (command-line) tool (@pxref{Wisdom Utilities}), compile
Chris@42: @code{tools/fftw-wisdom.c} and link it to the @code{libbench2} and FFTW
Chris@42: libraries
Chris@42: 
Chris@42: @c ------------------------------------------------------------
Chris@42: @node Cycle Counters, Generating your own code, Installation on non-Unix systems, Installation and Customization
Chris@42: @section Cycle Counters
Chris@42: @cindex cycle counter
Chris@42: 
Chris@42: FFTW's planner actually executes and times different possible FFT
Chris@42: algorithms in order to pick the fastest plan for a given @math{n}.  In
Chris@42: order to do this in as short a time as possible, however, the timer must
Chris@42: have a very high resolution, and to accomplish this we employ the
Chris@42: hardware @dfn{cycle counters} that are available on most CPUs.
Chris@42: Currently, FFTW supports the cycle counters on x86, PowerPC/POWER, Alpha,
Chris@42: UltraSPARC (SPARC v9), IA64, PA-RISC, and MIPS processors.
Chris@42: 
Chris@42: @cindex compiler
Chris@42: Access to the cycle counters, unfortunately, is a compiler and/or
Chris@42: operating-system dependent task, often requiring inline assembly
Chris@42: language, and it may be that your compiler is not supported.  If you are
Chris@42: @emph{not} supported, FFTW will by default fall back on its estimator
Chris@42: (effectively using @code{FFTW_ESTIMATE} for all plans).
Chris@42: @ctindex FFTW_ESTIMATE
Chris@42: 
Chris@42: You can add support by editing the file @code{kernel/cycle.h}; normally,
Chris@42: this will involve adapting one of the examples already present in order
Chris@42: to use the inline-assembler syntax for your C compiler, and will only
Chris@42: require a couple of lines of code.  Anyone adding support for a new
Chris@42: system to @code{cycle.h} is encouraged to email us at @email{fftw@@fftw.org}.
Chris@42: 
Chris@42: If a cycle counter is not available on your system (e.g. some embedded
Chris@42: processor), and you don't want to use estimated plans, as a last resort
Chris@42: you can use the @code{--with-slow-timer} option to @code{configure} (on
Chris@42: Unix) or @code{#define WITH_SLOW_TIMER} in @code{config.h} (elsewhere).
Chris@42: This will use the much lower-resolution @code{gettimeofday} function, or even
Chris@42: @code{clock} if the former is unavailable, and planning will be
Chris@42: extremely slow.
Chris@42: 
Chris@42: @c ------------------------------------------------------------
Chris@42: @node Generating your own code,  , Cycle Counters, Installation and Customization
Chris@42: @section Generating your own code
Chris@42: @cindex code generator
Chris@42: 
Chris@42: The directory @code{genfft} contains the programs that were used to
Chris@42: generate FFTW's ``codelets,'' which are hard-coded transforms of small
Chris@42: sizes.
Chris@42: @cindex codelet
Chris@42: We do not expect casual users to employ the generator, which is a rather
Chris@42: sophisticated program that generates directed acyclic graphs of FFT
Chris@42: algorithms and performs algebraic simplifications on them.  It was
Chris@42: written in Objective Caml, a dialect of ML, which is available at
Chris@42: @uref{http://caml.inria.fr/ocaml/index.en.html}.
Chris@42: @cindex Caml
Chris@42: 
Chris@42: 
Chris@42: If you have Objective Caml installed (along with recent versions of
Chris@42: GNU @code{autoconf}, @code{automake}, and @code{libtool}), then you
Chris@42: can change the set of codelets that are generated or play with the
Chris@42: generation options.  The set of generated codelets is specified by the
Chris@42: @code{@{dft,rdft@}/@{codelets,simd@}/*/Makefile.am} files.  For example, you can add
Chris@42: efficient REDFT codelets of small sizes by modifying
Chris@42: @code{rdft/codelets/r2r/Makefile.am}.
Chris@42: @cindex REDFT
Chris@42: After you modify any @code{Makefile.am} files, you can type @code{sh
Chris@42: bootstrap.sh} in the top-level directory followed by @code{make} to
Chris@42: re-generate the files.
Chris@42: 
Chris@42: We do not provide more details about the code-generation process, since
Chris@42: we do not expect that most users will need to generate their own code.
Chris@42: However, feel free to contact us at @email{fftw@@fftw.org} if
Chris@42: you are interested in the subject.
Chris@42: 
Chris@42: @cindex monadic programming
Chris@42: You might find it interesting to learn Caml and/or some modern
Chris@42: programming techniques that we used in the generator (including monadic
Chris@42: programming), especially if you heard the rumor that Java and
Chris@42: object-oriented programming are the latest advancement in the field.
Chris@42: The internal operation of the codelet generator is described in the
Chris@42: paper, ``A Fast Fourier Transform Compiler,'' by M. Frigo, which is
Chris@42: available from the @uref{http://www.fftw.org,FFTW home page} and also
Chris@42: appeared in the @cite{Proceedings of the 1999 ACM SIGPLAN Conference on
Chris@42: Programming Language Design and Implementation (PLDI)}.
Chris@42: