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