ucw/doc/relnotes.txt

   1 Release notes
   2 =============
   3
   4 6.0
   5 ---
   6
   7 * Libucw finally has a clean ABI, which does not pollute namespace, risking
   8   collisions with other libraries. However, we did not want to abandon our
   9   nicely and simply named functions, so the header files define macros,
  10   which translate names of all externally visible symbols to start with `ucw_`.
  11   If you don't like this, configure libucw with `CONFIG_UCW_CLEAN_ABI` turned off.
  12 * All helper utilities are now installed with names starting with `ucw-` to
  13   prevent collisions.
  14 * The auxiliary libraries have been renamed to `libucw-charset`, `libucw-images`,
  15   `libucw-xml`.
  16 * A <<opt:,parser of command-line options>> has been added, similar in spirit to
  17   our <<conf:,configuration file parser>>. The <<conf:getopt_h,getopt>> module
  18   has been obsoleted
  19 * `<stdbool.h>` is automatically included by `<ucw/lib.h>`.
  20 * *Incompatible:* It turned out that almost all users of the <<gary:,growing array>>
  21   module push/pop individual elements. Therefore, we have removed the second
  22   argument (item count) of `GARY_PUSH` and `GARY_POP`. If you want to push/pop
  23   multiple elements at once, use `GARY_PUSH_MULTI` and `GARY_POP_MULTI`.
  24 * *Incompatible:* The interface of the <<heap:,heap>> module was cleaned up
  25   to remove non-systematic side-effects. The `HEAP_INSERT` operation is now
  26   a proper insert (previously, it was just cleanup after insertion performed
  27   by the caller), similarly `HEAP_INCREASE` and `HEAP_DECREASE`. The `HEAP_DELMIN`
  28   operation was renamed to `HEAP_DELETE_MIN`. New operations `HEAP_REPLACE` and
  29   `HEAP_REPLACE_MIN` have been added. If you need to track positions of elements
  30   in the heap, please check the notes at individual functions.
  31 * <<alloc:,Generic allocators>> have been introduced, providing an abstract
  32   way of memory allocation. <<gary:,Growing arrays>> are now based on such
  33   allocators, which allows for example growing arrays in memory pools.
  34 * The <<conf:,configuration file parser>> has been improved:
  35 ** Multiple instances of the configuration parser are supported.
  36 ** *Incompatible:* As there may be more instances, we can no longer use
  37    global variables to control the configuration system. In particular,
  38    `cf_need_journal` and `cf_pool` variables have been replaced by
  39    functions <<conf:fun_cf_set_journalling,`cf_set_journalling()`>> and
  40    <<conf:fun_cf_get_pool,`cf_get_pool()`>>.
  41 ** *Incompatible:* Loading of configuration files has been decoupled from
  42    the getopt wrapper, so you might need to include `conf.h` for functions
  43    which were previously declared in `getopt.h`.
  44 ** New functions have been added:
  45    <<conf:fun_cf_open_group,`cf_open_group()`>>,
  46    <<conf:fun_cf_close_group,`cf_close_group()`>>, and
  47    <<conf:fun_cf_revert,`cf_revert()`>>.
  48 ** *Incompatible:* Dynamic configuration arrays have been re-implemented in
  49    terms of our generic <<gary:,growing arrays>>. This makes them easier to
  50    use and most of the interface has been preserved. The only exception is
  51    static allocation via the DARY_ALLOC() macro, which is no longer available.
  52 * <<daemon:,Daemon helpers>> have been added including a new `daemon-control`
  53   utility. The old `daemon-helper` utility has been obsoleted and it is not
  54   compiled by default.
  55 * <<signal:,Signal helpers>> for translation between signal names and numbers
  56   have been added.
  57 * The fastbuf I/O layer received a new back-end <<fastbuf:fbmulti,fb_multi>>,
  58   which concatenates several fastbuf streams to form a single virtual stream.
  59 * *Incompatible:* The `UCW::CGI` Perl module has its custom error handlers
  60   (which override default Perl error handlers) split off to a separate module
  61   `UCW::CGI::ErrorHandler`.
  62 * Added <<varint:,varint>> module for efficient UTF-8-like encoding of 64-bit
  63   integers to byte sequences.
  64
  65 5.0
  66 ---
  67
  68 * *Incompatible:* The `timestamp_t` type has been decoupled from wall clock time.
  69   It now specifies the number of milliseconds from an unspecified origin, so that
  70   it can for example refer to the system monotonic clock. The `ucw_time_t` type
  71   has been removed.
  72
  73 * The <<mainloop:,mainloop>> module has been rewritten:
  74 ** Multiple instances of the main loop are supported (to be used in different
  75    threads or locally within a library function).
  76 ** The new implementation is more efficient: it uses heaps for timers,
  77    epoll() for file descriptors (when available).
  78 ** The return value of <<mainloop:struct_main_file,`main_file`>> handlers has been
  79    changed to <<mainloop:enum_main_hook_return,`HOOK_IDLE`>> and <<mainloop:enum_main_hook_return,`HOOK_RETRY`>>.
  80    However, the numerical values are equal, so old code should keep working.
  81 ** *Incompatible:* The main loop time (`main_now`) has been decoupled from wall clock time
  82    and moved to a field in the `main_context` structure. It can be accessed either directly
  83    or via <<mainloop:fun_main_get_now,`main_get_now()`>>. The `main_now_seconds` variable has
  84    been removed, `main_idle_time` has become a structure field.
  85 ** *Incompatible:* The interface for asynchronous reading and writing
  86    (file_read() and friends) has been separated from the core of the main loop.
  87    Use <<mainloop:struct_main_block_io,`struct main_block_io`>> and related functions instead.
  88 ** *Incompatible:* file_close_all() is gone. You have to call <<mainloop:fun_main_teardown,`main_teardown()`>>
  89    or <<mainloop:fun_main_destroy,`main_destroy()`>> to clean up properly after fork().
  90 ** Added support for <<mainloop:signal,synchronous delivery of signals>>.
  91 ** Added relative timers: <<mainloop:fun_timer_add_rel,`timer_add_rel()`>>.
  92 ** Modification of events from a running event handler is always safe.
  93 ** Deleting an already deleted event is always safe.
  94 ** For any event type, it is possible to ask whether it is active (added to the mainloop) or not: <<mainloop:fun_hook_is_active,`hook_is_active()`>> and friends.
  95 ** A new mainloop front-end for asynchronous <<mainloop:recordio,record-based I/O>> has been added.
  96
  97 * Added support for <<trans:,resource pools and transactions>>, which is a general
  98   mechanism for tracking resources and reporting errors. It is still considered
  99   experimental, so the API can change in future releases.
 100
 101 * Added a <<gary:,growing array>> module `gary.h`, similar to `gbuf.h`, but with
 102   a much more convenient interface.
 103
 104 * The <<lists:,Circular linked lists>> can recognize unlinked nodes,
 105   see <<lists:fun_clist_unlink,`clist_unlink()`>>.
 106
 107 * Added `strtonum.h` -- a module for precise parsing of numbers.
 108
 109 * When compiled by a recent enough GCC, `__thread` is used for thread-local variables,
 110   which is more efficient than the POSIX per-thread storage.
 111 ** *Incompatible:* `ucwlib_context->thread_id` is no longer available directly,
 112   please use ucwlib_thread_id() instead.
 113
 114 * *Incompatible:* Several modules have been declared obsolete and removed:
 115 ** `sighandler` -- generic signal handling (it still exists internally)
 116 ** `qache` -- a mmap-based shared cache
 117 ** `prefetch` -- an interface to memory prefetch instructions; superseded by GCC `__builtin_prefetch`
 118 ** `randomkey` -- a generator of cryptographically strong pseudo-random tokens; will be replaced
 119    by something more generic soon
 120 ** `profile` -- a profiling hack
 121
 122 * *Incompatible:* Several modules now have their own header files:
 123 ** `process.h` -- all functions related to processes, previously declared in `lib.h`
 124 ** `io.h` -- functions related to files from `lib.h` and `lfs.h`
 125 ** `time.h` -- timestamps and interval timers, previously in `lib.h`
 126
 127 * *Incompatible:* Several configuration options were renamed or removed:
 128 ** `CONFIG_FAKE_ELTPOOL` &rarr; `CONFIG_UCW_FAKE_ELTPOOL`
 129 ** `CONFIG_LARGE_FILES` &rarr; `CONFIG_UCW_LARGE_FILES`
 130 ** `CONFIG_OWN_GETOPT` &rarr; `CONFIG_UCW_OWN_GETOPT`
 131 ** `CONFIG_DIRECT_IO` &rarr; `CONFIG_UCW_DIRECT_IO`
 132 ** `DEFAULT_CONFIG` &rarr; `CONFIG_UCW_DEFAULT_CONFIG`
 133 ** `ENV_VAR_CONFIG` &rarr; `CONFIG_UCW_ENV_VAR_CONFIG`
 134 ** `CONFIG_LFS` was removed
 135 ** `CONFIG_URL_ESCAPE_COMPAT` was removed
 136
 137 * `UCW::Configure` supports running of test programs.
 138
 139 * `UCW::CGI` support multiple argument tables and UTF-8 mode. Also, it uses the
 140   proper HTTP status codes when reporting errors.
 141
 142 * Implementation details of <<fastbuf:,fastbufs>> have changed. The new code checks
 143   invariants more carefully, so it is possible that custom fastbuf back-ends which
 144   are buggy now fail, although they previously seemed to work.
 145
 146
 147 4.0 (2009-04-13)
 148 ----------------
 149 This was the first stand-alone release of LibUCW. Before that, LibUCW was developed
 150 as a part of the http://www.ucw.cz/holmes/[Sherlock Holmes project].