ucw/doc/relnotes.txt

   1 Release notes
   2 =============
   3
   4 WIP
   5 ---
   6
   7 * The <<conf:,configuration file parser>> has been improved:
   8 ** Multiple instances of the configuration parser are supported.
   9 ** *Incompatible:* As there may be more instances, we can no longer use
  10    global variables to control the configuration system. In particular,
  11    `cf_need_journal` and `cf_pool` variables have been replaced by
  12    functions <<conf:fun_cf_set_journalling,`cf_set_journalling()`>> and
  13    <<conf:fun_cf_get_pool,`cf_get_pool()`>>.
  14 ** *Incompatible:* Loading of configuration files has been decoupled from
  15    the getopt wrapper, so you might need to include `conf.h` for functions
  16    which were previously declared in `getopt.h`.
  17 ** New functions have been added:
  18    <<conf:fun_cf_open_group,`cf_open_group()`>>,
  19    <<conf:fun_cf_close_group,`cf_close_group()`>>, and
  20    <<conf:fun_cf_revert,`cf_revert()`>>.
  21
  22 5.0
  23 ---
  24
  25 * *Incompatible:* The `timestamp_t` type has been decoupled from wall clock time.
  26   It now specifies the number of milliseconds from an unspecified origin, so that
  27   it can for example refer to the system monotonic clock. The `ucw_time_t` type
  28   has been removed.
  29
  30 * The <<mainloop:,mainloop>> module has been rewritten:
  31 ** Multiple instances of the main loop are supported (to be used in different
  32    threads or locally within a library function).
  33 ** The new implementation is more efficient: it uses heaps for timers,
  34    epoll() for file descriptors (when available).
  35 ** The return value of <<mainloop:struct_main_file,`main_file`>> handlers has been
  36    changed to <<mainloop:enum_main_hook_return,`HOOK_IDLE`>> and <<mainloop:enum_main_hook_return,`HOOK_RETRY`>>.
  37    However, the numerical values are equal, so old code should keep working.
  38 ** *Incompatible:* The main loop time (`main_now`) has been decoupled from wall clock time
  39    and moved to a field in the `main_context` structure. It can be accessed either directly
  40    or via <<mainloop:fun_main_get_now,`main_get_now()`>>. The `main_now_seconds` variable has
  41    been removed, `main_idle_time` has become a structure field.
  42 ** *Incompatible:* The interface for asynchronous reading and writing
  43    (file_read() and friends) has been separated from the core of the main loop.
  44    Use <<mainloop:struct_main_block_io,`struct main_block_io`>> and related functions instead.
  45 ** *Incompatible:* file_close_all() is gone. You have to call <<mainloop:fun_main_teardown,`main_teardown()`>>
  46    or <<mainloop:fun_main_destroy,`main_destroy()`>> to clean up properly after fork().
  47 ** Added support for <<mainloop:signal,synchronous delivery of signals>>.
  48 ** Added relative timers: <<mainloop:fun_timer_add_rel,`timer_add_rel()`>>.
  49 ** Modification of events from a running event handler is always safe.
  50 ** Deleting an already deleted event is always safe.
  51 ** 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.
  52 ** A new mainloop front-end for asynchronous <<mainloop:recordio,record-based I/O>> has been added.
  53
  54 * Added support for <<trans:,resource pools and transactions>>, which is a general
  55   mechanism for tracking resources and reporting errors. It is still considered
  56   experimental, so the API can change in future releases.
  57
  58 * Added a growing array module `gary.h`, similar to `gbuf.h`, but with
  59   a much more convenient interface.
  60
  61 * The <<lists:,Circular linked lists>> can recognize unlinked nodes,
  62   see <<lists:fun_clist_unlink,`clist_unlink()`>>.
  63
  64 * Added `strtonum.h` -- a module for precise parsing of numbers.
  65
  66 * When compiled by a recent enough GCC, `__thread` is used for thread-local variables,
  67   which is more efficient than the POSIX per-thread storage.
  68 ** *Incompatible:* `ucwlib_context->thread_id` is no longer available directly,
  69   please use ucwlib_thread_id() instead.
  70
  71 * *Incompatible:* Several modules have been declared obsolete and removed:
  72 ** `sighandler` -- generic signal handling (it still exists internally)
  73 ** `qache` -- a mmap-based shared cache
  74 ** `prefetch` -- an interface to memory prefetch instructions; superseded by GCC `__builtin_prefetch`
  75 ** `randomkey` -- a generator of cryptographically strong pseudo-random tokens; will be replaced
  76    by something more generic soon
  77 ** `profile` -- a profiling hack
  78
  79 * *Incompatible:* Several modules now have their own header files:
  80 ** `process.h` -- all functions related to processes, previously declared in `lib.h`
  81 ** `io.h` -- functions related to files from `lib.h` and `lfs.h`
  82 ** `time.h` -- timestamps and interval timers, previously in `lib.h`
  83
  84 * *Incompatible:* Several configuration options were renamed or removed:
  85 ** `CONFIG_FAKE_ELTPOOL` &rarr; `CONFIG_UCW_FAKE_ELTPOOL`
  86 ** `CONFIG_LARGE_FILES` &rarr; `CONFIG_UCW_LARGE_FILES`
  87 ** `CONFIG_OWN_GETOPT` &rarr; `CONFIG_UCW_OWN_GETOPT`
  88 ** `CONFIG_DIRECT_IO` &rarr; `CONFIG_UCW_DIRECT_IO`
  89 ** `DEFAULT_CONFIG` &rarr; `CONFIG_UCW_DEFAULT_CONFIG`
  90 ** `ENV_VAR_CONFIG` &rarr; `CONFIG_UCW_ENV_VAR_CONFIG`
  91 ** `CONFIG_LFS` was removed
  92 ** `CONFIG_URL_ESCAPE_COMPAT` was removed
  93
  94 * `UCW::Configure` supports running of test programs.
  95
  96 * `UCW::CGI` support multiple argument tables and UTF-8 mode. Also, it uses the
  97   proper HTTP status codes when reporting errors.
  98
  99 * Implementation details of <<fastbuf:,fastbufs>> have changed. The new code checks
 100   invariants more carefully, so it is possible that custom fastbuf back-ends which
 101   are buggy now fail, although they previously seemed to work.
 102
 103
 104 4.0 (2009-04-13)
 105 ----------------
 106 This was the first stand-alone release of LibUCW. Before that, LibUCW was developed
 107 as a part of the http://www.ucw.cz/holmes/[Sherlock Holmes project].