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