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