summaryrefslogtreecommitdiffstats
path: root/INSTALL
diff options
context:
space:
mode:
authorJason Evans <jasone@canonware.com>2013-11-30 23:25:42 (GMT)
committerJason Evans <jasone@canonware.com>2013-12-04 06:06:59 (GMT)
commit86abd0dcd8e478759fe409d338d11558c4cec427 (patch)
tree90757d7b3f698e232a2950844f9491431e65b160 /INSTALL
parent66688535969c6dcb234448e590f27df38b4eebdf (diff)
downloadjemalloc-86abd0dcd8e478759fe409d338d11558c4cec427.zip
jemalloc-86abd0dcd8e478759fe409d338d11558c4cec427.tar.gz
jemalloc-86abd0dcd8e478759fe409d338d11558c4cec427.tar.bz2
Refactor to support more varied testing.
Refactor the test harness to support three types of tests: - unit: White box unit tests. These tests have full access to all internal jemalloc library symbols. Though in actuality all symbols are prefixed by jet_, macro-based name mangling abstracts this away from test code. - integration: Black box integration tests. These tests link with the installable shared jemalloc library, and with the exception of some utility code and configure-generated macro definitions, they have no access to jemalloc internals. - stress: Black box stress tests. These tests link with the installable shared jemalloc library, as well as with an internal allocator with symbols prefixed by jet_ (same as for unit tests) that can be used to allocate data structures that are internal to the test code. Move existing tests into test/{unit,integration}/ as appropriate. Split out internal parts of jemalloc_defs.h.in and put them in jemalloc_internal_defs.h.in. This reduces internals exposure to applications that #include <jemalloc/jemalloc.h>. Refactor jemalloc.h header generation so that a single header file results, and the prototypes can be used to generate jet_ prototypes for tests. Split jemalloc.h.in into multiple parts (jemalloc_defs.h.in, jemalloc_macros.h.in, jemalloc_protos.h.in, jemalloc_mangle.h.in) and use a shell script to generate a unified jemalloc.h at configure time. Change the default private namespace prefix from "" to "je_". Add missing private namespace mangling. Remove hard-coded private_namespace.h. Instead generate it and private_unnamespace.h from private_symbols.txt. Use similar logic for public symbols, which aids in name mangling for jet_ symbols. Add test_warn() and test_fail(). Replace existing exit(1) calls with test_fail() calls.
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL4
1 files changed, 2 insertions, 2 deletions
diff --git a/INSTALL b/INSTALL
index 6e371ce..39ad26d 100644
--- a/INSTALL
+++ b/INSTALL
@@ -61,10 +61,10 @@ any of the following arguments (not a definitive list) to 'configure':
allocator on OSX.
--with-private-namespace=<prefix>
- Prefix all library-private APIs with <prefix>. For shared libraries,
+ Prefix all library-private APIs with <prefix>je_. 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).
+ default, <prefix> is empty, which results in a symbol prefix of je_ .
--with-install-suffix=<suffix>
Append <suffix> to the base name of all installed files, such that multiple