More work on the TODO.
[quix0rs-apt-p2p.git] / TODO
1 Comply with the newly defined protocol on the web page.
2
3 Various things need to done to comply with the newly defined protocol:
4  - use the compact encoding of contact information
5  - remove the originated time from the value storage
6  - add the token to find_node responses
7  - use the token in store_node requests
8  - standardize the error messages (especially for a bad token)
9
10
11 Packages.diff files need to be considered.
12
13 The Packages.diff/Index files contain hashes of Packages.diff/rred.gz 
14 files, which themselves contain diffs to the Packages files previously 
15 downloaded. Apt will request these files for the testing/unstable 
16 distributions. They need to either be ignored, or dealt with properly by 
17 adding them to the tracking done by the AptPackages module.
18
19
20 PeerManager needs to download large files from multiple peers.
21
22 The PeerManager currently chooses a peer at random from the list of 
23 possible peers, and downloads the entire file from there. This needs to 
24 change if both a) the file is large (more than 512 KB), and b) there are
25 multiple peers with the file. The PeerManager should then break up the 
26 large file into multiple pieces of size < 512 KB, and then send requests 
27 to multiple peers for these pieces.
28
29 This can cause a problem with hash checking the returned data, as hashes 
30 for the pieces are not known. Any file that fails a hash check should be 
31 downloaded again, with each piece being downloaded from different peers 
32 than it was previously. The peers are shifted by 1, so that if a peers 
33 previously downloaded piece i, it now downloads piece i+1, and the first 
34 piece is downloaded by the previous downloader of the last piece, or 
35 preferably a previously unused peer. As each piece is downloaded the 
36 running hash of the file should be checked to determine the place at 
37 which the file differs from the previous download.
38
39 If the hash check then passes, then the peer who originally provided the 
40 bad piece can be assessed blame for the error. Otherwise, the peer who 
41 originally provided the piece is probably at fault, since he is now 
42 providing a later piece. This doesn't work if the differing piece is the 
43 first piece, in which case it is downloaded from a 3rd peer, with 
44 consensus revealing the misbehaving peer.
45
46
47 Store and share torrent-like strings for large files.
48
49 In addition to storing the file download location (which would still be 
50 used for small files), a bencoded dictionary containing the peer's 
51 hashes of the individual pieces could be stored for the larger files 
52 (20% of all the files are larger than 512 KB). This dictionary would 
53 have the normal piece size, the hash length, and a string containing the 
54 piece hashes of length <hash length>*<#pieces>. These piece hashes could 
55 be compared ahead of time to determine which peers have the same piece 
56 hashes (they all should), and then used during the download to verify 
57 the downloaded pieces.
58
59 For very large files (5 or more pieces), the torrent strings are too 
60 long to store in the DHT and retrieve (a single UDP packet should be 
61 less than 1472 bytes to avoid fragmentation). Instead, the peers should 
62 store the torrent-like string for large files separately, and only 
63 contain a reference to it in their stored value for the hash of the 
64 file. The reference would be a hash of the bencoded dictionary. If the 
65 torrent-like string is short enough to store in the DHT (i.e. less than 
66 1472 bytes, or about 70 pieces for the SHA1 hash), then a 
67 lookup of that hash in the DHT would give the torrent-like string. 
68 Otherwise, a request to the peer for the hash (just like files are 
69 downloaded), should return the bencoded torrent-like string.
70
71
72 PeerManager needs to track peers' properties.
73
74 The PeerManager needs to keep track of the observed properties of seen 
75 peers, to help determine a selection criteria for choosing peers to 
76 download from. Each property will give a value from 0 to 1. The relevant 
77 properties are:
78
79  - hash errors in last day (1 = 0, 0 = 3+)
80  - recent download speed (1 = fastest, 0 = 0)
81  - lag time from request to download (1 = 0, 0 = 15s+)
82  - number of pending requests (1 = 0, 0 = max (10))
83  - whether a connection is open (1 = yes, 0.9 = no)
84
85 These should be combined (multiplied) to provide a sort order for peers 
86 available to download from, which can then be used to assign new 
87 downloads to peers. Pieces should be downloaded from the best peers 
88 first (i.e. piece 0 from the absolute best peer).
89
90
91 When looking up values, DHT should return nodes and values.
92
93 When a key has multiple values in the DHT, returning a stored value may not
94 be sufficient, as then no more nodes can be contacted to get more stored
95 values. Instead, return both the stored values and the list of closest
96 nodes so that the peer doing the lookup can decide when to stop looking
97 (when it has received enough values).
98
99 Instead of returning both, a new method could be added, "lookup_value".
100 This method will be like "get_value", except that every node will always
101 return a list of nodes, as well as the number of values it has for that
102 key. Once a querying node has found enough values (or all of them), then
103 it would send the "get_value" method to the nodes that have the most
104 values. The "get_value" query could also have a new parameter "number",
105 which is the maximum number of values to return.
106
107
108 Missing Kademlia implementation details are needed.
109
110 The current implementation is missing some important features, mostly 
111 focussed on storing values:
112  - values need to be republished (every hour?)