author Masayuki Nakano <>
Fri, 15 Jun 2012 18:52:50 +0900
changeset 99535 d3bed04319ab696f102d6ebe0399d5c7c55fdc3e
parent 98760 c27de97f078dc7c2276af6484b718b54730180d8
child 118793 e04eec5f7c6d6618c173af048bfb0327f07cf1d1
permissions -rw-r--r--
Bug 757688 part.6 Add numpad keys to printable key table and remove KeyboardLayout::IsNumpadKey() r=jimm

Building and installing jemalloc can be as simple as typing the following while
in the root directory of the source tree:

    make install

=== Advanced configuration =====================================================

The 'configure' script supports numerous options that allow control of which
functionality is enabled, where jemalloc is installed, etc.  Optionally, pass
any of the following arguments (not a definitive list) to 'configure':

    Print a definitive list of options.

    Set the base directory in which to install.  For example:

        ./configure --prefix=/usr/local

    will cause files to be installed into /usr/local/include, /usr/local/lib,
    and /usr/local/man.

    Embed one or more library paths, so that libjemalloc can find the libraries
    it is linked to.  This works only on ELF-based systems.

    Mangle public symbols specified in <map> which is a comma-separated list of
    name:mangled pairs.

    For example, to use ld's --wrap option as an alternative method for
    overriding libc's malloc implementation, specify something like:


    Note that mangling happens prior to application of the prefix specified by
    --with-jemalloc-prefix, and mangled symbols are then ignored when applying
    the prefix.

    Prefix all public APIs with <prefix>.  For example, if <prefix> is
    "prefix_", API changes like the following occur:

      malloc()         --> prefix_malloc()
      malloc_conf      --> prefix_malloc_conf
      /etc/malloc.conf --> /etc/prefix_malloc.conf

    This makes it possible to use jemalloc at the same time as the system
    allocator, or even to use multiple copies of jemalloc simultaneously.

    By default, the prefix is "", except on OS X, where it is "je_".  On OS X,
    jemalloc overlays the default malloc zone, but makes no attempt to actually
    replace the "malloc", "calloc", etc. symbols.

    Prefix all library-private APIs with <prefix>.  For shared libraries,
    symbol visibility mechanisms prevent these symbols from being exported, but
    for static libraries, naming collisions are a real possibility.  By
    default, the prefix is "" (empty string).

    Append <suffix> to the base name of all installed files, such that multiple
    versions of jemalloc can coexist in the same installation directory.  For
    example, becomes libjemalloc<suffix>.so.0.

    Enable code that silences non-useful compiler warnings.  This is helpful
    when trying to tell serious warnings from those due to compiler
    limitations, but it potentially incurs a performance penalty.

    Enable assertions and validation code.  This incurs a substantial
    performance hit, but is very useful during application development.

    Disable statistics gathering functionality.  See the "opt.stats_print"
    option documentation for usage details.

    Enable heap profiling and leak detection functionality.  See the ""
    option documentation for usage details.  When enabled, there are several
    approaches to backtracing, and the configure script chooses the first one
    in the following list that appears to function correctly:

    + libunwind      (requires --enable-prof-libunwind)
    + libgcc         (unless --disable-prof-libgcc)
    + gcc intrinsics (unless --disable-prof-gcc)

    Use the libunwind library ( for stack

    Disable the use of libgcc's backtracing functionality.

    Disable the use of gcc intrinsics for backtracing.

    Statically link against the specified libunwind.a rather than dynamically
    linking with -lunwind.

    Disable thread-specific caches for small objects.  Objects are cached and
    released in bulk, thus reducing the total number of mutex operations.  See
    the "opt.tcache" option for usage details.

    Enable huge realloc() via mremap(2).  mremap() is disabled by default
    because the flavor used is specific to Linux, which has a quirk in its
    virtual memory allocation algorithm that causes semi-permanent VM map holes
    under normal jemalloc operation.

    Disable virtual memory deallocation via munmap(2); instead keep track of
    the virtual memory for later use.  munmap() is disabled by default (i.e.
    --disable-munmap is implied) on Linux, which has a quirk in its virtual
    memory allocation algorithm that causes semi-permanent VM map holes under
    normal jemalloc operation.

    Enable support for page allocation/deallocation via sbrk(2), in addition to

    Disable support for junk/zero filling of memory, quarantine, and redzones.
    See the "opt.junk", "", "opt.quarantine", and "opt.redzone" option
    documentation for usage details.

    Disable support for Valgrind.

    Disable support for the experimental API (*allocm()).

    Enable utrace(2)-based allocation tracing.  This feature is not broadly
    portable (FreeBSD has it, but Linux and OS X do not).

    Enable support for optional immediate termination due to out-of-memory
    errors, as is commonly implemented by "xmalloc" wrapper function for malloc.
    See the "opt.xmalloc" option documentation for usage details.

    Enable code that wraps pthread_create() to detect when an application
    switches from single-threaded to multi-threaded mode, so that it can avoid
    mutex locking/unlocking operations while in single-threaded mode.  In
    practice, this feature usually has little impact on performance unless
    thread-specific caching is disabled.

    Disable thread-local storage (TLS), which allows for fast access to
    thread-local variables via the __thread keyword.  If TLS is available,
    jemalloc uses it for several purposes.

    Specify where to find DocBook XSL stylesheets when building the

The following environment variables (not a definitive list) impact configure's

    Pass these flags to the compiler.  You probably shouldn't define this unless
    you know what you are doing.  (Use EXTRA_CFLAGS instead.)

    Append these flags to CFLAGS.  This makes it possible to add flags such as
    -Werror, while allowing the configure script to determine what other flags
    are appropriate for the specified configuration.

    The configure script specifically checks whether an optimization flag (-O*)
    is specified in EXTRA_CFLAGS, and refrains from specifying an optimization
    level if it finds that one has already been specified.

    Pass these flags to the C preprocessor.  Note that CFLAGS is not passed to
    'cpp' when 'configure' is looking for include files, so you must use
    CPPFLAGS instead if you need to help 'configure' find header files.

    'ld' uses this colon-separated list to find libraries.

    Pass these flags when linking.

    'configure' uses this to find programs.

=== Advanced compilation =======================================================

To build only parts of jemalloc, use the following targets:


To install only parts of jemalloc, use the following targets:


To clean up build results to varying degrees, use the following make targets:


=== Advanced installation ======================================================

Optionally, define make variables when invoking make, including (not

    Use this as the installation prefix for header files.

    Use this as the installation prefix for libraries.

    Use this as the installation prefix for man pages.

    Prepend DESTDIR to INCLUDEDIR, LIBDIR, DATADIR, and MANDIR.  This is useful
    when installing to a different path than was specified via --prefix.

    Use this to invoke the C compiler.

    Pass these flags to the compiler.

    Pass these flags to the C preprocessor.

    Pass these flags when linking.

    Use this to search for programs used during configuration and building.

=== Development ================================================================

If you intend to make non-trivial changes to jemalloc, use the ''
script rather than 'configure'.  This re-generates 'configure', enables
configuration dependency rules, and enables re-generation of automatically
generated source files.

The build system supports using an object directory separate from the source
tree.  For example, you can create an 'obj' directory, and from within that
directory, issue configuration and build commands:

    mkdir obj
    cd obj
    ../configure --enable-autogen

=== Documentation ==============================================================

The manual page is generated in both html and roff formats.  Any web browser
can be used to view the html manual.  The roff manual page can be formatted
prior to installation via the following command:

    nroff -man -t doc/jemalloc.3