Remove an unneeded khashmir file.
[quix0rs-apt-p2p.git] / TODO
1 Check packet lengths before sending get_value responses.
2
3 The length of the created UDP packet needs to be checked before sending
4 to make sure it is not so long that it will get fragmented. This is only
5 possible for the get_value RPC request.
6
7
8 Clean up the khashmir actions.
9
10 The khashmir actions are a mess, and some cleanup is necessary. A lot
11 of the actions have most of their processing in common, so this code
12 should be put in functions that all can call. Perhaps creating a
13 base "RecurringAction" and "StaticAction" would be a good idea,
14 as then find_node and find_value could use the first, while get_value
15 and store_value could use the second. Perhaps ping and join actions
16 should also be created for consistency, and maybe inherit from a
17 "SingleNodeAction" base class.
18
19
20 Packages.diff files need to be considered.
21
22 The Packages.diff/Index files contain hashes of Packages.diff/rred.gz 
23 files, which themselves contain diffs to the Packages files previously 
24 downloaded. Apt will request these files for the testing/unstable 
25 distributions. They need to either be ignored, or dealt with properly by 
26 adding them to the tracking done by the AptPackages module.
27
28
29 PeerManager needs to download large files from multiple peers.
30
31 The PeerManager currently chooses a peer at random from the list of 
32 possible peers, and downloads the entire file from there. This needs to 
33 change if both a) the file is large (more than 512 KB), and b) there are
34 multiple peers with the file. The PeerManager should then break up the 
35 large file into multiple pieces of size < 512 KB, and then send requests 
36 to multiple peers for these pieces.
37
38 This can cause a problem with hash checking the returned data, as hashes 
39 for the pieces are not known. Any file that fails a hash check should be 
40 downloaded again, with each piece being downloaded from different peers 
41 than it was previously. The peers are shifted by 1, so that if a peers 
42 previously downloaded piece i, it now downloads piece i+1, and the first 
43 piece is downloaded by the previous downloader of the last piece, or 
44 preferably a previously unused peer. As each piece is downloaded the 
45 running hash of the file should be checked to determine the place at 
46 which the file differs from the previous download.
47
48 If the hash check then passes, then the peer who originally provided the 
49 bad piece can be assessed blame for the error. Otherwise, the peer who 
50 originally provided the piece is probably at fault, since he is now 
51 providing a later piece. This doesn't work if the differing piece is the 
52 first piece, in which case it is downloaded from a 3rd peer, with 
53 consensus revealing the misbehaving peer.
54
55
56 Store and share torrent-like strings for large files.
57
58 In addition to storing the file download location (which would still be 
59 used for small files), a bencoded dictionary containing the peer's 
60 hashes of the individual pieces could be stored for the larger files 
61 (20% of all the files are larger than 512 KB). This dictionary would 
62 have the normal piece size, the hash length, and a string containing the 
63 piece hashes of length <hash length>*<#pieces>. These piece hashes could 
64 be compared ahead of time to determine which peers have the same piece 
65 hashes (they all should), and then used during the download to verify 
66 the downloaded pieces.
67
68 For very large files (5 or more pieces), the torrent strings are too 
69 long to store in the DHT and retrieve (a single UDP packet should be 
70 less than 1472 bytes to avoid fragmentation). Instead, the peers should 
71 store the torrent-like string for large files separately, and only 
72 contain a reference to it in their stored value for the hash of the 
73 file. The reference would be a hash of the bencoded dictionary. If the 
74 torrent-like string is short enough to store in the DHT (i.e. less than 
75 1472 bytes, or about 70 pieces for the SHA1 hash), then a 
76 lookup of that hash in the DHT would give the torrent-like string. 
77 Otherwise, a request to the peer for the hash (just like files are 
78 downloaded), should return the bencoded torrent-like string.
79
80
81 PeerManager needs to track peers' properties.
82
83 The PeerManager needs to keep track of the observed properties of seen 
84 peers, to help determine a selection criteria for choosing peers to 
85 download from. Each property will give a value from 0 to 1. The relevant 
86 properties are:
87
88  - hash errors in last day (1 = 0, 0 = 3+)
89  - recent download speed (1 = fastest, 0 = 0)
90  - lag time from request to download (1 = 0, 0 = 15s+)
91  - number of pending requests (1 = 0, 0 = max (10))
92  - whether a connection is open (1 = yes, 0.9 = no)
93
94 These should be combined (multiplied) to provide a sort order for peers 
95 available to download from, which can then be used to assign new 
96 downloads to peers. Pieces should be downloaded from the best peers 
97 first (i.e. piece 0 from the absolute best peer).