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