checked_alloc.h

Go to the documentation of this file.

/*
 * Copyright 2022 HEAVY.AI, Inc.
 *
 * Licensed 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 CHECKED_ALLOC_H
#define CHECKED_ALLOC_H

#define BOOST_STACKTRACE_GNU_SOURCE_NOT_REQUIRED 1

#include "Shared/boost_stacktrace.hpp"

#include <cstdlib>
#include <ostream>
#include <stdexcept>
#include <string>
#include "../Logger/Logger.h"
#include "../Shared/types.h"

class OutOfHostMemory : public std::bad_alloc {
 public:
  OutOfHostMemory(const size_t size)
      : what_str_("Not enough CPU memory available to allocate " + std::to_string(size)) {
    VLOG(1) << "Failed to allocate " << size << " bytes\n"
            << boost::stacktrace::stacktrace();
  }

  const char* what() const noexcept final { return what_str_.c_str(); }

 private:
  const std::string what_str_;
};

inline void* checked_malloc(const size_t size) {
  auto ptr = malloc(size);
  if (!ptr) {
    throw OutOfHostMemory(size);
  }
  return ptr;
}

inline void* checked_calloc(const size_t nmemb, const size_t size) {
  auto ptr = calloc(nmemb, size);
  if (!ptr) {
    throw OutOfHostMemory(nmemb * size);
  }
  return ptr;
}

struct CheckedAllocDeleter {
  void operator()(void* p) { free(p); }
};

#endif  // CHECKED_ALLOC_H