Mercurial > hg > sv-dependency-builds

comparison src/fftw-3.3.5/doc/html/Installation-on-Unix.html @ 127:7867fa7e1b6b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Current fftw source
author Chris Cannam <cannam@all-day-breakfast.com>
date Tue, 18 Oct 2016 13:40:26 +0100
parents
children
comparison
equal deleted inserted replaced
126:4a7071416412 127:7867fa7e1b6b
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <html>
3 <!-- This manual is for FFTW
4 (version 3.3.5, 30 July 2016).
5
6 Copyright (C) 2003 Matteo Frigo.
7
8 Copyright (C) 2003 Massachusetts Institute of Technology.
9
10 Permission is granted to make and distribute verbatim copies of this
11 manual provided the copyright notice and this permission notice are
12 preserved on all copies.
13
14 Permission is granted to copy and distribute modified versions of this
15 manual under the conditions for verbatim copying, provided that the
16 entire resulting derived work is distributed under the terms of a
17 permission notice identical to this one.
18
19 Permission is granted to copy and distribute translations of this manual
20 into another language, under the above conditions for modified versions,
21 except that this permission notice may be stated in a translation
22 approved by the Free Software Foundation. -->
23 <!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
24 <head>
25 <title>FFTW 3.3.5: Installation on Unix</title>
26
27 <meta name="description" content="FFTW 3.3.5: Installation on Unix">
28 <meta name="keywords" content="FFTW 3.3.5: Installation on Unix">
29 <meta name="resource-type" content="document">
30 <meta name="distribution" content="global">
31 <meta name="Generator" content="makeinfo">
32 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
33 <link href="index.html#Top" rel="start" title="Top">
34 <link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
35 <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
36 <link href="Installation-and-Customization.html#Installation-and-Customization" rel="up" title="Installation and Customization">
37 <link href="Installation-on-non_002dUnix-systems.html#Installation-on-non_002dUnix-systems" rel="next" title="Installation on non-Unix systems">
38 <link href="Installation-and-Customization.html#Installation-and-Customization" rel="prev" title="Installation and Customization">
39 <style type="text/css">
40 <!--
41 a.summary-letter {text-decoration: none}
42 blockquote.smallquotation {font-size: smaller}
43 div.display {margin-left: 3.2em}
44 div.example {margin-left: 3.2em}
45 div.indentedblock {margin-left: 3.2em}
46 div.lisp {margin-left: 3.2em}
47 div.smalldisplay {margin-left: 3.2em}
48 div.smallexample {margin-left: 3.2em}
49 div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
50 div.smalllisp {margin-left: 3.2em}
51 kbd {font-style:oblique}
52 pre.display {font-family: inherit}
53 pre.format {font-family: inherit}
54 pre.menu-comment {font-family: serif}
55 pre.menu-preformatted {font-family: serif}
56 pre.smalldisplay {font-family: inherit; font-size: smaller}
57 pre.smallexample {font-size: smaller}
58 pre.smallformat {font-family: inherit; font-size: smaller}
59 pre.smalllisp {font-size: smaller}
60 span.nocodebreak {white-space:nowrap}
61 span.nolinebreak {white-space:nowrap}
62 span.roman {font-family:serif; font-weight:normal}
63 span.sansserif {font-family:sans-serif; font-weight:normal}
64 ul.no-bullet {list-style: none}
65 -->
66 </style>
67
68
69 </head>
70
71 <body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
72 <a name="Installation-on-Unix"></a>
73 <div class="header">
74 <p>
75 Next: <a href="Installation-on-non_002dUnix-systems.html#Installation-on-non_002dUnix-systems" accesskey="n" rel="next">Installation on non-Unix systems</a>, Previous: <a href="Installation-and-Customization.html#Installation-and-Customization" accesskey="p" rel="prev">Installation and Customization</a>, Up: <a href="Installation-and-Customization.html#Installation-and-Customization" accesskey="u" rel="up">Installation and Customization</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
76 </div>
77 <hr>
78 <a name="Installation-on-Unix-1"></a>
79 <h3 class="section">10.1 Installation on Unix</h3>
80
81 <p>FFTW comes with a <code>configure</code> program in the GNU style.
82 Installation can be as simple as:
83 <a name="index-configure-2"></a>
84 </p>
85 <div class="example">
86 <pre class="example">./configure
87 make
88 make install
89 </pre></div>
90
91 <p>This will build the uniprocessor complex and real transform libraries
92 along with the test programs. (We recommend that you use GNU
93 <code>make</code> if it is available; on some systems it is called
94 <code>gmake</code>.) The &ldquo;<code>make install</code>&rdquo; command installs the fftw
95 and rfftw libraries in standard places, and typically requires root
96 privileges (unless you specify a different install directory with the
97 <code>--prefix</code> flag to <code>configure</code>). You can also type
98 &ldquo;<code>make check</code>&rdquo; to put the FFTW test programs through their paces.
99 If you have problems during configuration or compilation, you may want
100 to run &ldquo;<code>make distclean</code>&rdquo; before trying again; this ensures that
101 you don&rsquo;t have any stale files left over from previous compilation
102 attempts.
103 </p>
104 <p>The <code>configure</code> script chooses the <code>gcc</code> compiler by default,
105 if it is available; you can select some other compiler with:
106 </p><div class="example">
107 <pre class="example">./configure CC=&quot;<span class="roman"><i>&lt;the name of your C compiler&gt;</i></span>&quot;
108 </pre></div>
109
110 <p>The <code>configure</code> script knows good <code>CFLAGS</code> (C compiler flags)
111 <a name="index-compiler-flags"></a>
112 for a few systems. If your system is not known, the <code>configure</code>
113 script will print out a warning. In this case, you should re-configure
114 FFTW with the command
115 </p><div class="example">
116 <pre class="example">./configure CFLAGS=&quot;<span class="roman"><i>&lt;write your CFLAGS here&gt;</i></span>&quot;
117 </pre></div>
118 <p>and then compile as usual. If you do find an optimal set of
119 <code>CFLAGS</code> for your system, please let us know what they are (along
120 with the output of <code>config.guess</code>) so that we can include them in
121 future releases.
122 </p>
123 <p><code>configure</code> supports all the standard flags defined by the GNU
124 Coding Standards; see the <code>INSTALL</code> file in FFTW or
125 <a href="http://www.gnu.org/prep/standards/html_node/index.html">the GNU web page</a>.
126 Note especially <code>--help</code> to list all flags and
127 <code>--enable-shared</code> to create shared, rather than static, libraries.
128 <code>configure</code> also accepts a few FFTW-specific flags, particularly:
129 </p>
130 <ul>
131 <li> <a name="index-precision-9"></a>
132 <code>--enable-float</code>: Produces a single-precision version of FFTW
133 (<code>float</code>) instead of the default double-precision (<code>double</code>).
134 See <a href="Precision.html#Precision">Precision</a>.
135
136 </li><li> <a name="index-precision-10"></a>
137 <code>--enable-long-double</code>: Produces a long-double precision version of
138 FFTW (<code>long double</code>) instead of the default double-precision
139 (<code>double</code>). The <code>configure</code> script will halt with an error
140 message if <code>long double</code> is the same size as <code>double</code> on your
141 machine/compiler. See <a href="Precision.html#Precision">Precision</a>.
142
143 </li><li> <a name="index-precision-11"></a>
144 <code>--enable-quad-precision</code>: Produces a quadruple-precision version
145 of FFTW using the nonstandard <code>__float128</code> type provided by
146 <code>gcc</code> 4.6 or later on x86, x86-64, and Itanium architectures,
147 instead of the default double-precision (<code>double</code>). The
148 <code>configure</code> script will halt with an error message if the
149 compiler is not <code>gcc</code> version 4.6 or later or if <code>gcc</code>&rsquo;s
150 <code>libquadmath</code> library is not installed. See <a href="Precision.html#Precision">Precision</a>.
151
152 </li><li> <a name="index-threads-3"></a>
153 <code>--enable-threads</code>: Enables compilation and installation of the
154 FFTW threads library (see <a href="Multi_002dthreaded-FFTW.html#Multi_002dthreaded-FFTW">Multi-threaded FFTW</a>), which provides a
155 simple interface to parallel transforms for SMP systems. By default,
156 the threads routines are not compiled.
157
158 </li><li> <code>--enable-openmp</code>: Like <code>--enable-threads</code>, but using OpenMP
159 compiler directives in order to induce parallelism rather than
160 spawning its own threads directly, and installing an &lsquo;<samp>fftw3_omp</samp>&rsquo; library
161 rather than an &lsquo;<samp>fftw3_threads</samp>&rsquo; library (see <a href="Multi_002dthreaded-FFTW.html#Multi_002dthreaded-FFTW">Multi-threaded FFTW</a>). You can use both <code>--enable-openmp</code> and <code>--enable-threads</code>
162 since they compile/install libraries with different names. By default,
163 the OpenMP routines are not compiled.
164
165 </li><li> <code>--with-combined-threads</code>: By default, if <code>--enable-threads</code>
166 is used, the threads support is compiled into a separate library that
167 must be linked in addition to the main FFTW library. This is so that
168 users of the serial library do not need to link the system threads
169 libraries. If <code>--with-combined-threads</code> is specified, however,
170 then no separate threads library is created, and threads are included
171 in the main FFTW library. This is mainly useful under Windows, where
172 no system threads library is required and inter-library dependencies
173 are problematic.
174
175 </li><li> <a name="index-MPI-1"></a>
176 <code>--enable-mpi</code>: Enables compilation and installation of the FFTW
177 MPI library (see <a href="Distributed_002dmemory-FFTW-with-MPI.html#Distributed_002dmemory-FFTW-with-MPI">Distributed-memory FFTW with MPI</a>), which provides
178 parallel transforms for distributed-memory systems with MPI. (By
179 default, the MPI routines are not compiled.) See <a href="FFTW-MPI-Installation.html#FFTW-MPI-Installation">FFTW MPI Installation</a>.
180
181 </li><li> <a name="index-Fortran_002dcallable-wrappers"></a>
182 <code>--disable-fortran</code>: Disables inclusion of legacy-Fortran
183 wrapper routines (see <a href="Calling-FFTW-from-Legacy-Fortran.html#Calling-FFTW-from-Legacy-Fortran">Calling FFTW from Legacy Fortran</a>) in the standard
184 FFTW libraries. These wrapper routines increase the library size by
185 only a negligible amount, so they are included by default as long as
186 the <code>configure</code> script finds a Fortran compiler on your system.
187 (To specify a particular Fortran compiler <i>foo</i>, pass
188 <code>F77=</code><i>foo</i> to <code>configure</code>.)
189
190 </li><li> <code>--with-g77-wrappers</code>: By default, when Fortran wrappers are
191 included, the wrappers employ the linking conventions of the Fortran
192 compiler detected by the <code>configure</code> script. If this compiler is
193 GNU <code>g77</code>, however, then <em>two</em> versions of the wrappers are
194 included: one with <code>g77</code>&rsquo;s idiosyncratic convention of appending
195 two underscores to identifiers, and one with the more common
196 convention of appending only a single underscore. This way, the same
197 FFTW library will work with both <code>g77</code> and other Fortran
198 compilers, such as GNU <code>gfortran</code>. However, the converse is not
199 true: if you configure with a different compiler, then the
200 <code>g77</code>-compatible wrappers are not included. By specifying
201 <code>--with-g77-wrappers</code>, the <code>g77</code>-compatible wrappers are
202 included in addition to wrappers for whatever Fortran compiler
203 <code>configure</code> finds.
204 <a name="index-g77"></a>
205
206 </li><li> <code>--with-slow-timer</code>: Disables the use of hardware cycle counters,
207 and falls back on <code>gettimeofday</code> or <code>clock</code>. This greatly
208 worsens performance, and should generally not be used (unless you don&rsquo;t
209 have a cycle counter but still really want an optimized plan regardless
210 of the time). See <a href="Cycle-Counters.html#Cycle-Counters">Cycle Counters</a>.
211
212 </li><li> <code>--enable-sse</code> (single precision),
213 <code>--enable-sse2</code> (single, double),
214 <code>--enable-avx</code> (single, double),
215 <code>--enable-avx2</code> (single, double),
216 <code>--enable-avx512</code> (single, double),
217 <code>--enable-avx-128-fma</code>,
218 <code>--enable-kcvi</code> (single),
219 <code>--enable-altivec</code> (single),
220 <code>--enable-vsx</code> (single, double),
221 <code>--enable-neon</code> (single, double on aarch64),
222 <code>--enable-generic-simd128</code>,
223 and
224 <code>--enable-generic-simd256</code>:
225
226 <p>Enable various SIMD instruction sets. You need compiler that supports
227 the given SIMD extensions, but FFTW will try to detect at runtime
228 whether the CPU supports these extensions. That is, you can compile
229 with<code>--enable-avx</code> and the code will still run on a CPU without AVX
230 support.
231 </p>
232 <ul class="no-bullet">
233 <li>- These options require a compiler supporting SIMD extensions, and
234 compiler support is always a bit flaky: see the FFTW FAQ for a list of
235 compiler versions that have problems compiling FFTW.
236 </li><li>- Because of the large variety of ARM processors and ABIs, FFTW
237 does not attempt to guess the correct <code>gcc</code> flags for generating
238 NEON code. In general, you will have to provide them on the command line.
239 This command line is known to have worked at least once:
240 <div class="example">
241 <pre class="example">./configure --with-slow-timer --host=arm-linux-gnueabi \
242 --enable-single --enable-neon \
243 &quot;CC=arm-linux-gnueabi-gcc -march=armv7-a -mfloat-abi=softfp&quot;
244 </pre></div>
245 </li></ul>
246
247 </li></ul>
248
249 <a name="index-compiler-2"></a>
250 <p>To force <code>configure</code> to use a particular C compiler <i>foo</i>
251 (instead of the default, usually <code>gcc</code>), pass <code>CC=</code><i>foo</i> to the
252 <code>configure</code> script; you may also need to set the flags via the variable
253 <code>CFLAGS</code> as described above.
254 <a name="index-compiler-flags-1"></a>
255 </p>
256 <hr>
257 <div class="header">
258 <p>
259 Next: <a href="Installation-on-non_002dUnix-systems.html#Installation-on-non_002dUnix-systems" accesskey="n" rel="next">Installation on non-Unix systems</a>, Previous: <a href="Installation-and-Customization.html#Installation-and-Customization" accesskey="p" rel="prev">Installation and Customization</a>, Up: <a href="Installation-and-Customization.html#Installation-and-Customization" accesskey="u" rel="up">Installation and Customization</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
260 </div>
261
262
263
264 </body>
265 </html>