llvm/Support/BuryPointer.h

0001 //===- llvm/Support/BuryPointer.h - Memory Manipulation/Leak ----*- C++ -*-===//
0002 //
0003 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
0004 // See https://llvm.org/LICENSE.txt for license information.
0005 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
0006 //
0007 //===----------------------------------------------------------------------===//
0008
0009 #ifndef LLVM_SUPPORT_BURYPOINTER_H
0010 #define LLVM_SUPPORT_BURYPOINTER_H
0011
0012 #include <memory>
0013
0014 namespace llvm {
0015
0016 // In tools that will exit soon anyway, going through the process of explicitly
0017 // deallocating resources can be unnecessary - better to leak the resources and
0018 // let the OS clean them up when the process ends. Use this function to ensure
0019 // the memory is not misdiagnosed as an unintentional leak by leak detection
0020 // tools (this is achieved by preserving pointers to the object in a globally
0021 // visible array).
0022 void BuryPointer(const void *Ptr);
0023 template <typename T> void BuryPointer(std::unique_ptr<T> Ptr) {
0024   BuryPointer(Ptr.release());
0025 }
0026
0027 } // namespace llvm
0028
0029 #endif