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 Bring silchttp HTTP server library to SRT.  (***DONE)
  48
  49  o Simple SILC Rand API for pseudo-random numbers.  (***DONE)
  50
  51  o Add directory opening/traversing functions (***DONE, TODO Windows & Symbian)
  52
  53  o regex from /lib/contrib to lib/silcutil, define SILC Regex API. (***DONE)
  54
  55  o Add functions to manipulate environment variables. (***DONE)
  56
  57  o Add functions to loading shared/dynamic object symbols (replaces the
  58    SIM library (lib/silcsim) and introduces generic library).  Add this
  59    to lib/silcutil/silcdll.[ch].  (***TESTING NEEDED WIN32, TODO Symbian)
  60
  61  o silc_getopt routines (***DONE)
  62
  63  o The SILC Event signals.  Asynchronous events that can be created,
  64    connected to and signalled.  Either own event routines or glued into
  65    SilcSchedule. (***DONE)
  66
  67  o If the event signals are added, the SILC_PARAM_* stuff needs to be
  68    moved from silcbuffmt.h to silctypes.h or something similar. (***DONE)
  69
  70  o In case the SILC Events are done we shall create a new concept of
  71    parent and child SilcSchedule's.  When new SilcSchedule is created a
  72    parent can be associated to it.  This association could be done either
  73    directly by the parent or by any other children.  This way the signals
  74    would in effect be global and would reach all children schedulers.
  75
  76    This relationship would be associative only.  The schedulers are still
  77    independent and run independently from each other.   All schedulers
  78    would be linked and could be accessed from any of the schedulers.
  79    It should be possible to retrieve the parent and enumerate all children
  80    from any of the schedulers.
  81    (***DONE)
  82
  83  o Base64 to an own API (***DONE)
  84
  85  o Timer API (***DONE)
  86
  87  o silc_hash_table_replace -> silc_hash_table_set.  Retain support for
  88    silc_hash_table_replace as macro. (***DONE)
  89
  90  o SilcStack aware SilcHashTable. (***DONE)
  91
  92  o SilcStack aware SilcDList. (***DONE)
  93
  94  o Thread pool API.  Add this to lib/silcutil/silcthread.[ch].  (***DONE)
  95
  96  o Add new functions to SilcStack API in lib/silcutil/silcstack.[ch].  Add
  97    silc_stack_[set|get]_alignment.  It defines the default alignment used
  98    when allocating memory from stack.  It can be used to specify special
  99    alignments too when needed (such as for hardware devices like crypto
 100    accelerators).  Move also the low level silc_stack_malloc and
 101    silc_stack_realloc from silcstack_i.h to silcstack.h.  Remove the
 102    _ua unaligned memory allocation routines.  Remove unaligned memory
 103    allocation possibility. (***DONE)
 104
 105  o silc_stack_alloc shouldn't require multiple by 8 size argument, it
 106    should figure it out itself. (***DONE)
 107
 108  o Add '%@' format to silc_snprintf functions.
 109    (***DONE)
 110
 111  o SILC Tls (Thread-local storage) API to lib/silcutil/silcthread.[ch].
 112    (***DONE)
 113
 114  o Change silc_gettimeofday on Unix to use clock_gettime with REALTIME
 115    clock if it is available, otherwise use gettimeofday(). (***DONE)
 116
 117  o Generic SilcResult that includes all possible status and
 118    error conditions and generic errno API. (***DONE)
 119
 120  (o Structured log messages to Log API.  Allows machine readable log
 121    messages.  Would allow sending of any kind of data in a log message.) maybe
 122
 123  (o Change some stream routines (like socket stream API) to accept ANY
 124    stream and use silc_stream_get_root to get the socket stream from the
 125    given stream.  This will make various stream APIs more easier to use
 126    when user doesn't have to dig up the correct stream.
 127
 128    Add silc_stream_get_root and add get_root stream operation.  It
 129    returns the root of the stream or NULL if stream doesn't have root.) maybe
 130
 131  (o SilcIpAddr abstraction.  Ipv4 and Ipv6 support to the abstaction.)
 132   maybe
 133
 134  (o SILC specific socket creation/closing routines to silcnet.h, wrappers
 135   to all send(), recv(), sendto() etc.  Bad thing is that we'd have to
 136   define all socket options, sockaddrs, etc.) maybe
 137
 138  (o Fast mutex implementation.  Fast rwlock implementation.  Mutex and
 139    rwlock implementation using atomic operations.) not for now.
 140
 141
 142 SILC XML Library, lib/silcxml/
 143 ==============================
 144
 145  o SILC XML API (wrapper to expat).  Look at the expat API and simplify
 146    it.  The SILC XML API should have at most 8-10 API functions.  It should
 147    be possible to create full XML parser with only one function.  And, it
 148    should be possible to have a function that is able to parse an entire
 149    XML document.  It should also have a parser function to be able to
 150    parse a stream of XML data (SilcStream).  It MUST NOT have operations
 151    that require multiple function calls to be able to execute that one
 152    operation (like creating parser).
 153
 154
 155 Windows Support
 156 ===============
 157
 158
 159 Symbian OS Support
 160 ==================
 161
 162  o Something needs to be thought to the logging globals as well,
 163    like silc_debug etc.  They won't work on EPOC.  Perhaps logging
 164    and debugging is to be disabled on EPOC.  The logging currently works
 165    by it cannot be controlled, same with debugging.  SILC Global API
 166    MUST be used with all globals on Symbian.
 167
 168  o gethostname() returns "Function not implemented".  Others may return
 169    the same.  We should fix that probably to use RHostResolver and
 170    GetHostName().
 171
 172  o silc_thread_exit should call User::Exit().