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 silc_file_readfile and silc_file_writefile should perhaps do the thing
  56    with mmap, as it's probably a bit faster.
  57
  58  o silc_malloc et. al. to respect --with-alignment.
  59
  60  o Fix universal time decoding (doesn't accept all formats) in silctime.c.
  61
  62  o Additional scheduler changes: optimize silc_schedule_wakeup.  Wakeup
  63    only if the scheduler is actually waiting something.  If it is
  64    delivering tasks wakeup is not needed.
  65
  66  o silc_stringprep to non-allocating version.
  67
  68  o Add builtin SOCKS and HTTP Proxy support, well the SOCKS at least.
  69    SILC currently supports SOCKS4 and SOCKS5 but it needs to be compiled
  70    in separately.
  71
  72  o Add directory opening/traversing functions (***DONE, TODO Windows & Symbian)
  73
  74  o regex from /lib/contrib to lib/silcutil, define SILC Regex API. (***DONE)
  75
  76  o Add functions to manipulate environment variables. (***DONE)
  77
  78  o Add functions to loading shared/dynamic object symbols (replaces the
  79    SIM library (lib/silcsim) and introduces generic library).  Add this
  80    to lib/silcutil/silcdll.[ch].  (***TESTING NEEDED WIN32, TODO Symbian)
  81
  82  o silc_getopt routines (***DONE)
  83
  84  o The SILC Event signals.  Asynchronous events that can be created,
  85    connected to and signalled.  Either own event routines or glued into
  86    SilcSchedule. (***DONE)
  87
  88  o If the event signals are added, the SILC_PARAM_* stuff needs to be
  89    moved from silcbuffmt.h to silctypes.h or something similar. (***DONE)
  90
  91  o In case the SILC Events are done we shall create a new concept of
  92    parent and child SilcSchedule's.  When new SilcSchedule is created a
  93    parent can be associated to it.  This association could be done either
  94    directly by the parent or by any other children.  This way the signals
  95    would in effect be global and would reach all children schedulers.
  96
  97    This relationship would be associative only.  The schedulers are still
  98    independent and run independently from each other.   All schedulers
  99    would be linked and could be accessed from any of the schedulers.
 100    It should be possible to retrieve the parent and enumerate all children
 101    from any of the schedulers.
 102    (***DONE)
 103
 104  o Base64 to an own API (***DONE)
 105
 106  o Timer API (***DONE)
 107
 108  o silc_hash_table_replace -> silc_hash_table_set.  Retain support for
 109    silc_hash_table_replace as macro. (***DONE)
 110
 111  o SilcStack aware SilcHashTable. (***DONE)
 112
 113  o SilcStack aware SilcDList. (***DONE)
 114
 115  o Thread pool API.  Add this to lib/silcutil/silcthread.[ch].  (***DONE)
 116
 117  o Add new functions to SilcStack API in lib/silcutil/silcstack.[ch].  Add
 118    silc_stack_[set|get]_alignment.  It defines the default alignment used
 119    when allocating memory from stack.  It can be used to specify special
 120    alignments too when needed (such as for hardware devices like crypto
 121    accelerators).  Move also the low level silc_stack_malloc and
 122    silc_stack_realloc from silcstack_i.h to silcstack.h.  Remove the
 123    _ua unaligned memory allocation routines.  Remove unaligned memory
 124    allocation possibility. (***DONE)
 125
 126  o silc_stack_alloc shouldn't require multiple by 8 size argument, it
 127    should figure it out itself. (***DONE)
 128
 129  o Add '%@' format to silc_snprintf functions.
 130    (***DONE)
 131
 132  o SILC Tls (Thread-local storage) API to lib/silcutil/silcthread.[ch].
 133    (***DONE)
 134
 135  o Change silc_gettimeofday on Unix to use clock_gettime with REALTIME
 136    clock if it is available, otherwise use gettimeofday(). (***DONE)
 137
 138  o Generic SilcResult that includes all possible status and
 139    error conditions and generic errno API. (***DONE)
 140
 141  (o Structured log messages to Log API.  Allows machine readable log
 142    messages.  Would allow sending of any kind of data in a log message.) maybe
 143
 144  (o Change some stream routines (like socket stream API) to accept ANY
 145    stream and use silc_stream_get_root to get the socket stream from the
 146    given stream.  This will make various stream APIs more easier to use
 147    when user doesn't have to dig up the correct stream.
 148
 149    Add silc_stream_get_root and add get_root stream operation.  It
 150    returns the root of the stream or NULL if stream doesn't have root.) maybe
 151
 152  (o Compression routines are missing.  The protocol supports packet
 153    compression thus it must be implemented.  SILC Zip API must be
 154    defined.) maybe
 155
 156  (o SilcIpAddr abstraction.  Ipv4 and Ipv6 support to the abstaction.)
 157   maybe
 158
 159  (o SILC specific socket creation/closing routines to silcnet.h, wrappers
 160   to all send(), recv(), sendto() etc.  Bad thing is that we'd have to
 161   define all socket options, sockaddrs, etc.) maybe
 162
 163  (o Fast mutex implementation.  Fast rwlock implementation.  Mutex and
 164    rwlock implementation using atomic operations.) not for now.
 165
 166
 167 lib/silcutil/symbian/
 168 =====================
 169
 170  o Something needs to be thought to the logging globals as well,
 171    like silc_debug etc.  They won't work on EPOC.  Perhaps logging
 172    and debugging is to be disabled on EPOC.  The logging currently works
 173    by it cannot be controlled, same with debugging.