TODO

   1 PHASE #1: (Goal: settle key design questions)
   2
   3 Util:
   4 * Windows: use events instead of pipes to signal select()s [Nils]
   5 * only connect() sockets that are ready (select()) [Nils]
   6   [On W32, we need to select after calling socket before
   7    doing connect etc.]
   8 * Add "DISK" API for creating of temporary files
   9   (as used in datacache/ module)
  10
  11 PHASE #2: (Goal: recover basic file-sharing functionality)
  12
  13
  14 TESTCASES WANTED:
  15
  16 For these functions, it would be nice if we had testcases ("make check")
  17 that would cause them to be executed and check that they are working:
  18 * gnunet-service-peerinfo:
  19   - change_host_trust / flush_trust
  20   - remove_garbage
  21   - discard_hosts_helper / cron_clean_data_hosts
  22 * gnunet-service-transport:
  23   - try_unvalidated_addresses
  24   - lookup_address_callback
  25   - lookup_hello_callback
  26   - plugin_env_lookup_address
  27   - notify_clients_disconnect
  28   - list_validated_addresses
  29   - cleanup_validation
  30   - disconnect_neighbour
  31   - handle_set_quota
  32 * plugin_transport_tcp.c:
  33   - tcp_plugin_cancel
  34   - tcp_plugin_address_pretty_printer / append_port
  35   - tcp_plugin_set_receive_quota
  36   - delayed_done
  37 * transport_api:
  38   - GNUNET_TRANSPORT_set_qutoa / send_set_quota
  39   - hello_wait_timeout
  40   - transmit_ready
  41   - transmit_timeout
  42   - remove_from_any_list / remove_neighbour
  43   - GNUNET_TRANSPORT_notify_transmit_ready_cancel
  44   - Testcases for set_quota, timeouts, disconnects, transmit_ready_cancel
  45   - gnunet-service-transport HELLO validation (how good is our coverage?)
  46   - direct test of plugins compliance to plugin API
  47 * core_api:
  48   - timeout_request
  49   - solicit_traffic / copy_and_free
  50   - GNUNET_CORE_peer_configure / produce_configure_message
  51 * gnunet-service-core:
  52   - update_window
  53   - find_client
  54   - handle_client_request_configure
  55   - set_key_retry_task
  56   - align_and_deliver
  57   - handle_transport_notify_disconnect
  58 * hostlist (everything)
  59 * topology (everything)
  60
  61
  62 Module features to implement:
  63 * TESTING (needed for DV, DHT, Topology)
  64   - implement library for local testing
  65   - implement testcases for library
  66   - implement library for distributed testing
  67   - implement testcases for distributed testing
  68 * TOPOLOGY:
  69   - implement testcases (needs TESTING)
  70 * HOSTLIST:
  71   - implement testcases
  72 * DV (needed for DHT)
  73   - write DV API
  74   - implement DV service
  75   - implement DV library
  76   - implement DV transport plugin
  77   - implement testcases
  78   - implement performance tests
  79 * DHT (needed for FS)
  80   - review DHT API
  81   - implement DHT service (needs DV, DATACACHE)
  82   - implement DHT library
  83   - implement testcases
  84   - implement performance tests
  85 * FS
  86   - review FS API
  87   - design network structs (CS)
  88   - implement FS library
  89     + URI API
  90     + getopt API
  91     + persistence mechanism
  92     + sharing API
  93       ~ file-information
  94       ~ insert
  95       ~ download
  96       ~ search
  97       ~ unindex
  98       ~ namespaces
  99       ~ collection
 100     + directory API
 101   - design network structs (P2P)
 102   - datastore request queueing mechanism
 103   - implement FS service (needs DHT)
 104     + insert
 105     + download
 106     + search
 107     + unindex
 108   - implement testcases
 109     + URI API
 110     + getopt API
 111     + sharing API (needs TESTING)
 112       ~ file-information
 113       ~ insert
 114       ~ download
 115       ~ search
 116       ~ unindex
 117       ~ namespaces
 118       ~ collection
 119     + directory API
 120   - implement performance tests (needs TESTING)
 121     + insert
 122     + download
 123     + search
 124     + unindex
 125
 126
 127
 128 PHASE #3: (Goal: ready for pre-release) [completion-goal: end of 2009]
 129
 130 Module features to implement:
 131 * setup
 132   - default generation
 133   - need to settle basic design; do we want to keep guile?
 134 * tbench
 135   - good to have for DV evaluation!
 136 * tracekit
 137   - good to have for DV/DHT evaluation!
 138 * vpn
 139
 140
 141 GUIs to implement:
 142 * gtk
 143 * qt
 144 * fuse
 145
 146
 147 Plugins to implement:
 148 * UDP backend (need LIBRARY to support (de)fragmentation!)
 149 * HTTP backend
 150
 151
 152
 153
 154
 155 Minor TODO items / known bugs:
 156 * UTIL:
 157   - crypto_hash: use libgcrypt (supports SHA-512 since 2003)
 158   - container_bloomfilter: improve efficiency (see FIXME)
 159 * SERVER:
 160   - inefficient memmove
 161 * TRANSPORT:
 162   - transport_api: support forcing disconnects through low quotas!
 163     (required for working F2F support!)
 164   - API: consider having core provide deadline information for each message
 165     (likely important for DV plugin which wants to loop back!)
 166   - implement transport API to pretty-print transport address
 167     + transport_api extension (API extension!)
 168     + service-transport extension (protocol extension)
 169   - add calls to statistics in various places
 170   - implement gnunet-transport (transport configurator / tester)
 171   - UPnP-based IP detection
 172     (Note: build library always, build service when libxml2/etc. are available)
 173   - instantly filter addresses from *other* peers that
 174     are *equal* to our own address + port (i.e., localhost:2086).  We
 175     no longer filter those for outgoing (helps with loopback testing
 176     and keeps the code clean), but we should filter strictly *impossible*
 177     incoming addresses!  This is for efficiency, not correctness.
 178   - We currently are happy to take any address told to us in a WELCOME
 179     to our set of addresses; we should have some minimal threshold-based
 180     scheme, limiting both the total number of addresses that we accept
 181     this way as well as requiring multiple confirmations; also, we
 182     should possibly try to confirm that the given address works for
 183     us ourselves (loopback-style) before adding it to the list
 184     [SECURITY issue]
 185     + we may be able to simplify WELCOME messages (no need to add
 186       addresses there anymore, but may help to learn them there anyway...).
 187     + we probably want some kind of voting/counting for learning IP addresses
 188       (maybe including IP addresses in ads proportional to how often others
 189        report them? we at least need some protection against >64k HELLOs!),
 190     + provide a way to give the user a list of "learned" IP addresses and
 191       a way to easily "veto" addresses off the list!
 192       => If MiM attacker uses vetoed address, blacklist the specific IP for
 193          the presumed neighbour!
 194   - not sure current way of doing ACKs works well-enough
 195     with unreliable transports where the ACK maybe lost;
 196     the "is_new" check would then possibly prevent future
 197     ACKs to be delivered, all while we're happily
 198     receiving messages from that peer!  Worse, the other
 199     peer won't generate another ACK since it thinks we're
 200     connected just fine...
 201     Key questions:
 202     + How necessary is ACKing in the first place? (alternatives?)
 203     + Should we transmit ACKs in response to every HELLO? (would that
 204       fully address the problem?)
 205   - latency measurements implemented in the transport
 206     plugins makes it only work for bi-di transports
 207     and results in code replication
 208   - should latency be included in the ReceiveCallback and
 209     NotifyConnect or passed on request?
 210   - FIXME's with latency being simply set to 0 in a few places
 211   - Memory leak (running valgrind --trace-children=yes on test_transport_api:
 212     ==28393== 16 bytes in 1 blocks are indirectly lost in loss record 1 of 5
 213     ==28393==    at 0x4C2260E: malloc (vg_replace_malloc.c:207)
 214     ==28393==    by 0x52343E3: GNUNET_xmalloc_unchecked_ (common_allocation.c:62)
 215     ==28393==    by 0x5234389: GNUNET_xmalloc_ (common_allocation.c:53)
 216     ==28393==    by 0x524458A: GNUNET_NETWORK_socket_create_from_accept (network.c:289)
 217     ==28393==    by 0x524B2DA: ??? (server.c:332)
 218     ==28393==    by 0x524A4C7: ??? (scheduler.c:425)
 219     ==28393==    by 0x524A73D: GNUNET_SCHEDULER_run (scheduler.c:510)
 220     ==28393==    by 0x524FF8C: GNUNET_SERVICE_run (service.c:1326)
 221     ==28393==    by 0x405500: main (gnunet-service-transport.c:2645)
 222     And also:
 223     ==28393== 65,744 (65,728 direct, 16 indirect) bytes in 1 blocks are definitely lost in loss record 5 of 5
 224     ==28393==    at 0x4C2260E: malloc (vg_replace_malloc.c:207)
 225     ==28393==    by 0x52343E3: GNUNET_xmalloc_unchecked_ (common_allocation.c:62)
 226     ==28393==    by 0x5234389: GNUNET_xmalloc_ (common_allocation.c:53)
 227     ==28393==    by 0x524473E: GNUNET_NETWORK_socket_create_from_accept (network.c:323)
 228     (rest of trace identical)
 229
 230 * DATASTORE:
 231   - mysql backend
 232   - postgres backend
 233 * SETUP:
 234   - auto-generate "defaults.conf" using gnunet-setup from "config.scm"
 235   - integrate all options into "config.scm"
 236   - change config-file writing to exclude options set to default values
 237 * ARM:
 238   - implement exponential back-off for service restarts
 239   - better tracking of which config changes actually need to cause process restarts by ARM.
 240   - have way to specify dependencies between services (to manage ARM restarts better)
 241   - client-API is inefficient since it opens a TCP connection per service that is started
 242     (instead of re-using connections).
 243 * CORE:
 244   - code currently notifies clients about "encrypted" connections being up well before
 245     we get the encrypted PONG; sometimes this may be OK (for topology killing
 246     unwanted connnections), but of course not in general.  I suspect we want
 247     to signal on PONG and have topology hook directly into transport to
 248     kill plaintext connections before they have a chance to become encrypted
 249     (may require minor hack in transport API)
 250 * PEERINFO:
 251   - have gnunet-peerinfo print actual host addresses again
 252   - add option to gnunet-peerinfo to modify trust value
 253 * POSTGRES-DB:
 254   - finish postgres implementation; simplify other SQLs using new stats
 255 * HTTPS transport
 256   - PolariSSL for MHD?
 257   - https integration
 258 * GAP improvements:
 259   - active reply route caching design & implementation of service,
 260     gap extension!
 261 * HOSTLIST:
 262   - implement advertising of hostlist URL
 263   - implement learning of hostlist URLs
 264
 265
 266
 267 => PRE-RELEASE
 268
 269 PHASE #4: [completion-goal: mid 2010]
 270 * Documentation
 271   - Doxygen generation
 272   - lcov generation
 273   - update man pages
 274   - update webpage documentation
 275 * new webpage:
 276   - expand bibliography
 277   - convert documentation pages to books
 278   - update books (especially for developers)
 279   - add content type for links and view
 280   - create good Drupal theme for GNUnet
 281   - make a NICE download page and figure out how to
 282     enable developers to publish TGZs nicely
 283   - port "contact" page; add impressum
 284   - add content type for "todo" items?
 285   - DNS activation
 286
 287
 288 Stuff to remember:
 289 * Features eliminated from util:
 290   - threading (goal: good riddance!)
 291   - complex logging features [ectx-passing, target-kinds] (goal: good riddance!)
 292   - complex configuration features [defaults, notifications] (goal: good riddance!)
 293   - network traffic monitors (goal: eliminate)
 294   - IPC semaphores (goal: d-bus? / eliminate?)
 295   - second timers
 296   - DNS lookup (goal: have async service; issue: still need synchronous resolution in places, current code may not be portable)
 297   => code shrunk from 61 files to 34, 22k LOC to 15k LOC, 470k to 330k (with symbols)
 298 * New features in util:
 299   - scheduler
 300   - service and program boot-strap code
 301 * Major changes in util:
 302   - more expressive server (replaces selector)
 303 * Open questions:
 304   - how to integrate scheduler with GTK event loop!
 305
 306
 307
 308 Test coverage:
 309 * UTIL      : 78.7%
 310 * HELLO     : 93.7%
 311 * ARM       : 69.9%
 312 * RESOLVER  : 60.4%
 313 * STATISTICS: 82.8%
 314 * PEERINFO  : 71.5%
 315 * TRANSPORT : 70.9%
 316 * CORE      : 65.8%
 317 ===================
 318 * TOTAL     : 74.9%
 319
 320 Not yet tested:
 321 * HOSTLIST  :  0.0%
 322 * TOPOLOGY  :  0.0%