TODO

   1 SILC Runtime Toolkit 1.2 and beyond
   2 ===================================
   3
   4 NOTE: Any item that doesn't have (***DONE) in it, isn't done yet.  The
   5 (***TESTING NEEDED) means that the item has been done but not yet properly
   6 tested.
   7
   8 NOTE: A TODO entry does not mean that it is ever going to be done.  Some
   9 of the entries may be just ideas, good, bad or ugly.  If you want to work
  10 on some of the TODO entries simply let us know about it by dropping a note
  11 to silc-devel mailing list or appear on 'silc' channel on SILCNet.
  12
  13
  14 Runtime library, lib/silcutil/
  15 ==============================
  16
  17  o Add SILC Zip API, compression.
  18
  19  o Unix socket support to Socket Stream API (local socket stream).
  20
  21  o file removing, chmod, rmmod, etc. chdir, rmdir, stat, etc. to
  22    lib/silcutil/silcfileutil.h.
  23
  24  o mmap API
  25
  26  o Multicast support.
  27
  28  o Implement silc_get_num_cpu.
  29
  30  o silc_file_readfile and silc_file_writefile should perhaps do the thing
  31    with mmap, as it's probably a bit faster.
  32
  33  o silc_malloc et. al. to respect --with-alignment.
  34
  35  o Fix universal time decoding (doesn't accept all formats) in silctime.c.
  36
  37  o Additional scheduler changes: optimize silc_schedule_wakeup.  Wakeup
  38    only if the scheduler is actually waiting something.  If it is
  39    delivering tasks wakeup is not needed.
  40
  41  o silc_stringprep to non-allocating version.
  42
  43  o Add builtin SOCKS and HTTP Proxy support, well the SOCKS at least.
  44    SILC currently supports SOCKS4 and SOCKS5 but it needs to be compiled
  45    in separately.
  46
  47  o Add silc_xml_parse_stream to parse SilcStream XML stream.
  48
  49  o SILC XML API (wrapper to expat). (***DONE)
  50
  51  o Bring silchttp HTTP server library to SRT.  (***DONE)
  52
  53  o Simple SILC Rand API for pseudo-random numbers.  (***DONE)
  54
  55  o Add directory opening/traversing functions (***DONE, TODO Windows & Symbian)
  56
  57  o regex from /lib/contrib to lib/silcutil, define SILC Regex API. (***DONE)
  58
  59  o Add functions to manipulate environment variables. (***DONE)
  60
  61  o Add functions to loading shared/dynamic object symbols (replaces the
  62    SIM library (lib/silcsim) and introduces generic library).  Add this
  63    to lib/silcutil/silcdll.[ch].  (***TESTING NEEDED WIN32, TODO Symbian)
  64
  65  o silc_getopt routines (***DONE)
  66
  67  o The SILC Event signals.  Asynchronous events that can be created,
  68    connected to and signalled.  Either own event routines or glued into
  69    SilcSchedule. (***DONE)
  70
  71  o If the event signals are added, the SILC_PARAM_* stuff needs to be
  72    moved from silcbuffmt.h to silctypes.h or something similar. (***DONE)
  73
  74  o In case the SILC Events are done we shall create a new concept of
  75    parent and child SilcSchedule's.  When new SilcSchedule is created a
  76    parent can be associated to it.  This association could be done either
  77    directly by the parent or by any other children.  This way the signals
  78    would in effect be global and would reach all children schedulers.
  79
  80    This relationship would be associative only.  The schedulers are still
  81    independent and run independently from each other.   All schedulers
  82    would be linked and could be accessed from any of the schedulers.
  83    It should be possible to retrieve the parent and enumerate all children
  84    from any of the schedulers.
  85    (***DONE)
  86
  87  o Base64 to an own API (***DONE)
  88
  89  o Timer API (***DONE)
  90
  91  o silc_hash_table_replace -> silc_hash_table_set.  Retain support for
  92    silc_hash_table_replace as macro. (***DONE)
  93
  94  o SilcStack aware SilcHashTable. (***DONE)
  95
  96  o SilcStack aware SilcDList. (***DONE)
  97
  98  o Thread pool API.  Add this to lib/silcutil/silcthread.[ch].  (***DONE)
  99
 100  o Add new functions to SilcStack API in lib/silcutil/silcstack.[ch].  Add
 101    silc_stack_[set|get]_alignment.  It defines the default alignment used
 102    when allocating memory from stack.  It can be used to specify special
 103    alignments too when needed (such as for hardware devices like crypto
 104    accelerators).  Move also the low level silc_stack_malloc and
 105    silc_stack_realloc from silcstack_i.h to silcstack.h.  Remove the
 106    _ua unaligned memory allocation routines.  Remove unaligned memory
 107    allocation possibility. (***DONE)
 108
 109  o silc_stack_alloc shouldn't require multiple by 8 size argument, it
 110    should figure it out itself. (***DONE)
 111
 112  o Add '%@' format to silc_snprintf functions.
 113    (***DONE)
 114
 115  o SILC Tls (Thread-local storage) API to lib/silcutil/silcthread.[ch].
 116    (***DONE)
 117
 118  o Change silc_gettimeofday on Unix to use clock_gettime with REALTIME
 119    clock if it is available, otherwise use gettimeofday(). (***DONE)
 120
 121  o Generic SilcResult that includes all possible status and
 122    error conditions and generic errno API. (***DONE)
 123
 124  (o Structured log messages to Log API.  Allows machine readable log
 125    messages.  Would allow sending of any kind of data in a log message.) maybe
 126
 127  (o Change some stream routines (like socket stream API) to accept ANY
 128    stream and use silc_stream_get_root to get the socket stream from the
 129    given stream.  This will make various stream APIs more easier to use
 130    when user doesn't have to dig up the correct stream.
 131
 132    Add silc_stream_get_root and add get_root stream operation.  It
 133    returns the root of the stream or NULL if stream doesn't have root.) maybe
 134
 135  (o SilcIpAddr abstraction.  Ipv4 and Ipv6 support to the abstaction.)
 136   maybe
 137
 138  (o SILC specific socket creation/closing routines to silcnet.h, wrappers
 139   to all send(), recv(), sendto() etc.  Bad thing is that we'd have to
 140   define all socket options, sockaddrs, etc.) maybe
 141
 142  (o Fast mutex implementation.  Fast rwlock implementation.  Mutex and
 143    rwlock implementation using atomic operations.) not for now.
 144
 145
 146 Windows Support
 147 ===============
 148
 149
 150 Symbian OS Support
 151 ==================
 152
 153  o Something needs to be thought to the logging globals as well,
 154    like silc_debug etc.  They won't work on EPOC.  Perhaps logging
 155    and debugging is to be disabled on EPOC.  The logging currently works
 156    by it cannot be controlled, same with debugging.  SILC Global API
 157    MUST be used with all globals on Symbian.
 158
 159  o gethostname() returns "Function not implemented".  Others may return
 160    the same.  We should fix that probably to use RHostResolver and
 161    GetHostName().
 162
 163  o silc_thread_exit should call User::Exit().