storage.h

Go to the documentation of this file.

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
 
#ifndef MXNET_STORAGE_H_
#define MXNET_STORAGE_H_
 
#include <memory>
#include <string>
#include <vector>
#include "./base.h"
 
namespace mxnet {
 
#define MXNET_STORAGE_DEFAULT_PROFILER_SCOPE_CSTR "<unk>:"
#define MXNET_STORAGE_DEFAULT_NAME_CSTR           "unknown"
 
class Storage {
 public:
  struct SyncObj {
#if MXNET_USE_CUDA
 
    std::vector<std::weak_ptr<cudaEvent_t>> events;
#endif
  };
  struct Handle {
    void* dptr{nullptr};
    size_t size{0};
    Context ctx;
    int shared_pid{-1};
    int shared_id{-1};
    std::string profiler_scope{MXNET_STORAGE_DEFAULT_PROFILER_SCOPE_CSTR};
    std::string name{MXNET_STORAGE_DEFAULT_NAME_CSTR};
    SyncObj sync_obj;
  };
  Handle Alloc(size_t size, Context ctx, bool failsafe = false) {
    Handle hd;
    hd.size = size;
    hd.ctx  = ctx;
    this->Alloc(&hd, failsafe);
    return hd;
  }
  virtual void Alloc(Handle* handle, bool failsafe = false) = 0;
  virtual void SharedIncrementRefCount(Handle handle) = 0;
  virtual void Free(Handle handle) = 0;
  virtual void DirectFree(Handle handle) = 0;
  virtual void ReleaseAll(Context ctx) = 0;
  virtual ~Storage() {}
  std::mutex& GetMutex(Context::DeviceType dev) {
    if (dev == Context::kCPU) {
      return cpu_mutex_;
    } else {
      return gpu_mutex_;
    }
  }
  static Storage* Get();
  static const std::shared_ptr<Storage>& _GetSharedRef();
 
 private:
  std::mutex cpu_mutex_;
  std::mutex gpu_mutex_;
};  // class Storage
}  // namespace mxnet
#endif  // MXNET_STORAGE_H_