contrib/llvm/include/llvm/LTO/Caching.h

   1 //===- Caching.h - LLVM Link Time Optimizer Configuration -----------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines the localCache function, which allows clients to add a
  11 // filesystem cache to ThinLTO.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_LTO_CACHING_H
  16 #define LLVM_LTO_CACHING_H
  17
  18 #include "llvm/LTO/LTO.h"
  19 #include <string>
  20
  21 namespace llvm {
  22 namespace lto {
  23
  24 /// This type defines the callback to add a pre-existing native object file
  25 /// (e.g. in a cache).
  26 ///
  27 /// MB->getBufferIdentifier() is a valid path for the file at the time that it
  28 /// was opened, but clients should prefer to access MB directly in order to
  29 /// avoid a potential race condition.
  30 ///
  31 /// Buffer callbacks must be thread safe.
  32 typedef std::function<void(unsigned Task, std::unique_ptr<MemoryBuffer> MB)>
  33     AddBufferFn;
  34
  35 /// Create a local file system cache which uses the given cache directory and
  36 /// file callback. This function also creates the cache directory if it does not
  37 /// already exist.
  38 Expected<NativeObjectCache> localCache(StringRef CacheDirectoryPath,
  39                                        AddBufferFn AddBuffer);
  40
  41 } // namespace lto
  42 } // namespace llvm
  43
  44 #endif