aboutsummaryrefslogtreecommitdiff
path: root/TODO.md
blob: 4639a5304f577fc2f38d0ebf0a112fe5272973c9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
priority 1
----------
- [x] add `deltaEncode` chunks function
    - [x] do not merge consecutive smaller chunks as these could be stored as
        chunks if no similar chunk is found. Thus, it will need to be of
        `chunkSize` or less. Otherwise, it could not be possibly used for
        deduplication.
- [x] add chunk cache to uniquely store chunks in RAM
- [x] better tests for `(*Repo).Commit`
- [x] remove errored files from `fileList`
- [ ] export in `dir` format
    - [ ] add superblock (this is related to the `init` cmd).
    - [x] add version blocks (these are filled with the recipe and files if
        there is space left)
- [ ] import from `dir` format
- [x] command line with subcommands (like, hmm... git ? for instance).
- [ ] experiences:
    - [x] compare against UDF (this will not be possible, unless we use a real
        CR-ROM) (we used git storage for an approximation)
    - [x] make multiple repo versions with multiple parameters
        - smaller block size
    - [ ] use export in bench to compare the performance when all chunks are
        compressed at once.
- [ ] `init` command to initialize repo
    - [ ] remove `chunkSize` parameter from all commands, keep it only on `init`
    - [ ] `init` would save the important parameters of the repo, such as:
        - the bloc size
        - the delta algorithm
        - the compression algorithm
        - the sketch parameters
        - ...and almost every value of the `NewRepo` constructor
    - [ ] these parameters would be loaded in the `*Repo.Init()` function

priority 2
----------
- [ ] read individual files
- [ ] refactor `matchStream` as right now it is quite complex
- [ ] tail packing of `PartialChunks` (this Struct does not exist yet as it is
    in fact just `TempChunks` for now).
    This might not be useful if we store the recipe incrementally.
- [ ] option to commit without deltas to save new base chunks.
    This might not be useful if we store the recipe incrementally.
- [ ] custom binary marshal and unmarshal for chunks
- [x] use `loadChunkContent` in `loadChunks`
- [x] save hashes for faster maps rebuild
    - [x] store hashes for current version's chunks
    - [x] load hashes for each version
- [x] use store queue to asynchronously store `chunkData`
- [ ] try [Fdelta](https://github.com/amlwwalker/fdelta) and
    [Xdelta](https://github.com/nine-lives-later/go-xdelta) instead of Bsdiff
- [ ] maybe use an LRU cache instead of the current FIFO one.
- [x] remove `LoadedChunk` and only use `StoredChunk` instead now that the cache
    is implemented
- [ ] keep hash workers so that they reuse the same hasher and reset it instead
    of creating a new one each time. This could save some processing time
- [x] support symlinks
    - [x] store this metadata somewhere, tar could be the solution, but this
        would bury the metadata down into the chunks, storing it into the files
        listing could be another solution but with this approach we would have
        to think about what other metadata we want to store  
        I stored it in the _files_ file so that we don't need to read the chunks
        to get the content of a symlinked file and because it does not seem to
        add a lot of weight to this file (after compression).
- [x] store and restore symlinks relatively if it was relative in source
    directory.
- [ ] add quick progress bar to CLI
- [ ] `list` command to list versions
- [ ] optional argument for `restore` to select the version to restore.

reunion 7/09
------------
- [ ] save recipe consecutive chunks as extents
- [x] store recipe incrementally.
- [x] store file list incrementally.
- [x] compress recipe
- [x] compress file list
- [x] make size comparison between recipe and chunks with some datasets

ideas
-----
1. Would it be a good idea to store the compressed size for each chunk?
    Maybe this way we could only load the chunks needed for each file read.

2. Implement the `fs` interface of Go? Not sure if this will be useful.

3. If we don't need to reduce read amplification we could compress all chunks 
    together if it reduces the space used.

mystical bug 22/09
------------------

On the second run, delta chunks can be encoded against better matching chunks as
more of them are present in the `sketchMap`. But we don't want this to happen,
because this adds data to write again, even if it has already been written.

Possible solutions :

- keep IDs for delta chunks, calculate a hash of the target data and store it in
    a new map. Then, when a chunk is encoded, first check if it exists in
    the fingerprint map, then in the delta map, and only after that check for
    matches in the sketch map.
    This should also probably be used for `TempChunks` as they have more chance
    to be delta-encoded on a second run.
- wait the end of the stream before delta-encoding chunks. So if it is not found
    in the fingerprints map, but it is found in the sketch map, then we wait to
    see if we found a better candidate for delta-encoding.
    This would not fix the problem of `TempChunks` that become delta-encoded on
    the second run. So we would need IDs and a map for these. Tail packing
    `TempChunks` could also help solve this problem
    (see [priority 2](#priority-2)).

The first solution would have an advantage if we were directly streaming the
output of the program into DNA, as it could start DNA-encode it from the first
chunk. The second solution will probably have better space-saving performance as
waiting for better matches will probably lower the size of the patches.

This has been fixed by making multiple passes until no more blocks are added,
this way we are assured that the result will be the same on the following run.

mystical bug number 2 29/09
---------------------------

After modifying only one file of a big source folder, between the first and the
second run of `dna-backup`, around 20 blocks in of the beginning of the recipe
have been replaced by newer ones. These should not have been modified.

I could however not reproduce it...