forked from NVIDIA/aistore
/
metafile.go
219 lines (201 loc) · 6.3 KB
/
metafile.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
// Package ec provides erasure coding (EC) based data protection for AIStore.
/*
* Copyright (c) 2018-2023, NVIDIA CORPORATION. All rights reserved.
*/
package ec
import (
"fmt"
"io"
"os"
"github.com/OneOfOne/xxhash"
"github.com/artashesbalabekyan/aistore/cluster"
"github.com/artashesbalabekyan/aistore/cluster/meta"
"github.com/artashesbalabekyan/aistore/cmn/cos"
"github.com/artashesbalabekyan/aistore/fs"
)
const MDVersionLast = 1 // current version of metadata
// Metadata - EC information stored in metafiles for every encoded object
type Metadata struct {
Size int64 `json:"obj_size"` // obj size (after EC'ing sum size of slices differs from the original)
Generation int64 `json:"generation"` // Timestamp when the object was EC'ed
ObjCksum string `json:"obj_cksum"` // checksum of the original object
ObjVersion string `json:"obj_version"` // object version
CksumType string `json:"cksum_type"` // slice checksum type
CksumValue string `json:"slice_cksum"` // slice checksum of the slice if EC is used
FullReplica string `json:"replica_node"` // daemon ID where full(main) replica is
Daemons cos.MapStrUint16 `json:"nodes"` // Locations of all slices: DaemonID <-> SliceID
Data int `json:"data_slices"` // the number of data slices
Parity int `json:"parity_slices"` // the number of parity slices
SliceID int `json:"slice_id"` // 0 for full replica, 1 to N for slices
MDVersion uint32 `json:"md_version"` // Metadata format version
IsCopy bool `json:"is_copy"` // object is replicated(true) or encoded(false)
}
// interface guard
var (
_ cos.Unpacker = (*Metadata)(nil)
_ cos.Packer = (*Metadata)(nil)
)
func NewMetadata() *Metadata {
return &Metadata{MDVersion: MDVersionLast}
}
// LoadMetadata loads and parses EC metadata from a file
func LoadMetadata(fqn string) (*Metadata, error) {
b, err := os.ReadFile(fqn)
if err != nil {
return nil, err
}
md := &Metadata{}
unpacker := cos.NewUnpacker(b)
if err := unpacker.ReadAny(md); err != nil {
err := fmt.Errorf("damaged metafile %q: %v", fqn, err)
return nil, err
}
return md, nil
}
func MetaFromReader(reader io.Reader) (*Metadata, error) {
b, err := io.ReadAll(reader)
if err != nil {
return nil, err
}
md := &Metadata{}
unpacker := cos.NewUnpacker(b)
err = unpacker.ReadAny(md)
return md, err
}
// RemoteTargets returns list of Snodes that contain a slice or replica.
// This target(`t`) is removed from the list.
func (md *Metadata) RemoteTargets(t cluster.Target) []*meta.Snode {
if len(md.Daemons) == 0 {
return nil
}
nodes := make([]*meta.Snode, 0, len(md.Daemons))
smap := t.Sowner().Get()
for tid := range md.Daemons {
if tid == t.SID() {
continue
}
tsi := smap.GetTarget(tid)
if tsi != nil {
nodes = append(nodes, tsi)
}
}
return nodes
}
// Do not use MM.SGL for a byte buffer: as the buffer is sent via
// HTTP, it can result in hard to debug errors when SGL is freed.
// For details: https://gitlab-master.nvidia.com/aistorage/aistore/issues/472#note_4212419
func (md *Metadata) NewPack() []byte {
var (
buf []byte
l = md.PackedSize()
)
packer := cos.NewPacker(buf, l)
packer.WriteAny(md)
return packer.Bytes()
}
func (md *Metadata) Clone() *Metadata {
clone := &Metadata{}
cos.CopyStruct(clone, md)
return clone
}
// ObjectMetadata returns metadata for an object or its slice if any exists
func ObjectMetadata(bck *meta.Bck, objName string) (*Metadata, error) {
fqn, _, err := cluster.HrwFQN(bck.Bucket(), fs.ECMetaType, objName)
if err != nil {
return nil, err
}
return LoadMetadata(fqn)
}
func (md *Metadata) Unpack(unpacker *cos.ByteUnpack) (err error) {
var cksum uint64
if md.MDVersion, err = unpacker.ReadUint32(); err != nil {
return
}
switch md.MDVersion {
case MDVersionLast:
err = md.unpackLastVersion(unpacker)
default:
err = fmt.Errorf("unsupported metadata format version %d. Only %d supported",
md.MDVersion, MDVersionLast)
}
if err != nil {
return
}
if cksum, err = unpacker.ReadUint64(); err != nil {
return
}
b := unpacker.Bytes()
calcCksum := xxhash.Checksum64S(b[:len(b)-cos.SizeofI64], cos.MLCG32)
if cksum != calcCksum {
err = cos.NewErrMetaCksum(cksum, calcCksum, "EC metadata")
}
return err
}
func (md *Metadata) unpackLastVersion(unpacker *cos.ByteUnpack) (err error) {
var i16 uint16
if md.Generation, err = unpacker.ReadInt64(); err != nil {
return
}
if md.Size, err = unpacker.ReadInt64(); err != nil {
return
}
if i16, err = unpacker.ReadUint16(); err != nil {
return
}
md.Data = int(i16)
if i16, err = unpacker.ReadUint16(); err != nil {
return
}
md.Parity = int(i16)
if i16, err = unpacker.ReadUint16(); err != nil {
return
}
md.SliceID = int(i16)
if md.IsCopy, err = unpacker.ReadBool(); err != nil {
return
}
if md.FullReplica, err = unpacker.ReadString(); err != nil {
return
}
if md.ObjCksum, err = unpacker.ReadString(); err != nil {
return
}
if md.ObjVersion, err = unpacker.ReadString(); err != nil {
return
}
if md.CksumType, err = unpacker.ReadString(); err != nil {
return
}
if md.CksumValue, err = unpacker.ReadString(); err != nil {
return
}
md.Daemons, err = unpacker.ReadMapStrUint16()
return
}
func (md *Metadata) Pack(packer *cos.BytePack) {
packer.WriteUint32(md.MDVersion)
packer.WriteInt64(md.Generation)
packer.WriteInt64(md.Size)
packer.WriteUint16(uint16(md.Data))
packer.WriteUint16(uint16(md.Parity))
packer.WriteUint16(uint16(md.SliceID))
packer.WriteBool(md.IsCopy)
packer.WriteString(md.FullReplica)
packer.WriteString(md.ObjCksum)
packer.WriteString(md.ObjVersion)
packer.WriteString(md.CksumType)
packer.WriteString(md.CksumValue)
packer.WriteMapStrUint16(md.Daemons)
h := xxhash.Checksum64S(packer.Bytes(), cos.MLCG32)
packer.WriteUint64(h)
}
func (md *Metadata) PackedSize() int {
daemonListSz := cos.SizeofLen
for k := range md.Daemons {
daemonListSz += cos.PackedStrLen(k) + cos.SizeofI16
}
return cos.SizeofI32 + cos.SizeofI64*2 + cos.SizeofI16*3 + 1 /*isCopy*/ +
cos.PackedStrLen(md.ObjCksum) + cos.PackedStrLen(md.ObjVersion) +
cos.PackedStrLen(md.CksumType) + cos.PackedStrLen(md.CksumValue) +
cos.PackedStrLen(md.FullReplica) + daemonListSz + cos.SizeofI64 /*md cksum*/
}