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 General
  15 =======
  16
  17  o Create apps/tutorial containing various Toolkit API tutorials.
  18
  19  o The Toolkit split.  The Toolkit is to be splitted in parts.  How many
  20    parts and what the parts are isn't decided yet.  Each part is a separate
  21    software package.  Current thinking is of the following:
  22
  23    SILC Toolkit                 SILC protocol, client and server library
  24    SILC Runtime Toolkit         runtime library
  25    SILC Crypto Toolkit          crypto, asn1, math, skr, pgp, etc.
  26
  27    The rationale for this is of course that other than SILC projects
  28    might like to use the various libraries SILC Toolkit provides, but
  29    naturally they don't want the bloat of SILC protocol related stuff.
  30
  31    The Runtime library in SILC Toolkit is a general purpose runtime library,
  32    like Glib and APR are.  The runtime library is to be developed further
  33    to provide alternative to Glib and APR.
  34
  35    The Crypto library in SILC Toolkit is a general purpose crypto library
  36    providing pretty nice APIs compared to many other crypto libraries,
  37    especially OpenSSL.  The Crypto library is to be developed further
  38    to include support for OpenPGP, X.509 and SSH2.
  39
  40
  41 Runtime library, lib/silcutil/
  42 ==============================
  43
  44  o Unix socket support to Socket Stream API (local socket stream).
  45
  46  o Simple SILC Rand API for pseudo-random numbers.  (***DONE)
  47
  48  o file removing, chmod, rmmod, etc. chdir, rmdir, stat, etc. to
  49    lib/silcutil/silcfileutil.h.
  50
  51  o mmap API
  52
  53  o Multicast support.
  54
  55  o Implement silc_get_num_cpu.
  56
  57  o silc_file_readfile and silc_file_writefile should perhaps do the thing
  58    with mmap, as it's probably a bit faster.
  59
  60  o silc_malloc et. al. to respect --with-alignment.
  61
  62  o Fix universal time decoding (doesn't accept all formats) in silctime.c.
  63
  64  o Additional scheduler changes: optimize silc_schedule_wakeup.  Wakeup
  65    only if the scheduler is actually waiting something.  If it is
  66    delivering tasks wakeup is not needed.
  67
  68  o silc_stringprep to non-allocating version.
  69
  70  o Add builtin SOCKS and HTTP Proxy support, well the SOCKS at least.
  71    SILC currently supports SOCKS4 and SOCKS5 but it needs to be compiled
  72    in separately.
  73
  74  o Add directory opening/traversing functions (***DONE, TODO Windows & Symbian)
  75
  76  o regex from /lib/contrib to lib/silcutil, define SILC Regex API. (***DONE)
  77
  78  o Add functions to manipulate environment variables. (***DONE)
  79
  80  o Add functions to loading shared/dynamic object symbols (replaces the
  81    SIM library (lib/silcsim) and introduces generic library).  Add this
  82    to lib/silcutil/silcdll.[ch].  (***TESTING NEEDED WIN32, TODO Symbian)
  83
  84  o silc_getopt routines (***DONE)
  85
  86  o The SILC Event signals.  Asynchronous events that can be created,
  87    connected to and signalled.  Either own event routines or glued into
  88    SilcSchedule. (***DONE)
  89
  90  o If the event signals are added, the SILC_PARAM_* stuff needs to be
  91    moved from silcbuffmt.h to silctypes.h or something similar. (***DONE)
  92
  93  o In case the SILC Events are done we shall create a new concept of
  94    parent and child SilcSchedule's.  When new SilcSchedule is created a
  95    parent can be associated to it.  This association could be done either
  96    directly by the parent or by any other children.  This way the signals
  97    would in effect be global and would reach all children schedulers.
  98
  99    This relationship would be associative only.  The schedulers are still
 100    independent and run independently from each other.   All schedulers
 101    would be linked and could be accessed from any of the schedulers.
 102    It should be possible to retrieve the parent and enumerate all children
 103    from any of the schedulers.
 104    (***DONE)
 105
 106  o Base64 to an own API (***DONE)
 107
 108  o Timer API (***DONE)
 109
 110  o silc_hash_table_replace -> silc_hash_table_set.  Retain support for
 111    silc_hash_table_replace as macro. (***DONE)
 112
 113  o SilcStack aware SilcHashTable. (***DONE)
 114
 115  o SilcStack aware SilcDList. (***DONE)
 116
 117  o Thread pool API.  Add this to lib/silcutil/silcthread.[ch].  (***DONE)
 118
 119  o Add new functions to SilcStack API in lib/silcutil/silcstack.[ch].  Add
 120    silc_stack_[set|get]_alignment.  It defines the default alignment used
 121    when allocating memory from stack.  It can be used to specify special
 122    alignments too when needed (such as for hardware devices like crypto
 123    accelerators).  Move also the low level silc_stack_malloc and
 124    silc_stack_realloc from silcstack_i.h to silcstack.h.  Remove the
 125    _ua unaligned memory allocation routines.  Remove unaligned memory
 126    allocation possibility. (***DONE)
 127
 128  o silc_stack_alloc shouldn't require multiple by 8 size argument, it
 129    should figure it out itself. (***DONE)
 130
 131  o Add '%@' format to silc_snprintf functions.
 132    (***DONE)
 133
 134  o SILC Tls (Thread-local storage) API to lib/silcutil/silcthread.[ch].
 135    (***DONE)
 136
 137  o Change silc_gettimeofday on Unix to use clock_gettime with REALTIME
 138    clock if it is available, otherwise use gettimeofday(). (***DONE)
 139
 140  o Generic SilcResult that includes all possible status and
 141    error conditions and generic errno API. (***DONE)
 142
 143  (o Structured log messages to Log API.  Allows machine readable log
 144    messages.  Would allow sending of any kind of data in a log message.) maybe
 145
 146  (o Change some stream routines (like socket stream API) to accept ANY
 147    stream and use silc_stream_get_root to get the socket stream from the
 148    given stream.  This will make various stream APIs more easier to use
 149    when user doesn't have to dig up the correct stream.
 150
 151    Add silc_stream_get_root and add get_root stream operation.  It
 152    returns the root of the stream or NULL if stream doesn't have root.) maybe
 153
 154  (o Compression routines are missing.  The protocol supports packet
 155    compression thus it must be implemented.  SILC Zip API must be
 156    defined.) maybe
 157
 158  (o SilcIpAddr abstraction.  Ipv4 and Ipv6 support to the abstaction.)
 159   maybe
 160
 161  (o SILC specific socket creation/closing routines to silcnet.h, wrappers
 162   to all send(), recv(), sendto() etc.  Bad thing is that we'd have to
 163   define all socket options, sockaddrs, etc.) maybe
 164
 165  (o Fast mutex implementation.  Fast rwlock implementation.  Mutex and
 166    rwlock implementation using atomic operations.) not for now.
 167
 168
 169 Windows Support
 170 ===============
 171
 172
 173 Symbian OS Support
 174 ==================
 175
 176  o Something needs to be thought to the logging globals as well,
 177    like silc_debug etc.  They won't work on EPOC.  Perhaps logging
 178    and debugging is to be disabled on EPOC.  The logging currently works
 179    by it cannot be controlled, same with debugging.  SILC Global API
 180    MUST be used with all globals on Symbian.
 181
 182  o gethostname() returns "Function not implemented".  Others may return
 183    the same.  We should fix that probably to use RHostResolver and
 184    GetHostName().
 185
 186  o silc_thread_exit should call User::Exit().