README.cygwin

   1 CYGWIN LTTNG-UST PORT INSTALLATION & USAGE INSTRUCTIONS
   2 -------------------------------------------------------
   3
   4 The Cygwin lttng-ust port is an *experimental* development branch based on
   5 the lttng-ust 2.0 stable version. This port is a *prototype* and should not be
   6 deployed in production.
   7
   8 The latest version of the development branch can be found at:
   9   * lttng-ust:   git://git.lttng.org/lttng-ust.git -b cygwin-2.0-experimental
  10
  11 PREREQUISITES
  12
  13 - Cygwin 1.7.x available here: http://cygwin.com/setup.exe
  14
  15 - lttng-ust dependencies (Cygwin packages available through setup.exe)
  16     * autoconf
  17     * automake
  18     * gcc4
  19     * libtool
  20     * libuuid-devel
  21     * libuuid1
  22
  23 INSTALLATION INSTRUCTIONS:
  24
  25 The Cygwin lttng-ust port should be installed by carefully following the
  26 outlined instructions below:
  27
  28 * lttng-ust
  29
  30   - Start a Cygwin shell.
  31
  32   - Download lttng-ust sources:
  33
  34     git clone git://git.lttng.org/lttng-ust.git -b cygwin-2.0-experimental
  35
  36   - Change directory and run the bootstrap script:
  37
  38     cd lttng-ust
  39     ./bootstrap
  40
  41   - Run the configure script with these parameters:
  42     LDFLAGS="-no-undefined" ./configure --prefix=/usr
  43
  44   - Run the make command and install lttng-ust
  45     make
  46     make install
  47
  48 INSTRUMENTATION:
  49
  50 Refer the to the lttng-ust(3) man page
  51 (Online version: http://lttng.org/files/doc/man-pages/man3/lttng-ust.3.html).
  52
  53 CYGWIN PORT LIMITATIONS:
  54
  55 - Since Cygwin doesn't support file descriptor passing over UNIX socket,
  56   the SHMs (shared memory) and wait pipes are exposed via the filesystem in
  57   /tmp/lttng-fds. This is a potential security issue.
  58
  59   For more information see commit bf5ff35ed0a3a7f60e92d654a5b97e73b94da852
  60   in lttng-ust.
  61
  62 - Applications need to be linked against liblttng-ust-tracepoint.
  63   LD_PRELOAD is not supported.
  64   See commit ecab630c1e78a4b720f448917e92d43ada48d06d in lttng-ust for
  65   more information.
  66
  67 - liblttng-ust-fork and liblttng-ust-libc-wrapper are not supported.
  68   See commit cbd7f39d9267e24159023db91712ca91558c5cc8 in lttng-ust for
  69   more information.