third_party/android_crazy_linker/src/README.TXT

   1 Introduction:
   2 -------------
   3
   4 A custom dynamic linker for Android programs that adds a few interesting
   5 features compared to /system/bin/linker:
   6
   7   - Support changing the library search path. The system linker, when used
   8     inside Android applications, is limited to the value of LD_LIBRARY_PATH
   9     at boot time, that only looks into system directories, not application
  10     ones.
  11
  12     This linker allows the client to add application paths before the
  13     default system ones, this has two benefits:
  14
  15       - Library dependencies are loaded automatically in the right order.
  16
  17       - Libraries from the application paths are favored over system ones.
  18         This avoids conflicts when one of your application's libraries
  19         has the same name than a system one (which happens randomly
  20         on certain devices due to system application bundling).
  21
  22     (Note: The system linker issue above has been fixed in Android 4.3).
  23
  24   - Supports any number of shared libraries. On older Android platforms,
  25     the system linker will refuse to load more than 64 or 128 libraries
  26     in a single process (Note: Fixed in Android 4.3).
  27
  28   - Supports loading a library at an explicit (page-aligned) memory
  29     address. The system linker always randomizes the address. Note that
  30     this is generally a _bad_ idea for security reasons. Consider using
  31     this only when using shared RELROs (see below).
  32
  33   - Supports loading a library from an explicit (page-aligned) file
  34     offset. This can be useful to load a library directly from an .apk,
  35     provided that it is uncompressed and at a page-aligned offset.
  36
  37   - Support sharing of RELRO sections. When two processes load the same
  38     library at exactly the same address, the content of its RELRO section
  39     is identical. By default, each instance uses private RAM pages to host
  40     it, but it is possible to use a single ashmem region to share the same
  41     data instead.
  42
  43 See include/crazy_linker.h for the API and its documentation.
  44
  45 See LICENSE file for full licensing details (hint: BSD)
  46
  47 A few notes:
  48
  49   - Do not use this if you don't know what you're doing. Read the API
  50     documentation first, and look at the test programs for usage examples.
  51
  52   - The crazy linker will always use the system linker to load NDK-exposed
  53     system libraries (e.g. liblog.so and others). This avoids having two
  54     instances of the same library in the same process, and correctly
  55     resolving any symbols from system libraries.
  56
  57   - Any library loaded by the crazy linker, and which uses functions of
  58     libdl.so will continue to work. However, calls to dlopen(), dlsym(),
  59     et al will be redirected to the crazy linker's own wrappers.
  60
  61     This ensures that if a library is loaded by the crazy linker, any of
  62     its dependencies will be loaded by it too.
  63
  64   - Libraries loaded with the crazy linker are visible to GDB, or Breakpad,
  65     and stack unwinding / C++ exception propagation should just work.
  66
  67
  68 Caveats:
  69 --------
  70
  71   You can't call the crazy_linker code directly from Java in your Android
  72   application (it's a static library). You need to put it into your own
  73   shared library, loaded with System.loadLibrary() instead (or alternatively,
  74   inside your NativeActivity's shared library).
  75
  76   Also, libraries loaded with the crazy linker are not visible to the system
  77   one. In practice, it means that lazy native method lookup will not work. I.e.:
  78
  79   The first time you call a native method like:
  80
  81     'mypackage.MyClass.myNativeMethod()'
  82
  83   The VM will look into existing native libraries with dlsym() for a
  84   function symbol named like:
  85
  86     Java_mypackage_MyClass_myNativeMethod
  87
  88   This will not work if the symbol is inside a library loaded with the
  89   crazy_linker.
  90
  91   To work-around this, register the native methods explicitely
  92   in your JNI_OnLoad() by calling env->RegisterNatives() with the
  93   appropriate parameters.
  94
  95
  96 Usage instructions:
  97 -------------------
  98
  99   1/ Add the following to your module definition in your project's Android.mk:
 100
 101         LOCAL_STATIC_LIBRARIES := crazy_linker
 102
 103   2/ Also Include the top-level crazy_linker Android.mk, as in:
 104
 105         include /path/to/crazy_linker/Android.mk
 106
 107   3/ In your C or C++ source:
 108
 109         #include <crazy_linker.h>
 110
 111     Read the header for API documentation.
 112
 113   If your library implements native methods, it must explicitely register
 114   them with env->RegisterNatives() before they become usable.
 115
 116 BUGS & TODOs:
 117 -------------
 118
 119   - Libraries loaded by the crazy linker are not automatically closed when
 120     the process exits.
 121
 122   - dlopen() when called inside a library loaded by the crazy linker doesn't
 123     support RTLD_MAIN or RTLD_NEXT.
 124
 125 Testing:
 126 --------
 127
 128   If you modify this code, check your changes by running the test suite using:
 129
 130     cd $NDK
 131     tests/run-tests.sh crazy_linker
 132
 133   See DESIGN.TXT for an overview of the library's design.