Debian Codegraph @

docs/installation/build_unix_conf.html

raw
1 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
4 <head>
5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
6 <title>Configuring Berkeley DB</title>
7 <link rel="stylesheet" href="gettingStarted.css" type="text/css" />
8 <meta name="generator" content="DocBook XSL Stylesheets V1.73.2" />
9 <link rel="start" href="index.html" title="Berkeley DB Installation and Build Guide" />
10 <link rel="up" href="build_unix.html" title="Chapter 7.  Building Berkeley DB for UNIX/POSIX" />
11 <link rel="prev" href="build_unix.html" title="Chapter 7.  Building Berkeley DB for UNIX/POSIX" />
12 <link rel="next" href="build_unix_sql.html" title="Configuring the SQL Interface" />
13 </head>
14 <body>
15 <div xmlns="" class="navheader">
16 <div class="libver">
17 <p>Library Version 11.2.5.3</p>
18 </div>
19 <table width="100%" summary="Navigation header">
20 <tr>
21 <th colspan="3" align="center">Configuring Berkeley DB</th>
22 </tr>
23 <tr>
24 <td width="20%" align="left"><a accesskey="p" href="build_unix.html">Prev</a> </td>
25 <th width="60%" align="center">Chapter 7. 
26 Building Berkeley DB for UNIX/POSIX
27 </th>
28 <td width="20%" align="right"> <a accesskey="n" href="build_unix_sql.html">Next</a></td>
29 </tr>
30 </table>
31 <hr />
32 </div>
33 <div class="sect1" lang="en" xml:lang="en">
34 <div class="titlepage">
35 <div>
36 <div>
37 <h2 class="title" style="clear: both"><a id="build_unix_conf"></a>Configuring Berkeley DB</h2>
38 </div>
39 </div>
40 </div>
41 <p>There are several arguments you can specify when configuring Berkeley DB.
42 Although only the Berkeley DB-specific ones are described here, most of the
43 standard GNU autoconf arguments are available and supported. To see a
44 complete list of possible arguments, specify the --help flag to the
45 configure program.</p>
46 <p>The Berkeley DB specific arguments are as follows:</p>
47 <div class="itemizedlist">
48 <ul type="disc">
49 <li>
50 <p><a id="build_unix_conf.--disable-largefile"></a>
51 <span class="bold"><strong>--disable-largefile</strong></span>
52 </p>
53 <p>
54 Some systems, notably versions of Solaris, require
55 special compile-time options in order to create files larger
56 than 2^32 bytes. These options are automatically enabled when
57 Berkeley DB is compiled. For this reason, binaries built on
58 current versions of these systems may not run on earlier
59 versions of the system because the library and system calls
60 necessary for large files are not available. To disable
61 building with these compile-time options, enter
62 --disable-largefile as an argument to configure.
63 </p>
64 </li>
65 <li>
66 <p>
67 <span class="bold"><strong>--disable-shared, --disable-static</strong></span>
68 </p>
69 <p>
70 On systems supporting shared libraries, Berkeley DB builds both
71 static and shared libraries by default. (Shared libraries are
72 built using
73 <a class="ulink" href="http://www.gnu.org/software/libtool/libtool.html" target="_top">
74 the GNU Project's Libtool</a> distribution, which supports
75 shared library builds on many (although not all) systems.) To
76 not build shared libraries, configure using the
77 --disable-shared argument. To not build static libraries,
78 configure using the --disable-static argument.
79 </p>
80 </li>
81 <li>
82 <p><a id="build_unix_conf.--disable-heap"></a>
83 <span class="bold"><strong>--disable-heap</strong></span>
84 </p>
85 <p>
86 Disables the Heap access method so that it cannot be used by
87 Berkeley DB applications.
88 </p>
89 </li>
90 <li>
91 <p>
92 <span class="bold"><strong>--enable-compat185</strong></span>
93 </p>
94 <p>
95 To compile or load Berkeley DB 1.85 applications against this
96 release of the Berkeley DB library, enter --enable-compat185 as
97 an argument to configure. This will include Berkeley DB 1.85
98 API compatibility code in the library.
99 </p>
100 </li>
101 <li>
102 <p>
103 <span class="bold"><strong>--enable-cxx</strong></span>
104 </p>
105 <p>
106 To build the Berkeley DB C++ API, enter --enable-cxx as an
107 argument to configure.
108 </p>
109 </li>
110 <li>
111 <p><a id="build_unix_conf.--enable-debug"></a>
112 <span class="bold"><strong>--enable-debug</strong></span>
113 </p>
114 <p>
115 To build Berkeley DB with <span class="bold"><strong>-g</strong></span>
116 as a compiler flag and with <span class="bold"><strong>DEBUG</strong></span> #defined during compilation,
117 enter --enable-debug as an argument to configure. This will
118 create a Berkeley DB library and utilities with debugging
119 symbols, as well as load various routines that can be called
120 from a debugger to display pages, cursor queues, and so forth.
121 If installed, the utilities will not be stripped. This
122 argument should not be specified when configuring to build
123 production binaries.
124 </p>
125 </li>
126 <li>
127 <p><a id="build_unix_conf.--enable-debug_rop"></a>
128 <span class="bold"><strong>--enable-debug_rop</strong></span>
129 </p>
130 <p>
131 To build Berkeley DB to output log records for read operations,
132 enter --enable-debug_rop as an argument to configure. This
133 argument should not be specified when configuring to build
134 production binaries.
135 </p>
136 </li>
137 <li>
138 <p><a id="build_unix_conf.--enable-debug_wop"></a>
139 <span class="bold"><strong>--enable-debug_wop</strong></span>
140 </p>
141 <p>
142 To build Berkeley DB to output log records for write
143 operations, enter --enable-debug_wop as an argument to
144 configure. This argument should not be specified when
145 configuring to build production binaries.
146 </p>
147 </li>
148 <li>
149 <p><a id="build_unix_conf.--enable-diagnostic"></a>
150 <span class="bold"><strong>--enable-diagnostic</strong></span>
151 </p>
152 <p>
153
154 To build Berkeley DB with run-time debugging checks, enter
155 --enable-diagnostic as an argument to configure. This causes a
156 number of additional checks to be performed when Berkeley DB is
157 running, and also causes some failures to trigger process abort
158 rather than returning errors to the application. Applications
159 built using this argument should not share database
160 environments with applications built without this argument.
161 This argument should not be specified when configuring to build
162 production binaries.
163 </p>
164 </li>
165 <li>
166 <p>
167 <span class="bold"><strong>--enable-dump185</strong></span>
168 </p>
169 <p>
170 To convert Berkeley DB 1.85 (or earlier) databases to this
171 release of Berkeley DB, enter --enable-dump185 as an argument
172 to configure. This will build the <a href="../api_reference/C/db_dump.html" class="olink">db_dump185</a> utility, which can dump
173 Berkeley DB 1.85 and 1.86 databases in a format readable by the
174 Berkeley DB <a href="../api_reference/C/db_load.html" class="olink">db_load</a> utility.
175 </p>
176 <p>
177 The system libraries with which you are loading the
178 <a href="../api_reference/C/db_dump.html" class="olink">db_dump185</a> utility must already contain the Berkeley DB 1.85 library
179 routines for this to work because the Berkeley DB distribution
180 does not include them. If you are using a non-standard library
181 for the Berkeley DB 1.85 library routines, you will have to
182 change the Makefile that the configuration step creates to load
183 the <a href="../api_reference/C/db_dump.html" class="olink">db_dump185</a> utility with that library.
184 </p>
185 </li>
186 <li>
187 <p><a id="build_unix_conf.--enable-java"></a>
188 <span class="bold"><strong>--enable-java</strong></span>
189 </p>
190 <p>
191 To build the Berkeley DB Java API, enter --enable-java as an
192 argument to configure. To build Java, you must also build with
193 shared libraries. Before configuring, you must set your PATH
194 environment variable to include javac. Note that it is not
195 sufficient to include a symbolic link to javac in your PATH
196 because the configuration process uses the location of javac to
197 determine the location of the Java include files (for example,
198 jni.h). On some systems, additional include directories may be
199 needed to process jni.h; see <a class="xref" href="build_unix_flags.html" title="Changing compile or load options">Changing compile or load options</a> for more information.
200 </p>
201 </li>
202 <li>
203 <p><a id="build_unix_conf.--enable-posixmutexes"></a>
204 <span class="bold"><strong>--enable-posixmutexes</strong></span>
205 </p>
206 <p>
207 To force Berkeley DB to use the POSIX pthread mutex interfaces
208 for underlying mutex support, enter --enable-posixmutexes as an
209 argument to configure. This is rarely necessary: POSIX mutexes
210 will be selected automatically on systems where they are the
211 preferred implementation.
212 </p>
213 <p>
214 The --enable-posixmutexes configuration argument is normally
215 used in two ways: First, when there are multiple mutex
216 implementations available and the POSIX mutex implementation is
217 not the preferred one (for example, on Solaris where the LWP
218 mutexes are used by default). Second, by default the Berkeley
219 DB library will only select the POSIX mutex implementation if
220 it supports mutexes shared between multiple processes, as
221 described for the pthread_condattr_setpshared and
222 pthread_mutexattr_setpshared interfaces. The
223 --enable-posixmutexes configuration argument can be used to
224 force the selection of POSIX mutexes in this case, which can
225 improve application performance significantly when the
226 alternative mutex implementation is a non-blocking one (for
227 example test-and-set assembly instructions). However,
228 configuring to use POSIX mutexes when the implementation does
229 not have inter-process support will only allow the creation of
230 private database environments, that is, environments where the
231 <a href="../api_reference/C/envopen.html#envopen_DB_PRIVATE" class="olink">DB_PRIVATE</a> flag is specified to the <a href="../api_reference/C/envopen.html" class="olink">DB_ENV-&gt;open()</a> method.
232 </p>
233 <p>
234 Specifying the --enable-posixmutexes configuration argument may require
235 that applications and Berkeley DB be linked with the -lpthread library.
236 </p>
237 </li>
238 <li>
239 <p><a id="build_unix_conf.--enable-pthread_api"></a>
240 <span class="bold"><strong>--enable-pthread_api</strong></span>
241 </p>
242 <p>
243 To configure Berkeley DB for a POSIX pthreads application (with
244 the exception that POSIX pthread mutexes may not be selected as
245 the underlying mutex implementation for the build), enter
246 --enable-pthread_api as an argument to configure. The build
247 will include the Berkeley DB replication manager interfaces and
248 will use the POSIX standard pthread_self and pthread_yield
249 functions to identify threads of control and yield the
250 processor. The --enable-pthread_api argument requires POSIX
251 pthread support already be installed on your system.
252 </p>
253 <p>
254 Specifying the --enable-pthread_api configuration argument may
255 require that applications and Berkeley DB be linked with the
256 -lpthread library.
257 </p>
258 </li>
259 <li>
260 <p><a id="build_unix_conf.--enable-sql"></a>
261 <span class="bold"><strong>--enable-sql</strong></span>
262 </p>
263 <p>
264 To build the command tool dbsql, enter --enable-sql as an argument to configure. The dbsql utility provides access to the Berkeley DB SQL interface. See
265 <a class="xref" href="build_unix_sql.html" title="Configuring the SQL Interface">Configuring the SQL Interface</a>
266 for more information.
267 </p>
268 </li>
269 <li>
270 <p>
271 <span class="bold"><strong>--enable-sql_compat</strong></span>
272 </p>
273 <p>
274 To build the command tool sqlite3, enter --enable-sql_compat as an argument to configure. Sqlite3 is a command line tool that enables you to manually enter and execute SQL
275 commands. It is identical to the dbsql executable but named so that existing scripts for SQLite can easily work with Berkeley DB. See
276 <a class="xref" href="build_unix_sql.html" title="Configuring the SQL Interface">Configuring the SQL Interface</a>
277 for more information.
278 </p>
279 </li>
280 <li>
281 <p>
282 <span class="bold"><strong>--enable-sql_codegen</strong></span>
283 </p>
284 <p>
285 To build the command line tool db_sql_codegen, enter --enable-sql_codegen as an argument to configure.
286 The db_sql_codegen utility translates a schema description written in a SQL Data Definition Language dialect into C code that implements the schema using Berkeley DB.
287 </p>
288 </li>
289 <li>
290 <p>
291 <span class="bold"><strong>--enable-smallbuild</strong></span>
292 </p>
293 <p>
294 To build a small memory footprint version of the Berkeley DB
295 library, enter --enable-smallbuild as an argument to configure.
296 The --enable-smallbuild argument is equivalent to individually
297 specifying --with-cryptography=no, --disable-hash,
298 --disable-queue, --disable-replication, --disable-statistics
299 and --disable-verify, turning off cryptography support, the
300 Hash and Queue access methods, database environment replication
301 support and database and log verification support. See
302 <a class="xref" href="build_unix_small.html" title="Building a small memory footprint library">Building a small memory footprint library</a>
303 for more information.
304 </p>
305 </li>
306 <li>
307 <p>
308 <span class="bold"><strong>--enable-stl</strong></span>
309 </p>
310 <p>
311 To build the Berkeley DB C++ STL API, enter --enable-stl as an
312 argument to configure. Setting this argument implies that --enable-cxx is set,
313 and the Berkeley DB C++ API will be built too.
314
315 </p>
316 <p>
317 There will be a libdb_stl-X.X.a and libdb_stl-X.X.so
318 built, which are the static and shared library you should link your application with in order to
319 make use of Berkeley DB via its STL API.
320
321 </p>
322 <p>
323 If your compiler is not ISO C++ compliant, the configure may fail with this argument
324 specified because the STL API requires standard C++ template features. In this case,
325 you will need a standard C++ compiler. So far gcc is the best choice, we have tested and found
326 that gcc-3.4.4 and all its newer versions can build the Berkeley DB C++ STL API successfully.
327 </p>
328 <p>For information on db_stl supported compilers, see the <a href="../programmer_reference/stl.html#stl_intro_portability" class="olink">Portability section</a> in the <span class="emphasis"><em>Programmer's Reference Guide</em></span>.</p>
329 <p>
330 And you need to include the STL API header files in your application code.
331 If you are using the Berkeley DB source tree, the header files are in &lt;Berkeley DB Source Root &gt;/stl directory;
332 If you
333 are using the installed version, these header files are in &lt; Berkeley DB Installed Directory&gt;/include, as well as the
334 db.h and db_cxx.h header files.
335 </p>
336 </li>
337 <li>
338 <p>
339 <span class="bold"><strong>--enable-tcl</strong></span>
340 </p>
341 <p>
342 To build the Berkeley DB Tcl API, enter --enable-tcl as an
343 argument to configure. This configuration argument expects to
344 find Tcl's tclConfig.sh file in the
345 <code class="filename">/usr/local/lib</code> directory. See the
346 --with-tcl argument for instructions on specifying a
347 non-standard location for the Tcl installation. See
348 <a href="../programmer_reference/tcl.html#tcl_intro" class="olink">Loading Berkeley DB with Tcl</a> for information on sites from which you can
349 download Tcl and which Tcl versions are compatible with
350 Berkeley DB. To build Tcl, you must also build with shared
351 libraries.
352 </p>
353 </li>
354 <li>
355 <p><a id="build_unix_conf.--enable-test"></a>
356 <span class="bold"><strong>--enable-test</strong></span>
357 </p>
358 <p>
359 To build the Berkeley DB test suite, enter --enable-test as an
360 argument to configure. To run the Berkeley DB test suite, you
361 must also build the Tcl API. This argument should not be
362 specified when configuring to build production binaries.
363 </p>
364 </li>
365 <li>
366 <p><a id="build_unix_conf.--enable-uimutexes"></a>
367 <span class="bold"><strong>--enable-uimutexes</strong></span>
368 </p>
369 <p>
370 To force Berkeley DB to use the UNIX International (UI) mutex
371 interfaces for underlying mutex support, enter
372 --enable-uimutexes as an argument to configure. This is rarely
373 necessary: UI mutexes will be selected automatically on systems
374 where they are the preferred implementation.
375 </p>
376 <p>
377 The --enable-uimutexes configuration argument is normally used
378 when there are multiple mutex implementations available and the
379 UI mutex implementation is not the preferred one (for example,
380 on Solaris where the LWP mutexes are used by default).
381 </p>
382 <p>
383 Specifying the --enable-uimutexes configuration argument may
384 require that applications and Berkeley DB be linked with the
385 -lthread library.
386 </p>
387 </li>
388 <li>
389 <p><a id="build_unix_conf.--enable-umrw"></a>
390 <span class="bold"><strong>--enable-umrw</strong></span>
391 </p>
392 <p>
393 Rational Software's Purify product and other run-time tools
394 complain about uninitialized reads/writes of structure fields
395 whose only purpose is padding, as well as when heap memory that
396 was never initialized is written to disk. Specify the
397 --enable-umrw argument during configuration to mask these
398 errors. This argument should not be specified when configuring
399 to build production binaries.
400 </p>
401 </li>
402 <li>
403 <p><a id="build_unix_conf.--enable-dtrace"></a>
404 <span class="bold"><strong>--enable-dtrace</strong></span>
405 [<span class="bold"><strong>--enable-perfmon-statistics</strong></span>]
406 </p>
407 <p>
408 To build Berkeley DB with performance event monitoring probes
409 add --enable-dtrace to the configuration options. Both native
410 DTrace (on Solaris and Mac OS X) and the
411 Statically Defined Tracing compatibility layer
412 in Linux SystemTap version 1.1 or better are supported.
413 That compatibility package may be called systemtap-sdt-devel;
414 it includes <code class="filename">sys/sdt.h</code>.
415 </p>
416 <p>
417 If --enable-perfmon-statistics is combined with --enable-dtrace
418 then additional probes are defined for the tracking variables
419 from which DB's statistics are obtained.
420 They allow DTrace and SystemTap access to these values when
421 they are updated, are the basis of the statistics
422 as displayed db_stat and the API functions that return statistics.
423 </p>
424 <p>
425 The --enable-dtrace option may not be specified at the same time
426 as --disable-statistics.
427 </p>
428 <p>
429 For information on Berkeley DB Performance Event Monitoring,
430 see the
431 <a href="../programmer_reference/program_perfmon.html" class="olink">Performance Event Monitoring</a>
432 section in the
433 <span class="emphasis"><em>Programmer's Reference Guide</em></span>.
434 </p>
435 </li>
436 <li>
437 <p><a id="build_unix_conf.--enable-localization"></a>
438 <span class="bold"><strong>--enable-localization</strong></span>
439 </p>
440 <p>
441 Enable localized error message text, if available.
442 This option should not be used when
443 <code class="literal">--enable-stripped_messages</code>
444 is in use.
445 </p>
446 </li>
447 <li>
448 <p><a id="build_unix_conf.--enable-stripped_messages"></a>
449 <span class="bold"><strong>--enable-stripped_messages</strong></span>
450 </p>
451 <p>
452 Causes all error messages to be stripped of their textual
453 information. Instead, only error return codes are used. This
454 option should not be used when
455 <code class="literal">--enable-localization</code>
456 is in use. Use of this build option can reduce your library
457 foot print by up to 44KB (.so) or 50KB (.a).
458 </p>
459 <p>
460 If you use this configuration option, you can get an idea of
461 what text should be issued for a given error message by using
462 the <a href="../articles/mssgtxt/index.html" class="olink">Message
463 Reference for Stripped Libraries</a> guide.
464 </p>
465 </li>
466 <li>
467 <p><a id="build_unix_conf.--with-cryptography"></a>
468 <span class="bold"><strong>--with-cryptography</strong></span>
469 </p>
470 <p>
471 To build Berkeley DB with support for cryptography, enter --with-cryptography=yes as an argument to configure.
472 </p>
473 <p>To build Berkeley DB without support for cryptography, enter --with-cryptography=no as an argument to configure.
474 </p>
475 <p>To build Berkeley DB with support for cryptography using Intel's Performance Primitive (IPP) library, enter --with-cryptography=ipp as an argument to configure. Additionally, set the following arguments:</p>
476 <p>-L/path/to/ipp/sharedlib to LDFLAGS</p>
477 <p>-I/path/to/ipp/include to CPPFLAGS</p>
478 <p>-lippcpem64t -lpthread to LIBS</p>
479 <p> An example configuration command for IPP encryption is as follows:</p>
480 <p></p>
481 <pre class="programlisting"> ../dist/configure -with-cryptography=ipp
482 CPPFLAGS="-I/opt/intel/ipp/6.1.3.055/em64t/include"
483 LDFLAGS="-L/opt/intel/ipp/6.1.3.055/em64t/sharedlib"
484 LIBS="-lippcpem64t -lpthread"</pre>
485 <p>See the<a class="ulink" href="http://software.intel.com/en-us/articles/intel-integrated-performance-primitives-documentation/" target="_top"> Intel Documenation</a> for specific instructions on configuring environment variables.</p>
486 <p>Note: The --with-cryptography=ipp argument works only on Linux.</p>
487 </li>
488 <li>
489 <p><a id="build_unix_conf.--with-mutex"></a>
490 <span class="bold"><strong>--with-mutex=MUTEX</strong></span>
491 </p>
492 <p>
493 To force Berkeley DB to use a specific mutex implementation,
494 configure with --with-mutex=MUTEX, where MUTEX is the mutex
495 implementation you want. For example,
496 --with-mutex=x86/gcc-assembly will configure Berkeley DB to use
497 the x86 GNU gcc compiler based test-and-set assembly mutexes.
498 This is rarely necessary and should be done only when the
499 default configuration selects the wrong mutex implementation.
500 A list of available mutex implementations can be found in the
501 distribution file <code class="filename">dist/aclocal/mutex.m4</code>.
502 </p>
503 </li>
504 <li>
505 <p>
506 <span class="bold"><strong>--with-tcl=DIR</strong></span>
507 </p>
508 <p>
509 To build the Berkeley DB Tcl API, enter --with-tcl=DIR,
510 replacing DIR with the directory in which the Tcl tclConfig.sh
511 file may be found. See <a href="../programmer_reference/tcl.html#tcl_intro" class="olink">Loading Berkeley DB with Tcl</a> for information on sites from
512 which you can download Tcl and which Tcl versions are
513 compatible with Berkeley DB. To build Tcl, you must also build
514 with shared libraries.
515 </p>
516 </li>
517 <li>
518 <p><a id="build_unix_conf.--with-uniquename=NAME"></a>
519 <span class="bold"><strong>--with-uniquename=NAME</strong></span>
520 </p>
521 <p>
522 To build Berkeley DB with unique symbol names (in order to
523 avoid conflicts with other application modules or libraries),
524 enter --with-uniquename=NAME, replacing NAME with a string that
525 to be appended to every Berkeley DB symbol. If "=NAME" is not
526 specified, a default value of "_MAJORMINOR" is used, where
527 MAJORMINOR is the major and minor release numbers of the
528 Berkeley DB release. See <a class="xref" href="install_multiple.html" title="Building with multiple versions of Berkeley DB">Building with multiple versions of Berkeley DB</a> for more information.
529 </p>
530 </li>
531 </ul>
532 </div>
533 </div>
534 <div class="navfooter">
535 <hr />
536 <table width="100%" summary="Navigation footer">
537 <tr>
538 <td width="40%" align="left"><a accesskey="p" href="build_unix.html">Prev</a> </td>
539 <td width="20%" align="center">
540 <a accesskey="u" href="build_unix.html">Up</a>
541 </td>
542 <td width="40%" align="right"> <a accesskey="n" href="build_unix_sql.html">Next</a></td>
543 </tr>
544 <tr>
545 <td width="40%" align="left" valign="top">Chapter 7. 
546 Building Berkeley DB for UNIX/POSIX
547  </td>
548 <td width="20%" align="center">
549 <a accesskey="h" href="index.html">Home</a>
550 </td>
551 <td width="40%" align="right" valign="top"> Configuring the SQL Interface</td>
552 </tr>
553 </table>
554 </div>
555 </body>
556 </html>