datastore
[oweals/gnunet.git] / TODO
1 PHASE #1: (Goal: settle key design questions)
2
3 Util:
4 * improve disk API [Nils]
5 * Windows: use events instead of pipes to signal select()s [Nils]
6 * only connect() sockets that are ready (select())
7   [Nils: I'm not sure what you mean by this; fresh sockets are always
8    ready for connect(), just 'write' after connect needs select AFAIK;
9    please clarify. --Christian]
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   + implement sqlite plugin (talks to DB)
63   + fix testcases (make them use CPS, complete their inner workings...)
64 * implement sqlite-based dstore services
65   + design API
66   + implement library (talks to service)
67   + implement service (talks to plugin)
68   + implement sqlite plugin (talks to DB)
69
70 Applications:
71 * DHT, DV
72 * FS / fs-libs
73
74
75
76 PHASE #3: (Goal: ready for pre-release) [completion-goal: end of 2009]
77
78 * testing
79 * setup
80 * gtk, qt GUIs
81 * tbench
82 * tracekit
83 * vpn
84
85 Transports:
86 * UDP backend (need LIBRARY to support (de)fragmentation!)
87 * HTTP backend
88 * Testing:
89   +  Testcases for set_quota, timeouts, disconnects, transmit_ready_cancel
90   + Better coverage of gnunet-service-transport (hello validation)
91   + direct test of plugins compliance to plugin API
92
93 Databases:
94 * sqlite, mysql & postgres backend
95
96
97
98 Minor TODO items:
99 * UTIL:
100   - crypto_hash: use libgcrypt (supports SHA-512 since 2003)
101   - container_bloomfilter: improve efficiency (see FIXME)
102 * SERVER:
103   - inefficient memmove
104 * TRANSPORT:
105   - transport_api: support forcing disconnects through low quotas!
106     (required for working F2F support!)
107   - API: consider having core provide deadline information for each message
108     (likely important for DV plugin which wants to loop back!)
109   - implement transport API to pretty-print transport address 
110     + transport_api extension (API extension!)
111     + service-transport extension (protocol extension)
112   - add calls to statistics in various places
113   - implement gnunet-transport (transport configurator / tester)
114   - UPnP-based IP detection
115     (Note: build library always, build service when libxml2/etc. are available)
116   - instantly filter addresses from *other* peers that 
117     are *equal* to our own address + port (i.e., localhost:2086).  We 
118     no longer filter those for outgoing (helps with loopback testing
119     and keeps the code clean), but we should filter strictly *impossible*
120     incoming addresses!  This is for efficiency, not correctness.
121   - We currently are happy to take any address told to us in a WELCOME
122     to our set of addresses; we should have some minimal threshold-based
123     scheme, limiting both the total number of addresses that we accept 
124     this way as well as requiring multiple confirmations; also, we
125     should possibly try to confirm that the given address works for
126     us ourselves (loopback-style) before adding it to the list
127     [SECURITY issue]
128   - not sure current way of doing ACKs works well-enough 
129     with unreliable transports where the ACK maybe lost;
130     the "is_new" check would then possibly prevent future
131     ACKs to be delivered, all while we're happily 
132     receiving messages from that peer!  Worse, the other
133     peer won't generate another ACK since it thinks we're
134     connected just fine...
135     Key questions:
136     + How necessary is ACKing in the first place? (alternatives?)
137     + Should we transmit ACKs in response to every HELLO? (would that 
138       fully address the problem?)
139   - latency measurements implemented in the transport
140     plugins makes it only work for bi-di transports
141     and results in code replication
142   - should latency be included in the ReceiveCallback and
143     NotifyConnect or passed on request?
144 * SETUP:
145   - auto-generate "defaults.conf" using gnunet-setup from "config.scm"
146   - integrate all options into "config.scm"
147   - change config-file writing to exclude options set to default values
148 * ARM:
149   - implement exponential back-off for service restarts
150   - better tracking of which config changes actually need to cause process restarts by ARM.
151   - have way to specify dependencies between services (to manage ARM restarts better)
152   - client-API is inefficient since it opens a TCP connection per service that is started
153     (instead of re-using connections).
154 * PEERINFO:
155   - have gnunet-peerinfo print actual host addresses again
156   - add option to gnunet-peerinfo to modify trust value
157 * POSTGRES-DB:
158   - finish postgres implementation; simplify other SQLs using new stats
159 * HTTPS transport
160   - PolariSSL for MHD?
161   - https integration
162 * GAP improvements:
163   - active reply route caching design & implementation of service,
164     gap extension!
165 * HOSTLIST:
166   - implement advertising of hostlist URL
167   - implement learning of hostlist URLs
168
169
170
171 => PRE-RELEASE
172
173 PHASE #4: [completion-goal: mid 2010]
174 * Documentation
175 * new webpage
176
177
178
179
180 Stuff to remember:
181 * Features eliminated from util:
182   - threading (goal: good riddance!)
183   - complex logging features [ectx-passing, target-kinds] (goal: good riddance!)
184   - complex configuration features [defaults, notifications] (goal: good riddance!)
185   - network traffic monitors (goal: eliminate)
186   - IPC semaphores (goal: d-bus? / eliminate?)
187   - second timers
188   - DNS lookup (goal: have async service; issue: still need synchronous resolution in places, current code may not be portable)
189   => code shrunk from 61 files to 34, 22k LOC to 15k LOC, 470k to 330k (with symbols)
190 * New features in util:
191   - scheduler
192   - service and program boot-strap code
193 * Major changes in util:
194   - more expressive server (replaces selector)
195 * Open questions: 
196   - how to integrate scheduler with GTK event loop!
197
198
199
200 Test coverage:
201 * UTIL      : 78.7%
202 * HELLO     : 93.7%
203 * ARM       : 69.9%
204 * RESOLVER  : 60.4%
205 * STATISTICS: 82.8%
206 * PEERINFO  : 71.5%
207 * TRANSPORT : 70.9%
208 * CORE      : 65.8%
209 ===================
210 * TOTAL     : 74.9%
211
212 Not yet tested:
213 * HOSTLIST  :  0.0%
214 * TOPOLOGY  :  0.0%