/
index.go
365 lines (294 loc) · 7 KB
/
index.go
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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
package siva
import (
"bytes"
"encoding/binary"
"errors"
"io"
"sort"
"time"
"path/filepath"
)
var (
IndexSignature = []byte{'I', 'B', 'A'}
ErrInvalidIndexEntry = errors.New("invalid index entry")
ErrInvalidSignature = errors.New("invalid signature")
ErrEmptyIndex = errors.New("empty index")
ErrUnsupportedIndexVersion = errors.New("unsupported index version")
ErrCRC32Missmatch = errors.New("crc32 missmatch")
)
const (
IndexVersion uint8 = 1
indexFooterSize = 24
)
// Index contains all the files on a siva file, including duplicate files or
// even does flagged as deleted.
type Index []*IndexEntry
// ReadFrom reads an Index from a given reader, the position where the current
// block ends is required since we are reading the index from the end of the
// file
func (i *Index) ReadFrom(r io.ReadSeeker, endBlock uint64) error {
if _, err := r.Seek(int64(endBlock)-indexFooterSize, io.SeekStart); err != nil {
return err
}
f, err := i.readFooter(r)
if err != nil {
return err
}
startingPos := int64(f.IndexSize) + indexFooterSize
if _, err := r.Seek(-startingPos, io.SeekCurrent); err != nil {
return err
}
defer sort.Sort(i)
return i.readIndex(r, f, endBlock)
}
func (i *Index) readFooter(r io.Reader) (*IndexFooter, error) {
f := &IndexFooter{}
if err := f.ReadFrom(r); err != nil {
return nil, err
}
return f, nil
}
func (i *Index) readIndex(r io.Reader, f *IndexFooter, endBlock uint64) error {
hr := newHashedReader(r)
if err := i.readSignature(hr); err != nil {
return err
}
if err := i.readEntries(hr, f, endBlock); err != nil {
return err
}
if f.CRC32 != hr.Checkshum() {
return ErrCRC32Missmatch
}
return nil
}
func (i *Index) readSignature(r io.Reader) error {
sig := make([]byte, 3)
if _, err := r.Read(sig); err != nil {
return err
}
if !bytes.Equal(sig, IndexSignature) {
return ErrInvalidSignature
}
var version uint8
if err := binary.Read(r, binary.BigEndian, &version); err != nil {
return err
}
if version != IndexVersion {
return ErrUnsupportedIndexVersion
}
return nil
}
func (i *Index) readEntries(r io.Reader, f *IndexFooter, endBlock uint64) error {
for j := 0; j < int(f.EntryCount); j++ {
e := &IndexEntry{}
if err := e.ReadFrom(r); err != nil {
return err
}
e.absStart = (endBlock - f.BlockSize) + e.Start
*i = append(*i, e)
}
return nil
}
// WriteTo writes the Index to a io.Writer
func (i *Index) WriteTo(w io.Writer) error {
if len(*i) == 0 {
return ErrEmptyIndex
}
hw := newHashedWriter(w)
f := &IndexFooter{
EntryCount: uint32(len(*i)),
}
if _, err := hw.Write(IndexSignature); err != nil {
return err
}
if err := binary.Write(hw, binary.BigEndian, IndexVersion); err != nil {
return err
}
var blockSize uint64
for _, e := range *i {
blockSize += e.Size
if err := e.WriteTo(hw); err != nil {
return err
}
}
f.IndexSize = uint64(hw.Position())
f.BlockSize = blockSize + f.IndexSize + indexFooterSize
f.CRC32 = hw.Checksum()
if err := f.WriteTo(hw); err != nil {
return err
}
return nil
}
func (s Index) Len() int { return len(s) }
func (s Index) Swap(i, j int) { s[i], s[j] = s[j], s[i] }
func (s Index) Less(i, j int) bool { return s[i].absStart < s[j].absStart }
// Filter returns a filtered version of the current Index removing duplicates
// keeping the latest versions and filtering all the deleted files
func (i *Index) Filter() Index {
var f Index
seen := make(map[string]bool, 0)
for j := len(*i) - 1; j >= 0; j-- {
e := (*i)[j]
if _, ok := seen[e.Name]; ok {
continue
}
seen[e.Name] = true
if e.Flags&FlagDeleted != 0 {
continue
}
f = append(f, e)
}
sort.Sort(f)
return f
}
// Find returns the first IndexEntry with the given name, if any
func (i Index) Find(name string) *IndexEntry {
for _, e := range i {
if e.Name == name {
return e
}
}
return nil
}
// Glob returns all index entries whose name matches pattern or nil if there is
// no matching entry. The syntax of patterns is the same as in filepath.Match.
func (i Index) Glob(pattern string) ([]*IndexEntry, error) {
matches := []*IndexEntry{}
for _, e := range i {
m, err := filepath.Match(pattern, e.Name)
if err != nil {
return nil, err
}
if m {
matches = append(matches, e)
}
}
return matches, nil
}
type IndexEntry struct {
Header
Start uint64
Size uint64
CRC32 uint32
// absStart stores the absolute starting position of the entry in the file
// across all the blocks in the file, is calculate on-the-fly, so that's
// why is not stored
absStart uint64
}
// WriteTo writes the IndexEntry to an io.Writer
func (e *IndexEntry) WriteTo(w io.Writer) error {
if e.Name == "" {
return ErrInvalidIndexEntry
}
name := []byte(e.Name)
length := uint32(len(name))
if err := binary.Write(w, binary.BigEndian, length); err != nil {
return err
}
if _, err := w.Write(name); err != nil {
return err
}
return writeBinary(w, []interface{}{
e.Mode,
e.ModTime.UnixNano(),
e.Start,
e.Size,
e.CRC32,
e.Flags,
})
}
// ReadFrom reads a IndexEntry entry from an io.Reader
func (e *IndexEntry) ReadFrom(r io.Reader) error {
var length uint32
if err := binary.Read(r, binary.BigEndian, &length); err != nil {
return err
}
filename := make([]byte, length)
if _, err := r.Read(filename); err != nil {
return err
}
var nsec int64
err := readBinary(r, []interface{}{
&e.Mode,
&nsec,
&e.Start,
&e.Size,
&e.CRC32,
&e.Flags,
})
e.Name = string(filename)
e.ModTime = time.Unix(0, nsec)
return err
}
type IndexFooter struct {
EntryCount uint32
IndexSize uint64
BlockSize uint64
CRC32 uint32
}
// ReadFrom reads a IndexFooter entry from an io.Reader
func (f *IndexFooter) ReadFrom(r io.Reader) error {
return readBinary(r, []interface{}{
&f.EntryCount,
&f.IndexSize,
&f.BlockSize,
&f.CRC32,
})
}
// WriteTo writes the IndexFooter to an io.Writer
func (f *IndexFooter) WriteTo(w io.Writer) error {
return writeBinary(w, []interface{}{
f.EntryCount,
f.IndexSize,
f.BlockSize,
f.CRC32,
})
}
func writeBinary(w io.Writer, data []interface{}) error {
for _, v := range data {
err := binary.Write(w, binary.BigEndian, v)
if err != nil {
return err
}
}
return nil
}
func readBinary(r io.Reader, data []interface{}) error {
for _, v := range data {
err := binary.Read(r, binary.BigEndian, v)
if err != nil {
return err
}
}
return nil
}
func readIndex(r io.ReadSeeker) (Index, error) {
endLastBlock, err := r.Seek(0, io.SeekEnd)
if err != nil {
return nil, err
}
if endLastBlock == 0 {
return nil, ErrEmptyIndex
}
i, err := readIndexAt(r, uint64(endLastBlock))
if err != nil {
return i, err
}
sort.Sort(i)
return i, nil
}
func readIndexAt(r io.ReadSeeker, offset uint64) (Index, error) {
i := make(Index, 0)
if err := i.ReadFrom(r, offset); err != nil {
return nil, err
}
if len(i) == 0 || i[0].absStart == 0 {
return i, nil
}
previ, err := readIndexAt(r, i[0].absStart)
if err != nil {
return nil, err
}
i = append(i, previ...)
return i, nil
}