ignore
[oweals/gnunet.git] / TODO
1 PHASE #1: (Goal: settle key design questions)
2
3 Core:
4 * API review: should "bpm" and "last_activity" arguments be 
5   included in the ClientEventHandler?
6 * Internal: topology
7 * Internal: bandwidth allocation (inbound limits, trust)
8 * Internal: advertising (propagate other peers' HELLOs, find new ones)
9 * Internal: bootstrapping
10   => bootstrap should use plugins, possible multiple at the same time!
11
12 Util:
13 * Should "server" argument be given in event callbacks?
14 * consider adding "get_time" to "configuration" API
15
16 TESTCASES WANTED:
17 For these functions, it would be nice if we had testcases ("make check")
18 that would cause them to be executed and check that they are working:
19 * gnunet-service-peerinfo:
20   - change_host_trust / flush_trust 
21   - remove_garbage / 
22   - discard_hosts_helper / cron_clean_data_hosts
23 * gnunet-service-transport:
24   - try_unvalidated_addresses
25   - lookup_address_callback
26   - lookup_hello_callback
27   - plugin_env_lookup_address
28   - notify_clients_disconnect
29   - list_validated_addresses
30   - cleanup_validation
31   - disconnect_neighbour
32   - handle_set_quota
33 * plugin_transport_tcp.c:
34   - tcp_plugin_cancel
35   - tcp_plugin_address_pretty_printer / append_port
36   - tcp_plugin_set_receive_quota
37   - delayed_done
38 * transport_api:
39   - GNUNET_TRANSPORT_set_qutoa / send_set_quota
40   - hello_wait_timeout 
41   - transmit_ready
42   - transmit_timeout
43   - remove_from_any_list / remove_neighbour
44   - GNUNET_TRANSPORT_notify_transmit_ready_cancel
45 * core_api:
46   - timeout_request
47   - solicit_traffic / copy_and_free
48   - GNUNET_CORE_peer_configure / produce_configure_message
49 * gnunet-service-core:
50   - update_window
51   - find_client
52   - handle_client_request_configure
53   - set_key_retry_task
54   - align_and_deliver
55   - handle_transport_notify_disconnect
56
57
58 PHASE #2: (Goal: recover basic core functionality)
59
60 Datastores:
61 * implement sqlite-based sqstore/datastore service
62   + implement library (talks to service)
63   + implement service (datastore + talks to plugin)
64   + implement sqlite plugin (talks to DB)
65 * implement sqlite-based dstore services
66   + implement library (talks to service)
67   + implement service (talks to plugin)
68   + implement sqlite plugin (talks to DB)
69
70 Applications:
71 * implement hostlist service (need to bootstrap!)
72 * DHT, DV
73 * FS / fs-libs
74
75 Databases:
76 * mysql & postgres backend
77
78 Transports:
79 * UDP backend (need LIBRARY to support (de)fragmentation!)
80 * HTTP backend
81 * Testing:
82   +  Testcases for set_quota, timeouts, disconnects, transmit_ready_cancel
83   + Better coverage of gnunet-service-transport (hello validation)
84   + direct test of plugins compliance to plugin API
85
86
87 PHASE #3: (Goal: ready for pre-release) [completion-goal: end of 2009]
88
89 * testing
90 * setup
91 * gtk, qt GUIs
92 * tbench
93 * tracekit
94 * vpn
95
96
97
98 Minor TODO items:
99 * SERVER:
100   - inefficient memmove
101 * TRANSPORT:
102   - transport_api: support forcing disconnects through low quotas!
103   - API: consider having core provide priority and possibly
104     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   - not sure current way of doing ACKs works well-enough 
126     with unreliable transports where the ACK maybe lost;
127     the "is_new" check would then possibly prevent future
128     ACKs to be delivered, all while we're happily 
129     receiving messages from that peer!  Worse, the other
130     peer won't generate another ACK since it thinks we're
131     connected just fine...
132     Key questions:
133     + How necessary is ACKing in the first place? (alternatives?)
134     + Should we transmit ACKs in response to every HELLO? (would that 
135       fully address the problem?)
136   - latency measurements implemented in the transport
137     plugins makes it only work for bi-di transports
138     and results in code replication
139   - should latency be included in the ReceiveCallback and
140     NotifyConnect or passed on request?
141 * SETUP:
142   - auto-generate "defaults.conf" using gnunet-setup from "config.scm"
143   - integrate all options into "config.scm"
144   - change config-file writing to exclude options set to default values
145 * ARM:
146   - implement exponential back-off for service restarts
147   - better tracking of which config changes actually need to cause process restarts by ARM.
148   - have way to specify dependencies between services (to manage ARM restarts better)
149 * PEERINFO:
150   - have gnunet-peerinfo print actual host addresses again
151   - add option to gnunet-peerinfo to modify trust value
152 * POSTGRES-DB:
153   - finish postgres implementation; simplify other SQLs using new stats
154 * HTTPS transport
155   - PolariSSL for MHD?
156   - https integration
157 * GAP improvements:
158   - active reply route caching design & implementation of service,
159     gap extension!
160
161 => PRE-RELEASE
162
163 PHASE #4: [completion-goal: mid 2010]
164 * Documentation
165 * new webpage
166
167
168
169
170 Stuff to remember:
171 * Features eliminated from util:
172   - threading (goal: good riddance!)
173   - complex logging features [ectx-passing, target-kinds] (goal: good riddance!)
174   - complex configuration features [defaults, notifications] (goal: good riddance!)
175   - network traffic monitors (goal: eliminate)
176   - IPC semaphores (goal: d-bus? / eliminate?)
177   - second timers
178   - DNS lookup (goal: have async service; issue: still need synchronous resolution in places, current code may not be portable)
179   => code shrunk from 61 files to 34, 22k LOC to 15k LOC, 470k to 330k (with symbols)
180 * New features in util:
181   - scheduler
182   - service and program boot-strap code
183 * Major changes in util:
184   - more expressive server (replaces selector)
185 * Open questions: 
186   - how to integrate scheduler with GTK event loop!
187
188
189
190 Test coverage:
191 * UTIL: 75%, 4914 out of 6463