-
Notifications
You must be signed in to change notification settings - Fork 35
/
file.go
410 lines (353 loc) · 10.6 KB
/
file.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
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
// Copyright 2017 The go-hep Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
package rootio
import (
"fmt"
"io"
"os"
"github.com/pkg/errors"
)
type Reader interface {
io.Reader
io.ReaderAt
io.Seeker
io.Closer
}
type Writer interface {
io.Writer
io.WriterAt
io.Seeker
io.Closer
}
// A ROOT file is a suite of consecutive data records (TKey's) with
// the following format (see also the TKey class). If the key is
// located past the 32 bit file limit (> 2 GB) then some fields will
// be 8 instead of 4 bytes:
// 1->4 Nbytes = Length of compressed object (in bytes)
// 5->6 Version = TKey version identifier
// 7->10 ObjLen = Length of uncompressed object
// 11->14 Datime = Date and time when object was written to file
// 15->16 KeyLen = Length of the key structure (in bytes)
// 17->18 Cycle = Cycle of key
// 19->22 [19->26] SeekKey = Pointer to record itself (consistency check)
// 23->26 [27->34] SeekPdir = Pointer to directory header
// 27->27 [35->35] lname = Number of bytes in the class name
// 28->.. [36->..] ClassName = Object Class Name
// ..->.. lname = Number of bytes in the object name
// ..->.. Name = lName bytes with the name of the object
// ..->.. lTitle = Number of bytes in the object title
// ..->.. Title = Title of the object
// -----> DATA = Data bytes associated to the object
//
// The first data record starts at byte fBEGIN (currently set to kBEGIN).
// Bytes 1->kBEGIN contain the file description, when fVersion >= 1000000
// it is a large file (> 2 GB) and the offsets will be 8 bytes long and
// fUnits will be set to 8:
// 1->4 "root" = Root file identifier
// 5->8 fVersion = File format version
// 9->12 fBEGIN = Pointer to first data record
// 13->16 [13->20] fEND = Pointer to first free word at the EOF
// 17->20 [21->28] fSeekFree = Pointer to FREE data record
// 21->24 [29->32] fNbytesFree = Number of bytes in FREE data record
// 25->28 [33->36] nfree = Number of free data records
// 29->32 [37->40] fNbytesName = Number of bytes in TNamed at creation time
// 33->33 [41->41] fUnits = Number of bytes for file pointers
// 34->37 [42->45] fCompress = Compression level and algorithm
// 38->41 [46->53] fSeekInfo = Pointer to TStreamerInfo record
// 42->45 [54->57] fNbytesInfo = Number of bytes in TStreamerInfo record
// 46->63 [58->75] fUUID = Universal Unique ID
type File struct {
r Reader
w Writer
seeker io.Seeker
closer io.Closer
id string //non-root, identifies filename, etc.
version int32
begin int64
// Remainder of record is variable length, 4 or 8 bytes per pointer
end int64
seekfree int64 // first available record
nbytesfree int32 // total bytes available
nfree int32 // total free bytes
nbytesname int32 // number of bytes in TNamed at creation time
units byte
compression int32
seekinfo int64 // pointer to TStreamerInfo
nbytesinfo int32 // sizeof(TStreamerInfo)
uuid [18]byte
dir tdirectory // root directory of this file
siKey Key
sinfos []StreamerInfo
}
// Open opens the named ROOT file for reading. If successful, methods on the
// returned file can be used for reading; the associated file descriptor
// has mode os.O_RDONLY.
func Open(path string) (*File, error) {
fd, err := openFile(path)
if err != nil {
return nil, fmt.Errorf("rootio: unable to open %q (%q)", path, err.Error())
}
f := &File{
r: fd,
seeker: fd,
closer: fd,
id: path,
}
f.dir = tdirectory{file: f}
err = f.readHeader()
if err != nil {
return nil, fmt.Errorf("rootio: failed to read header %q: %v", path, err)
}
return f, nil
}
// NewReader creates a new ROOT file reader.
func NewReader(r Reader, name string) (*File, error) {
f := &File{
r: r,
seeker: r,
closer: r,
id: name,
}
f.dir = tdirectory{file: f}
err := f.readHeader()
if err != nil {
return nil, fmt.Errorf("rootio: failed to read header: %v", err)
}
return f, nil
}
// Create creates the named ROOT file for writing.
func Create(name string) (*File, error) {
fd, err := os.Create(name)
if err != nil {
return nil, fmt.Errorf("rootio: unable to create %q (%q)", name, err.Error())
}
f := &File{
w: fd,
seeker: fd,
closer: fd,
id: name,
version: rootVersion,
}
f.dir = tdirectory{named: tnamed{name: name}, file: f}
err = f.writeHeader()
if err != nil {
_ = fd.Close()
_ = os.RemoveAll(name)
return nil, fmt.Errorf("rootio: failed to write header %q: %v", name, err)
}
return f, nil
}
// Stat returns the os.FileInfo structure describing this file.
func (f *File) Stat() (os.FileInfo, error) {
type stater interface {
Stat() (os.FileInfo, error)
}
if f.r != nil {
if st, ok := f.r.(stater); ok {
return st.Stat()
}
}
if f.w != nil {
if st, ok := f.w.(stater); ok {
return st.Stat()
}
}
return nil, errors.Errorf("rootio: underlying file w/o os.FileInfo")
}
// Read implements io.Reader
func (f *File) Read(p []byte) (int, error) {
return f.r.Read(p)
}
// ReadAt implements io.ReaderAt
func (f *File) ReadAt(p []byte, off int64) (int, error) {
return f.r.ReadAt(p, off)
}
// Seek implements io.Seeker
func (f *File) Seek(offset int64, whence int) (int64, error) {
return f.seeker.Seek(offset, whence)
}
// Version returns the ROOT version this file was created with.
func (f *File) Version() int {
return int(f.version)
}
func (f *File) readHeader() error {
buf := make([]byte, 64)
if _, err := f.ReadAt(buf, 0); err != nil {
return err
}
r := NewRBuffer(buf, nil, 0, nil)
// Header
var magic [4]byte
if _, err := io.ReadFull(r.r, magic[:]); err != nil || string(magic[:]) != "root" {
if err != nil {
return fmt.Errorf("rootio: failed to read ROOT file magic header: %v", err)
}
return fmt.Errorf("rootio: %q is not a root file", f.id)
}
f.version = r.ReadI32()
f.begin = int64(r.ReadI32())
if f.version < 1000000 { // small file
f.end = int64(r.ReadI32())
f.seekfree = int64(r.ReadI32())
f.nbytesfree = r.ReadI32()
f.nfree = r.ReadI32()
f.nbytesname = r.ReadI32()
f.units = r.ReadU8()
f.compression = r.ReadI32()
f.seekinfo = int64(r.ReadI32())
f.nbytesinfo = r.ReadI32()
} else { // large files
f.end = r.ReadI64()
f.seekfree = r.ReadI64()
f.nbytesfree = r.ReadI32()
f.nfree = r.ReadI32()
f.nbytesname = r.ReadI32()
f.units = r.ReadU8()
f.compression = r.ReadI32()
f.seekinfo = r.ReadI64()
f.nbytesinfo = r.ReadI32()
}
f.version %= 1000000
if _, err := io.ReadFull(r.r, f.uuid[:]); err != nil || r.Err() != nil {
if err != nil {
return fmt.Errorf("rootio: failed to read ROOT's UUID file: %v", err)
}
return r.Err()
}
var err error
err = f.dir.readDirInfo()
if err != nil {
return fmt.Errorf("rootio: failed to read ROOT directory infos: %v", err)
}
if f.seekinfo > 0 {
err = f.readStreamerInfo()
if err != nil {
return fmt.Errorf("rootio: failed to read ROOT streamer infos: %v", err)
}
}
err = f.dir.readKeys()
if err != nil {
return fmt.Errorf("rootio: failed to read ROOT file keys: %v", err)
}
return nil
}
func (f *File) writeHeader() error {
panic("not implemented")
}
func (f *File) Map() {
for _, k := range f.dir.keys {
if k.class == "TBasket" {
//b := k.AsBasket()
fmt.Printf("%8s %60s %6v %6v %f\n", k.class, k.name, k.bytes-k.keylen, k.objlen, float64(k.objlen)/float64(k.bytes-k.keylen))
} else {
//println(k.classname, k.name, k.title)
fmt.Printf("%8s %60s %6v %6v %f\n", k.class, k.name, k.bytes-k.keylen, k.objlen, float64(k.objlen)/float64(k.bytes-k.keylen))
}
}
}
func (f *File) Tell() int64 {
where, err := f.Seek(0, io.SeekCurrent)
if err != nil {
panic(err)
}
return where
}
// Close closes the File, rendering it unusable for I/O.
// It returns an error, if any.
func (f *File) Close() error {
for _, k := range f.dir.keys {
k.f = nil
}
f.dir.keys = nil
f.dir.file = nil
return f.closer.Close()
}
// Keys returns the list of keys this File contains
func (f *File) Keys() []Key {
return f.dir.keys
}
func (f *File) Name() string {
return f.dir.Name()
}
func (f *File) Title() string {
return f.dir.Title()
}
func (f *File) Class() string {
return "TFile"
}
// readStreamerInfo reads the list of StreamerInfo from this file
func (f *File) readStreamerInfo() error {
if f.seekinfo <= 0 || f.seekinfo >= f.end {
return fmt.Errorf("rootio: invalid pointer to StreamerInfo (pos=%v end=%v)", f.seekinfo, f.end)
}
buf := make([]byte, int(f.nbytesinfo))
nbytes, err := f.ReadAt(buf, f.seekinfo)
if err != nil {
return err
}
if nbytes != int(f.nbytesinfo) {
return fmt.Errorf("rootio: requested [%v] bytes. read [%v] bytes from file", f.nbytesinfo, nbytes)
}
err = f.siKey.UnmarshalROOT(NewRBuffer(buf, nil, 0, nil))
f.siKey.f = f
if err != nil {
return err
}
objs := f.siKey.Value().(List)
f.sinfos = make([]StreamerInfo, 0, objs.Len())
for i := 0; i < objs.Len(); i++ {
obj, ok := objs.At(i).(StreamerInfo)
if !ok {
continue
}
f.sinfos = append(f.sinfos, obj)
streamers.add(obj)
}
return nil
}
// StreamerInfos returns the list of StreamerInfos of this file.
func (f *File) StreamerInfos() []StreamerInfo {
return f.sinfos
}
// StreamerInfo returns the StreamerInfo with name of this file and an error if any.
func (f *File) StreamerInfo(name string) (StreamerInfo, error) {
if len(f.sinfos) == 0 {
return nil, fmt.Errorf("rootio: no streamer for %q (no streamerinfo list)", name)
}
for _, si := range f.sinfos {
if si.Name() == name {
return si, nil
}
}
// no streamer for "name" in that file.
// try whether "name" isn't actually std::vector<T> and a streamer
// for T is in that file.
o := reStdVector.FindStringSubmatch(name)
if o != nil {
si := stdvecSIFrom(name, o[1], f)
if si != nil {
f.sinfos = append(f.sinfos, si)
streamers.add(si)
return si, nil
}
}
return nil, fmt.Errorf("rootio: no streamer for %q", name)
}
// Get returns the object identified by namecycle
// namecycle has the format name;cycle
// name = * is illegal, cycle = * is illegal
// cycle = "" or cycle = 9999 ==> apply to a memory object
//
// examples:
// foo : get object named foo in memory
// if object is not in memory, try with highest cycle from file
// foo;1 : get cycle 1 of foo on file
func (f *File) Get(namecycle string) (Object, error) {
return f.dir.Get(namecycle)
}
var (
_ Object = (*File)(nil)
_ Named = (*File)(nil)
_ Directory = (*File)(nil)
)