Updates after more though on a couple of of the TODO items.
[quix0rs-apt-p2p.git] / TODO
1 Files for which a hash cannot be found should not be added to the DHT.
2
3 If the hash can't found, it stands to reason that other peers will not 
4 be able to find the hash either. So adding those files to the DHT will 
5 just clutter it with useless information. Examples include Release.gpg, 
6 Release, Translation-de.bz2, and Contents.gz.
7
8
9 Packages.diff files need to be considered.
10
11 The Packages.diff/Index files contain hashes of Packages.diff/rred.gz 
12 files, which themselves contain diffs to the Packages files previously 
13 downloaded. Apt will request these files for the testing/unstable 
14 distributions. They need to either be ignored, or dealt with properly by 
15 adding them to the tracking done by the AptPackages module.
16
17
18 Change file identifier from path to hash.
19
20 Some files can change without changing the path, since the file was 
21 added to the DHT by the peer. Examples are Release, Packages.gz, and 
22 Sources.bz2. This would cause problems when requesting these files by 
23 path. Instead, share the files by hash, then the request would be for 
24 http://127.3.45.9:9977/~<urlencodedHash>, and it would always work. This 
25 will require a database lookup for every request.
26
27
28 PeerManager needs to download large files from multiple peers.
29
30 The PeerManager currently chooses a peer at random from the list of 
31 possible peers, and downloads the entire file from there. This needs to 
32 change if both a) the file is large (more than 512 KB), and b) there are
33 multiple peers with the file. The PeerManager should then break up the 
34 large file into multiple pieces of size < 512 KB, and then send requests 
35 to multiple peers for these pieces.
36
37 This can cause a problem with hash checking the returned data, as hashes 
38 for the pieces are not known. Any file that fails a hash check should be 
39 downloaded again, with each piece being downloaded from different peers 
40 than it was previously. The peers are shifted by 1, so that if a peers 
41 previously downloaded piece i, it now downloads piece i+1, and the first 
42 piece is downloaded by the previous downloader of the last piece, or 
43 preferably a previously unused peer. As each piece is downloaded the 
44 running hash of the file should be checked to determine the place at 
45 which the file differs from the previous download.
46
47 If the hash check then passes, then the peer who originally provided the 
48 bad piece can be assessed blame for the error. Otherwise, the peer who 
49 originally provided the piece is probably at fault, since he is now 
50 providing a later piece. This doesn't work if the differing piece is the 
51 first piece, in which case it is downloaded from a 3rd peer, with 
52 consensus revealing the misbehaving peer.
53
54
55 Store and share torrent-like strings for large files.
56
57 In addition to storing the file download location (which would still be 
58 used for small files), a bencoded dictionary containing the peer's 
59 hashes of the individual pieces could be stored for the larger files 
60 (20% of all the files are larger than 512 KB). This dictionary would 
61 have the normal piece size, the hash length, and a string containing the 
62 piece hashes of length <hash length>*<#pieces>. These piece hashes could 
63 be compared ahead of time to determine which peers have the same piece 
64 hashes (they all should), and then used during the download to verify 
65 the downloaded pieces.
66
67 For very large files (5 or more pieces), the torrent strings are too 
68 long to store in the DHT and retrieve (a single UDP packet should be 
69 less than 1472 bytes to avoid fragmentation). Instead, the peers should 
70 store the torrent-like string for large files separately, and only 
71 contain a reference to it in their stored value for the hash of the 
72 file. The reference would be a hash of the bencoded dictionary. If the 
73 torrent-like string is short enough to store in the DHT (i.e. less than 
74 1472 bytes, or about 70 pieces for the SHA1 hash), then a 
75 lookup of that hash in the DHT would give the torrent-like string. 
76 Otherwise, a request to the peer for the hash (just like files are 
77 downloaded), should return the bencoded torrent-like string.
78
79
80 PeerManager needs to track peers' properties.
81
82 The PeerManager needs to keep track of the observed properties of seen 
83 peers, to help determine a selection criteria for choosing peers to 
84 download from. Each property will give a value from 0 to 1. The relevant 
85 properties are:
86
87  - hash errors in last day (1 = 0, 0 = 3+)
88  - recent download speed (1 = fastest, 0 = 0)
89  - lag time from request to download (1 = 0, 0 = 15s+)
90  - number of pending requests (1 = 0, 0 = max (10))
91  - whether a connection is open (1 = yes, 0.9 = no)
92
93 These should be combined (multiplied) to provide a sort order for peers 
94 available to download from, which can then be used to assign new 
95 downloads to peers. Pieces should be downloaded from the best peers 
96 first (i.e. piece 0 from the absolute best peer).
97
98
99 Missing Kademlia implementation details are needed.
100
101 The current implementation is missing some important features, mostly 
102 focussed on storing values:
103  - values need to be republished (every hour?)
104  - original publishers need to republish values (every 24 hours)
105  - when a new node is found that is closer to some values, replicate the 
106    values there without deleting them
107  - when a value lookup succeeds, store the value in the closest node 
108    found that didn't have it
109  - make the expiration time of a value exponentially inversely 
110    proportional to the number of nodes between the current node and the 
111    node closest to the value