37621af31000c46a9faf2b70a35821751c1362f3
[oweals/gnunet.git] / TODO
1 Implementable right now (but not necessarily important), with caveats
2 (unavailable components that will limit what can be implemented right
3 away), in order in which they will likely be done:
4 * TESTING-TESTBED [Nate]
5 * SETUP
6 * DV [Nate]
7 * TBENCH
8 * TRACEKIT
9 * FRAGMENTATION [Ji Lu]
10 * HTTP transport
11 * MySQL / Postgres plugins (datastore, datacache)
12 * UPNP [Milan]
13 * ARM [Safey]
14 * FS [Christian]
15
16 0.9.0pre0:
17 * CORE:
18   - SET_KEY is triggered every 2.5 minutes (after session is up); should
19     just do PING (not SET_KEY + PING)
20   - "Forcing disconnect of XXX due to inactivity" -- can happen every few MS!?
21     (disconnect does not really succeed, or what?)
22     Also, core does not seem to actually decrement the number of active
23     sessions even if no connections exist for a while! (likely related...)
24   - transport reports bw quota violations on big-endian systems (core or
25     transport issue?)
26 * DATASTORE:
27   - utilization can (easily, restart?) go out of control (very large), causing
28     content expiration job to go crazy and delete everything!
29 * FS:
30   - gnunet-publish cannot be aborted using CTRL-C
31   - on some systems, keyword search does not find locally published content
32     (need testcase of command-line tools! - also good to cover getopt API!)
33     [could be related to datastore issue above!]
34   - 2-peer download is still too slow (why?)
35   - advanced FS API parts
36     + search: SBlocks, NBlocks, probes, notify FS-service of known results
37     + indexing: index-failure-cleanup
38     + gnunet-publish (URI args)
39     + gnunet-download (directory)
40     + gnunet-search (options, incl. namespace search)
41     + gnunet-download (many options)
42     + gnunet-directory (man page, options)
43     + gnunet-pseudonym (all of it)
44     + gnunet-service-fs (remove failing on-demand blocks, hot-path routing, 
45       load-based routing, nitpicks)
46   - implement adv. FS testcases 
47   - [./fs/gnunet-service-fs.c:208]: (style) struct or union member 'LocalGetContext::results_bf_size' is never used
48   - [./fs/gnunet-service-fs.c:501]: (style) struct or union member 'PendingRequest::used_pids_size' is never used
49   - [./fs/gnunet-service-fs.c:654]: (style) struct or union member 'ConnectedPeer::last_client_replies' is never used
50   - [./fs/gnunet-service-fs.c:669]: (style) struct or union member 'ConnectedPeer::avg_delay' is never used
51   - [./fs/gnunet-service-fs.c:675]: (style) struct or union member 'ConnectedPeer::avg_priority' is never used
52   - [./fs/gnunet-service-fs.c:688]: (style) struct or union member 'ConnectedPeer::pending_requests' is never used
53   - [./fs/gnunet-service-fs.c:694]: (style) struct or union member 'ConnectedPeer::last_p2p_replies_woff' is never used
54   - [./fs/gnunet-service-fs.c:700]: (style) struct or union member 'ConnectedPeer::last_client_replies_woff' is never used
55 * WWW:
56   - Get IPv6 hooked up
57   - change DNS
58
59 0.9.0pre1:
60 * Module features to implement:
61   - tbench (RC-pre1)
62     + good to have for DV evaluation! [MW]
63   - DV (RC-pre1)
64     + write DV API 
65     + implement DV service [Nate & CG]
66     + implement DV library [Nate]
67     + implement DV transport plugin [Nate & CG]
68     + implement testcases [Nate]
69     + implement performance tests [Nate]
70 * SETUP:
71   - design & implement new setup tool
72 * GUIs to implement:
73   - gtk (RC-pre1)
74     + how to integrate scheduler with GTK event loop!
75 * STATISTICS:
76   - does not seem to work with timeouts (especially if service is not running)
77 * PEERINFO:
78   - trust: need *fast* way to check/update trust in peers
79            (async peerinfo would not be right; certainly not with the
80             current API)
81 * UTIL:
82   - scheduler should change OS process priority based on task priority;   
83     should make better use of task priorities in general
84   - only connect() sockets that are ready (select()) [Nils]
85     [On W32, we need to select after calling socket before
86      doing connect etc.]
87 * FS:
88   - datastore reservation (publishing)
89   - persistence support (publish, unindex, search, download)
90   - download: management/bounding of parallel downloads (for recursive dl.)
91   - non-anonymous FS service (needs DHT)
92     + basic DHT integration
93     + CS-DHT-functions (DHT-put of LOC)
94     + P2P-functions (DHT-get)
95   - active migration support (in fs or in datastore or new daemon?)
96   - GAP improvements:
97     + active reply route caching design & implementation of service; gap extension!
98 * TOPOLOGY:
99   - needs more testing (especially F2F topology)
100   - needs to re-try connecting after disconnect (currently, it
101     initially triggers a connection request, but if that connection
102     fails / goes down, it does not retry in a timely fashion;
103     cause seems to be the 'blacklist_after_attempt' being set to 1h,
104     which is rather long -- and should probably be adjusted based on
105     the number of connections / known peers)
106   - If the topology daemon crashes, peers that were put on the
107     blacklist with transport will never be removed from it (until
108     transport service dies); we should use the blacklist notification
109     API to learn about the exact set of blacklisted peers at all times
110     (FIXME: the transport_api implementation of blacklisting
111      also does not work nicely for this since it won't let us know about
112      disconnect-reconnect events and the implicit whitelisting
113      that might happen here; that's not so bad since we will
114      re-blacklist on pre-connect attempts anyway, so this is 
115      a minor issue).
116   - the code uses the term 'blacklist' for both peers that are forbidden
117     to connect (i.e. F2F mode) as well as peers that we currently
118     won't try to actively connect to ourselves (since we just tried);
119     This is confusing.  We need two distinct terms.
120   - move code to use hash table instead of linked list
121   - instead of periodically discarding blacklisted entries,
122     simply add task that is triggered at the right time (earlier free,
123     more balanced load)
124   - check if new HELLO learned is different from old HELLO
125     before resetting entire state!
126 * HELLO:
127   - need function to test "equivalency" of HELLOs (or integrate with "merge"?); use in PEERINFO
128
129 0.9.0pre2:
130 * Module features to implement:
131   - tracekit (RC-pre2)
132     + good to have for DV/DHT evaluation!
133   - DHT (RC-pre2)
134     + implement DHT service (needs DV, DATACACHE)
135     + implement DHT library
136     + implement testcases
137     + implement performance tests
138 * GUIs to implement:
139   - fuse (RC-pre2)
140 * Plugins to implement:
141   - UDP backend (RC-pre2)
142     + Fragmentation library 
143     + actual plugin
144   - HTTP backend (RC-pre2)
145 * ARM:
146   - need to get rid of synchronous API for service starts (cause all kinds of problems)
147     [=> eliminate for need to tell ARM about service starts most of the time!] [Safey]
148   - better tracking of which config changes actually need to cause process restarts by ARM.
149   - listen for requests to discover dependencies between services (and avoid
150     having to explicitly program start requests)
151   - better crash management (attach debugging support, capture and analyze
152     debug output, detect random vs. deterministic crashes)
153   - shutdown sequence?
154 * FS:
155   - location URIs (publish, search, download)
156   - collection API & tests
157   - implement FS performance tests
158     + insert
159     + download
160     + search
161     + unindex
162
163
164 0.9.0pre3:
165 * GUIs to implement:
166   - qt (RC-pre3)
167     + see discussions @ FISL about integration with event loop!
168 * Determine RC bugs and fix those!
169 * TESTING:
170   - modify configuration to allow controlling connections for non-local starts
171   - testbed creation with topology (needs working F2F topology) [Nate]
172   - testbed with churn [Nate]
173   - implement testcases for distributed testing [Nate]
174   - test basic peer re-configure [Nate]
175   - test topology creation [Nate]
176   - test churn generation [Nate]
177   - consider changing API for peer-group termination to 
178     call continuation when done
179
180
181 0.9.0:
182 * Documentation
183   - update man pages
184   - update webpage documentation
185 * new webpage:
186   - expand bibliography
187   - convert documentation pages to books
188   - update books (especially for developers)
189   - create good Drupal theme for GNUnet
190   - make a NICE download page and figure out how to 
191     enable developers to publish TGZs nicely
192   - port "contact" page
193   - add content type for "todo" items?
194   - DNS activation
195 * Plugins to implement:
196   - MySQL database backends
197     + datacache
198     + datastore
199   - Postgres database backends
200     + datacache
201     + datastore
202   - vpn
203 * Determine RC bugs and fix those!
204
205
206 0.9.x:
207 * TRANSPORT:
208   - SMTP transport backend
209   - HTTPS transport backend
210     + improved HTTPS support in MHD
211     + actual plugin
212   - Implement method of learning our external addresses from
213     other peers; need some kind of threshold-based
214     scheme, limiting both the total number of addresses that we accept 
215     this way as well as requiring multiple confirmations; also, we
216     should possibly try to confirm that the given address works for
217     us ourselves (loopback-style) before adding it to the list
218     + we may be able to simplify WELCOME messages (no need to add 
219       addresses there anymore, but may help to learn them there anyway...).
220     + we probably want some kind of voting/counting for learning IP addresses
221       (maybe including IP addresses in ads proportional to how often others
222        report them? we at least need some protection against >64k HELLOs!),
223     + provide a way to give the user a list of "learned" IP addresses and
224       a way to easily "veto" addresses off the list!
225       => If MiM attacker uses vetoed address, blacklist the specific IP for
226          the presumed neighbour!
227   - implement gnunet-transport (transport configurator / tester)
228   - UPnP-based IP detection
229     (Note: build library always, build service when libxml2/etc. are available)
230 * FS:
231   - Remove KBlocks in gnunet-unindex (see discussion with Kenneth Almquist on gnunet-devs in 9/2009)
232   - Allow checking of presence of search results and/or content via command-line tools
233     (add options to gnunet-search / gnunet-download to limit search to local peer)
234 * PEERINFO:
235   - expire 'ancient' HELLOs (those without valid addresses AND that 
236     we have not 'used' (for their public keys) in a while; need a way
237     to track actual 'use')
238   - make sue we also trigger notifications whenever HELLOs expire
239
240
241
242 Optimizations:
243 * TCP:
244   - should use hash map to look up sessions
245 * PEERINFO:
246   - api creates many, many short-lived TCP connections; either some
247     clients should use the API differently or we need to change the
248     API to enable re-use of connections to the service
249 * STATISTICS:
250   - should use BIO instead of mmap
251 * TRANSPORT:
252   - need to periodically probe latency/transport cost changes & possibly switch transport
253   - instantly filter addresses from *other* peers that 
254     are *equal* to our own address + port (i.e., localhost:2086).  We 
255     no longer filter those for outgoing (helps with loopback testing
256     and keeps the code clean), but we should filter strictly *impossible*
257     incoming addresses!  This is for efficiency, not correctness.
258   - should use hash map to look up Neighbours
259 * HOSTLIST:
260   - 'server' uses 'GNUNET_PEERINFO_iterate', should probably switch to notification API
261     (for more instant / up-to-date hostlists at lower cost) [OPTIMIZATION]
262
263 Minor features:
264 * TCP:
265   - repeatedly resolve hostname and look up interfaces to determine our own IP
266   - [./transport/plugin_transport_tcp.c:391]: (style) struct or union member 'Plugin::address_update_task' is never used (related to issue above)
267 * TRANSPORT:
268   - [./transport/gnunet-service-transport.c:173]: (style) struct or union member 'TransportPlugin::rebuild' is never used (related to TCP not refreshing external addresses?)
269 * DATACACHE:
270   - add stats (# bytes available, # bytes used, # PUTs, # GETs, # GETs satisfied)
271