Expose endianness from Elf_X.
[dyninst.git] / README
1 READ THIS FIRST: how to build DyninstAPI and its subcomponents
2
3 1) Configuration
4
5 Dyninst is now built via CMake. We recommend performing an interactive
6 configuration with "ccmake ." first, in order to see which options are
7 relevant for your system. You may also perform a batch configuration
8 with "cmake .".  Options are passed to CMake with -DVAR=VALUE. Common
9 options include:
10
11 Boost_INCLUDE_DIR 
12 CMAKE_BUILD_TYPE 
13 CMAKE_INSTALL_PREFIX
14 LIBDWARF_INCLUDE_DIR 
15 LIBDWARF_LIBRARIES 
16 LIBELF_INCLUDE_DIR
17 LIBELF_LIBRARIES 
18 IBERTY_LIBRARIES
19
20 CMake's default generator on Linux is normally "Unix Makefiles", and
21 on Windows, it will normally produce project files for the most recent
22 version of Visual Studio on your system. Other generators should work
23 but are not tested. After the CMake step concludes, you will have
24 appropriate Makefiles or equivalent and can build Dyninst.
25
26 We require CMake 2.6 as a minimum on all systems, and CMake 2.8.11
27 allows us to automatically download and build libelf/libdwarf/binutils
28 on ELF systems if they are needed. If you do not have a sufficiently
29 recent CMake, you may need to manually specify the location of these
30 dependencies. If you are cross-compiling Dyninst, including builds for
31 various Cray and Intel MIC systems, you will either need a toolchain
32 file that specifies how to properly cross-compile, or you will need to
33 manually define the appropriate compiler, library locations, include
34 locations, and the CROSS_COMPILING flag so that the build system will
35 properly evaluate what can be built and linked in your environment.
36
37 2) Building and installation
38
39 To build Dyninst and all its components, "make && make install" from
40 the top-level directory of the source tree. To build and install a
41 single component and its dependencies, do the same thing from that
42 component's subdirectory. Libraries will be installed into
43 CMAKE_INSTALL_PREFIX/INSTALL_LIB_DIR, and headers will be installed
44 into CMAKE_INSTALL_PREFIX/INSTALL_INCLUDE_DIR. If you wish to import
45 Dyninst into your own CMake projects, the export information is in
46 CMAKE_INSTALL_PREFIX/INSTALL_CMAKE_DIR. PDF documentation is included
47 and installed to CMAKE_INSTALL_PREFIX/INSTALL_DOC_DIR. If you update
48 the LaTeX source documents for any manuals, "make doc" will rebuild
49 them. Components may be built and installed individually: "make
50 $COMPONENT" and "make $COMPONENT-install" respectively; this will
51 appropriately respect inter-component dependencies.
52
53 3) What's new
54
55 INTERFACE CHANGES:
56
57 * Shared objects and executables now both correspond to
58 BPatch_objects, and their constituent .o files correspond to
59 BPatch_modules.
60
61 NEW FEATURES:
62
63 * New code example: disassembler
64
65 * Boost should now auto-detect up to version 1.59
66
67 * Initial ARM64 implementation of InstructionAPI; SIMD instructions
68   are currently not supported
69
70 BUG FIXES
71
72 * Many x86 decoding bugs fixed (incorrect operand sizes, incorrect
73   prefix handling)
74
75 * Memory leaks fixed in line information parsing
76
77 * Slicing no longer attempts to follow edges to or from catch blocks
78
79 * Exception block parsing properly matches glibc internals
80
81 * Line information parsing should no longer erroneously fail to return
82 line information; also should no longer take quadratic time
83
84 * LD_PRELOAD again works
85
86 * Relocation and instrumentation no longer trigger unnecessary parsing
87   on Windows
88
89 * Windows no longer misidentifies calling conventions due to
90   use-after-free string corruption