src/util/verto/README

   1 This directory builds a verto library with only a private built-in
   2 module, for use when the system has no installed verto library.  The
   3 bundled verto cannot dynamically load modules.  From the upstream
   4 libverto, we take only verto.c and verto-libev.c, and we only build
   5 the former; the latter is stored here for comparison purposes.  We use
   6 a stub implementation of module.c to disable dynamic loading support.
   7
   8 This private module uses an embedded libev with renamed symbols (so we
   9 don't leak libev symbols into the namespace on platforms where we
  10 can't control the export list).  libev has built-in support for this
  11 kind of embedding, so we don't have to modify the libev sources.
  12 Following libev's documentation, the following files have been copied
  13 from the ev sources:
  14
  15   ev.h
  16   ev_vars.h
  17   ev_wrap.h
  18   ev.c
  19   ev_select.c
  20   ev_poll.c
  21   ev_win32.c
  22   Symbols.ev
  23
  24 (Symbols.ev wasn't included in the 4.04 tar file due to an oversight,
  25 so it is taken from the appropriate tag in libev's source repository.)
  26
  27 To rename the exported symbols, we create rename.h from Symbols.ev.
  28 We also use Symbols.ev to construct the library export list.
  29 (Renaming libev's symbols would be unnecessary if libev's embedding
  30 had support for making its API symbols static, but it currently does
  31 not.)  The source file verto-k5ev.c wraps ev.c with appropriate
  32 embedding defines, and then defines the libverto module functions
  33 using the slightly modified contents of libverto's verto-libev.c.  The
  34 resulting module table is embedded into verto.c using the
  35 BUILTIN_MODULE define.
  36
  37 The libverto and libev upstream project pages are at:
  38
  39   https://fedorahosted.org/libverto/
  40   http://software.schmorp.de/pkg/libev.html