04c62e16e0f32f5d7799a78d09834909cae2ab6c
[oweals/gnunet.git] / TODO
1 PHASE #1: (Goal: settle key design questions)
2
3
4 Util:
5 * improve disk API [Nils] (Nils, is this done? -Christian)
6 * Windows: use events instead of pipes to signal select()s [Nils]
7 * only connect() sockets that are ready (select()) [Nils]
8   [On W32, we need to select after calling socket before
9    doing connect etc.]
10
11 TESTCASES WANTED:
12 For these functions, it would be nice if we had testcases ("make check")
13 that would cause them to be executed and check that they are working:
14 * gnunet-service-peerinfo:
15   - change_host_trust / flush_trust 
16   - remove_garbage / 
17   - discard_hosts_helper / cron_clean_data_hosts
18 * gnunet-service-transport:
19   - try_unvalidated_addresses
20   - lookup_address_callback
21   - lookup_hello_callback
22   - plugin_env_lookup_address
23   - notify_clients_disconnect
24   - list_validated_addresses
25   - cleanup_validation
26   - disconnect_neighbour
27   - handle_set_quota
28 * plugin_transport_tcp.c:
29   - tcp_plugin_cancel
30   - tcp_plugin_address_pretty_printer / append_port
31   - tcp_plugin_set_receive_quota
32   - delayed_done
33 * transport_api:
34   - GNUNET_TRANSPORT_set_qutoa / send_set_quota
35   - hello_wait_timeout 
36   - transmit_ready
37   - transmit_timeout
38   - remove_from_any_list / remove_neighbour
39   - GNUNET_TRANSPORT_notify_transmit_ready_cancel
40 * core_api:
41   - timeout_request
42   - solicit_traffic / copy_and_free
43   - GNUNET_CORE_peer_configure / produce_configure_message
44 * gnunet-service-core:
45   - update_window
46   - find_client
47   - handle_client_request_configure
48   - set_key_retry_task
49   - align_and_deliver
50   - handle_transport_notify_disconnect
51 * hostlist (everything)
52 * topology (everything)
53
54
55
56 PHASE #2: (Goal: recover basic file-sharing functionality)
57
58 Datastores:
59 * implement sqlite-based sqstore/datastore service
60   + implement service (datastore + talks to plugin)
61   + implement library (talks to service)
62   + get testcases to pass
63 * implement sqlite-based dstore services
64   + design API
65   + implement library (talks to service)
66   + implement service (talks to plugin)
67   + implement sqlite plugin (talks to DB)
68
69 Applications:
70 * DHT, DV
71 * FS / fs-libs
72
73
74
75 PHASE #3: (Goal: ready for pre-release) [completion-goal: end of 2009]
76
77 * testing
78 * setup
79 * gtk, qt GUIs
80 * tbench
81 * tracekit
82 * vpn
83
84 Transports:
85 * UDP backend (need LIBRARY to support (de)fragmentation!)
86 * HTTP backend
87 * Testing:
88   + Testcases for set_quota, timeouts, disconnects, transmit_ready_cancel
89   + Better coverage of gnunet-service-transport (HELLO validation)
90   + direct test of plugins compliance to plugin API
91
92 Databases:
93 * sqlite, mysql & postgres backend
94
95
96
97 Minor TODO items:
98 * UTIL:
99   - crypto_hash: use libgcrypt (supports SHA-512 since 2003)
100   - container_bloomfilter: improve efficiency (see FIXME)
101 * SERVER:
102   - inefficient memmove
103 * TRANSPORT:
104   - transport_api: support forcing disconnects through low quotas!
105     (required for working F2F support!)
106   - API: consider having core provide deadline information for each message
107     (likely important for DV plugin which wants to loop back!)
108   - implement transport API to pretty-print transport address 
109     + transport_api extension (API extension!)
110     + service-transport extension (protocol extension)
111   - add calls to statistics in various places
112   - implement gnunet-transport (transport configurator / tester)
113   - UPnP-based IP detection
114     (Note: build library always, build service when libxml2/etc. are available)
115   - instantly filter addresses from *other* peers that 
116     are *equal* to our own address + port (i.e., localhost:2086).  We 
117     no longer filter those for outgoing (helps with loopback testing
118     and keeps the code clean), but we should filter strictly *impossible*
119     incoming addresses!  This is for efficiency, not correctness.
120   - We currently are happy to take any address told to us in a WELCOME
121     to our set of addresses; we should have some minimal threshold-based
122     scheme, limiting both the total number of addresses that we accept 
123     this way as well as requiring multiple confirmations; also, we
124     should possibly try to confirm that the given address works for
125     us ourselves (loopback-style) before adding it to the list
126     [SECURITY issue]
127     + we may be able to simplify WELCOME messages (no need to add 
128       addresses there anymore, but may help to learn them there anyway...).
129     + we probably want some kind of voting/counting for learning IP addresses
130       (maybe including IP addresses in ads proportional to how often others
131        report them? we at least need some protection against >64k HELLOs!),
132     + provide a way to give the user a list of "learned" IP addresses and
133       a way to easily "veto" addresses off the list!
134       => If MiM attacker uses vetoed address, blacklist the specific IP for
135          the presumed neighbour!
136   - not sure current way of doing ACKs works well-enough 
137     with unreliable transports where the ACK maybe lost;
138     the "is_new" check would then possibly prevent future
139     ACKs to be delivered, all while we're happily 
140     receiving messages from that peer!  Worse, the other
141     peer won't generate another ACK since it thinks we're
142     connected just fine...
143     Key questions:
144     + How necessary is ACKing in the first place? (alternatives?)
145     + Should we transmit ACKs in response to every HELLO? (would that 
146       fully address the problem?)
147   - latency measurements implemented in the transport
148     plugins makes it only work for bi-di transports
149     and results in code replication
150   - should latency be included in the ReceiveCallback and
151     NotifyConnect or passed on request?
152   - FIXME's with latency being simply set to 0 in a few places
153   - Memory leak (running valgrind --trace-children=yes on test_transport_api:   
154     ==28393== 16 bytes in 1 blocks are indirectly lost in loss record 1 of 5
155     ==28393==    at 0x4C2260E: malloc (vg_replace_malloc.c:207)
156     ==28393==    by 0x52343E3: GNUNET_xmalloc_unchecked_ (common_allocation.c:62)
157     ==28393==    by 0x5234389: GNUNET_xmalloc_ (common_allocation.c:53)
158     ==28393==    by 0x524458A: GNUNET_NETWORK_socket_create_from_accept (network.c:289)
159     ==28393==    by 0x524B2DA: ??? (server.c:332)
160     ==28393==    by 0x524A4C7: ??? (scheduler.c:425)
161     ==28393==    by 0x524A73D: GNUNET_SCHEDULER_run (scheduler.c:510)
162     ==28393==    by 0x524FF8C: GNUNET_SERVICE_run (service.c:1326)
163     ==28393==    by 0x405500: main (gnunet-service-transport.c:2645)
164     And also:
165     ==28393== 65,744 (65,728 direct, 16 indirect) bytes in 1 blocks are definitely lost in loss record 5 of 5
166     ==28393==    at 0x4C2260E: malloc (vg_replace_malloc.c:207)
167     ==28393==    by 0x52343E3: GNUNET_xmalloc_unchecked_ (common_allocation.c:62)
168     ==28393==    by 0x5234389: GNUNET_xmalloc_ (common_allocation.c:53)
169     ==28393==    by 0x524473E: GNUNET_NETWORK_socket_create_from_accept (network.c:323)
170     (rest of trace identical)
171
172 * SETUP:
173   - auto-generate "defaults.conf" using gnunet-setup from "config.scm"
174   - integrate all options into "config.scm"
175   - change config-file writing to exclude options set to default values
176 * ARM:
177   - implement exponential back-off for service restarts
178   - better tracking of which config changes actually need to cause process restarts by ARM.
179   - have way to specify dependencies between services (to manage ARM restarts better)
180   - client-API is inefficient since it opens a TCP connection per service that is started
181     (instead of re-using connections).
182 * CORE: 
183   - code currently notifies clients about "encrypted" connections being up well before
184     we get the encrypted PONG; sometimes this may be OK (for topology killing
185     unwanted connnections), but of course not in general.  I suspect we want
186     to signal on PONG and have topology hook directly into transport to
187     kill plaintext connections before they have a chance to become encrypted
188     (may require minor hack in transport API)
189 * PEERINFO:
190   - have gnunet-peerinfo print actual host addresses again
191   - add option to gnunet-peerinfo to modify trust value
192 * POSTGRES-DB:
193   - finish postgres implementation; simplify other SQLs using new stats
194 * HTTPS transport
195   - PolariSSL for MHD?
196   - https integration
197 * GAP improvements:
198   - active reply route caching design & implementation of service,
199     gap extension!
200 * HOSTLIST:
201   - implement advertising of hostlist URL
202   - implement learning of hostlist URLs
203
204
205
206 => PRE-RELEASE
207
208 PHASE #4: [completion-goal: mid 2010]
209 * Documentation
210 * new webpage
211
212
213
214
215 Stuff to remember:
216 * Features eliminated from util:
217   - threading (goal: good riddance!)
218   - complex logging features [ectx-passing, target-kinds] (goal: good riddance!)
219   - complex configuration features [defaults, notifications] (goal: good riddance!)
220   - network traffic monitors (goal: eliminate)
221   - IPC semaphores (goal: d-bus? / eliminate?)
222   - second timers
223   - DNS lookup (goal: have async service; issue: still need synchronous resolution in places, current code may not be portable)
224   => code shrunk from 61 files to 34, 22k LOC to 15k LOC, 470k to 330k (with symbols)
225 * New features in util:
226   - scheduler
227   - service and program boot-strap code
228 * Major changes in util:
229   - more expressive server (replaces selector)
230 * Open questions: 
231   - how to integrate scheduler with GTK event loop!
232
233
234
235 Test coverage:
236 * UTIL      : 78.7%
237 * HELLO     : 93.7%
238 * ARM       : 69.9%
239 * RESOLVER  : 60.4%
240 * STATISTICS: 82.8%
241 * PEERINFO  : 71.5%
242 * TRANSPORT : 70.9%
243 * CORE      : 65.8%
244 ===================
245 * TOTAL     : 74.9%
246
247 Not yet tested:
248 * HOSTLIST  :  0.0%
249 * TOPOLOGY  :  0.0%