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