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
|
// Copyright 2020 NLP Odyssey 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 pytorch
import (
"archive/tar"
"archive/zip"
"errors"
"fmt"
"io"
"math/big"
"os"
"path"
"github.com/nlpodyssey/gopickle/pickle"
"github.com/nlpodyssey/gopickle/types"
)
const hexMagicNumber = "1950a86a20f9469cfc6c"
const protocolVersion = 1001
var ErrInvalidMagicNumber = errors.New("invalid pytorch magic number")
var ErrInvalidProtocolVersion = errors.New("invalid pytorch protocol version")
func Load(filename string) (interface{}, error) {
newUnpickler := func(r io.Reader) pickle.Unpickler {
return pickle.NewUnpickler(r)
}
return LoadWithUnpickler(filename, newUnpickler)
}
// LoadWithUnpickler is like Load, but it accepts a newUnpickler function which
// is used to create new customized pickle.Unpickler instances.
func LoadWithUnpickler(filename string, newUnpickler func(r io.Reader) pickle.Unpickler) (interface{}, error) {
if !isZipFile(filename) {
return loadLegacyFile(filename, newUnpickler)
}
return loadZipFile(filename, newUnpickler)
}
func loadZipFile(filename string, newUnpickler func(r io.Reader) pickle.Unpickler) (interface{}, error) {
// Open a zip archive for reading.
r, err := zip.OpenReader(filename)
if err != nil {
return nil, err
}
defer r.Close()
fileRecords := make(map[string]*zip.File, len(r.File))
for _, f := range r.File {
_, recordName := path.Split(f.Name)
fileRecords[recordName] = f
}
if _, isTorchScript := fileRecords["constants.pkl"]; isTorchScript {
return nil, fmt.Errorf("TorchScript is not supported")
}
dataFile, hasDataFile := fileRecords["data.pkl"]
if !hasDataFile {
return nil, fmt.Errorf("data.pkl not found in zip file")
}
df, err := dataFile.Open()
if err != nil {
return nil, err
}
defer df.Close()
loadedStorages := make(map[string]StorageInterface)
u := newUnpickler(df)
u.FindClass = makePickleFindClass(u.FindClass)
u.PersistentLoad = func(savedId interface{}) (interface{}, error) {
tuple, tupleOk := savedId.(*types.Tuple)
if !tupleOk || tuple.Len() == 0 {
return nil, fmt.Errorf("PersistentLoad: non-empty tuple expected, got %#v", savedId)
}
typename, typenameOk := tuple.Get(0).(string)
if !typenameOk {
return nil, fmt.Errorf("PersistentLoad: cannot get typename")
}
if typename != "storage" {
return nil, fmt.Errorf("unknown typename for PersistentLoad, expected 'storage' but got '%s'", typename)
}
if tuple.Len() < 5 {
return nil, fmt.Errorf("PersistentLoad: unexpected storage data length")
}
dataType, dataTypeOk := tuple.Get(1).(StorageClassInterface)
key, keyOk := tuple.Get(2).(string)
location, locationOk := tuple.Get(3).(string)
size, sizeOk := tuple.Get(4).(int)
if !dataTypeOk || !keyOk || !locationOk || !sizeOk {
return nil, fmt.Errorf("PersistentLoad: unexpected data types")
}
storage, storageExists := loadedStorages[key]
if !storageExists {
storage, err = loadTensor(dataType, size, location, key, fileRecords)
if err != nil {
return nil, err
}
loadedStorages[key] = storage
}
return storage, nil
}
return u.Load()
}
func loadTensor(
dataType StorageClassInterface,
size int,
location, key string,
zipFileRecords map[string]*zip.File,
) (StorageInterface, error) {
file, fileOk := zipFileRecords[key]
if !fileOk {
return nil, fmt.Errorf("cannot find zip record '%s'", key)
}
f, err := file.Open()
if err != nil {
return nil, err
}
defer f.Close()
storage := dataType.New(size, location)
err = storage.SetFromFileWithSize(f, size)
return storage, err
}
func loadLegacyFile(filename string, newUnpickler func(r io.Reader) pickle.Unpickler) (interface{}, error) {
f, err := os.Open(filename)
if err != nil {
return nil, err
}
defer f.Close()
tr := tar.NewReader(f)
for {
_, err := tr.Next()
switch err {
case nil:
// TODO: ...
panic("legacy load from tar not implemented")
case io.EOF:
break // End of archive
case tar.ErrHeader, io.ErrUnexpectedEOF:
_, err = f.Seek(0, io.SeekStart)
if err != nil {
return nil, err
}
return loadLegacyNoTar(f, newUnpickler)
default:
return nil, err
}
}
}
func loadLegacyNoTar(f *os.File, newUnpickler func(r io.Reader) pickle.Unpickler) (interface{}, error) {
if err := readAndCheckMagicNumber(f); err != nil {
return nil, err
}
if err := readAndChecProtocolVersion(f); err != nil {
return nil, err
}
if _, err := unpickle(f); err != nil { // sys info
return nil, err
}
deserializedObjects := make(map[string]StorageInterface)
u := newUnpickler(f)
u.FindClass = makePickleFindClass(u.FindClass)
u.PersistentLoad = func(savedId interface{}) (interface{}, error) {
tuple, tupleOk := savedId.(*types.Tuple)
if !tupleOk || tuple.Len() == 0 {
return nil, fmt.Errorf("PersistentLoad: non-empty tuple expected, got %#v", savedId)
}
typename, typenameOk := tuple.Get(0).(string)
if !typenameOk {
return nil, fmt.Errorf("PersistentLoad: cannot get typename")
}
switch typename {
case "storage":
if tuple.Len() < 6 {
return nil, fmt.Errorf(
"PersistentLoad: unexpected storage data length")
}
dataType, dataTypeOk := tuple.Get(1).(StorageClassInterface)
rootKey, rootKeyOk := tuple.Get(2).(string)
location, locationOk := tuple.Get(3).(string)
size, sizeOk := tuple.Get(4).(int)
viewMetadata := tuple.Get(5)
if !dataTypeOk || !rootKeyOk || !locationOk || !sizeOk {
return nil, fmt.Errorf("PersistentLoad: unexpected data types")
}
storage, storageExists := deserializedObjects[rootKey]
if !storageExists {
storage = dataType.New(size, location)
deserializedObjects[rootKey] = storage
}
switch vm := viewMetadata.(type) {
case nil:
return storage, nil
case []interface{}:
if len(vm) != 3 {
return nil, fmt.Errorf(
"PersistentLoad: unexpected view metadata length")
}
panic("viewMetadata not implemented")
// TODO: ...
// view_key, offset, view_size = view_metadata
// if view_key not in deserialized_objects:
// deserialized_objects[view_key] = storage[offset:offset + view_size]
// return deserialized_objects[view_key]
default:
return nil, fmt.Errorf("PersistentLoad: unexpected view metadata type")
}
case "module":
if tuple.Len() < 2 {
return nil, fmt.Errorf("PersistentLoad: unexpected module data length")
}
return tuple.Get(1), nil
default:
return nil, fmt.Errorf("Unexpected saved ID type: %s", typename)
}
}
result, err := u.Load()
if err != nil {
return nil, err
}
rawStorageKeys, err := unpickle(f)
if err != nil {
return nil, err
}
storageKeys, err := makeStorageKeys(rawStorageKeys)
if err != nil {
return nil, err
}
for _, key := range storageKeys {
storageObj, ok := deserializedObjects[key]
if !ok {
return nil, fmt.Errorf("storage object not found for key '%s'", key)
}
err = storageObj.SetFromFile(f)
if err != nil {
return nil, err
}
}
return result, nil
}
func makeStorageKeys(obj interface{}) ([]string, error) {
list, ok := obj.(*types.List)
if !ok {
return nil, fmt.Errorf("invalid storage keys data")
}
keys := make([]string, len(*list))
for i, rawKey := range *list {
key, keyOk := rawKey.(string)
if !keyOk {
return nil, fmt.Errorf("invalid storage key")
}
keys[i] = key
}
return keys, nil
}
func readAndCheckMagicNumber(r io.Reader) error {
obj, err := unpickle(r)
if err != nil {
return err
}
if n, ok := obj.(*big.Int); !ok || n.Text(16) != hexMagicNumber {
return ErrInvalidMagicNumber
}
return nil
}
func readAndChecProtocolVersion(r io.Reader) error {
obj, err := unpickle(r)
if err != nil {
return err
}
if n, ok := obj.(int); !ok || n != protocolVersion {
return ErrInvalidProtocolVersion
}
return nil
}
func unpickle(r io.Reader) (interface{}, error) {
u := pickle.NewUnpickler(r)
return u.Load()
}
func isZipFile(filename string) bool {
r, err := zip.OpenReader(filename)
if err != nil {
return false
}
r.Close()
return true
}
func makePickleFindClass(fallback func(module, name string) (interface{}, error)) func(module, name string) (interface{}, error) {
return func(module, name string) (interface{}, error) {
switch module + "." + name {
case "torch._utils._rebuild_tensor_v2":
return &RebuildTensorV2{}, nil
case "torch.FloatStorage":
return &FloatStorageClass{}, nil
case "torch.HalfStorage":
return &HalfStorageClass{}, nil
case "torch.DoubleStorage":
return &DoubleStorageClass{}, nil
case "torch.CharStorage":
return &CharStorageClass{}, nil
case "torch.ShortStorage":
return &ShortStorageClass{}, nil
case "torch.IntStorage":
return &IntStorageClass{}, nil
case "torch.LongStorage":
return &LongStorageClass{}, nil
case "torch.ByteStorage":
return &ByteStorageClass{}, nil
case "torch.BoolStorage":
return &BoolStorageClass{}, nil
case "torch.BFloat16Storage":
return &BFloat16StorageClass{}, nil
case "torch.nn.backends.thnn._get_thnn_function_backend":
// this is for historical pickle deserilaization, it is not used otherwise
return getThnnFunctionBackend{}, nil
default:
if fallback == nil {
return nil, fmt.Errorf("class not found: %s %s", module, name)
}
return fallback(module, name)
}
}
}
// getThnnFunctionBackend is for historical pickle deserilaization, it is not used otherwise
type getThnnFunctionBackend struct{}
var _ types.Callable = &getThnnFunctionBackend{}
func (getThnnFunctionBackend) Call(_ ...interface{}) (interface{}, error) {
return nil, nil
}
|