dyld3/ClosureFileSystem.h

   1 /*
   2  * Copyright (c) 2017 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24 #ifndef ClosureFileSystem_h
  25 #define ClosureFileSystem_h
  26
  27 // For MAXPATHLEN
  28 #include <sys/param.h>
  29 // For va_list
  30 #include <stdarg.h>
  31 // For uint64_t
  32 #include <stdint.h>
  33
  34 namespace dyld3 {
  35 namespace closure {
  36
  37 struct LoadedFileInfo {
  38     const void*  fileContent                = nullptr;
  39     uint64_t     fileContentLen             = 0;
  40     uint64_t     sliceOffset                = 0;
  41     uint64_t     sliceLen            : 63,
  42                  isOSBinary          : 1;
  43     uint64_t     inode                      = 0;
  44     uint64_t     mtime                      = 0;
  45     void (*unload)(const LoadedFileInfo&)   = nullptr;
  46     const char*  path                       = nullptr;
  47 };
  48
  49 #pragma clang diagnostic push
  50 #pragma clang diagnostic ignored "-Wnon-virtual-dtor"
  51 class FileSystem {
  52 protected:
  53     FileSystem() { }
  54
  55 public:
  56
  57     // Get the real path for a given path, if it exists.
  58     // Returns true if the real path was found and updates the given buffer iff that is the case
  59     virtual bool getRealPath(const char possiblePath[MAXPATHLEN], char realPath[MAXPATHLEN]) const = 0;
  60
  61     // Returns true on success.  If an error occurs the given callback will be called with the reason.
  62     // On success, info is filled with info about the loaded file.  If the path supplied includes a symlink,
  63     // the supplier realerPath is filled in with the real path of the file, otherwise it is set to the empty string.
  64     virtual bool loadFile(const char* path, LoadedFileInfo& info, char realerPath[MAXPATHLEN], void (^error)(const char* format, ...)) const = 0;
  65
  66     // Frees the buffer allocated by loadFile()
  67     virtual void unloadFile(const LoadedFileInfo& info) const = 0;
  68
  69     // Frees all but the requested range and adjusts info to new buffer location
  70     // Remaining buffer can be freed later with unloadFile()
  71     virtual void unloadPartialFile(LoadedFileInfo& info, uint64_t keepStartOffset, uint64_t keepLength) const = 0;
  72
  73     // If a file exists at path, returns true and sets inode and mtime
  74     virtual bool fileExists(const char* path, uint64_t* inode=nullptr, uint64_t* mtime=nullptr,
  75                             bool* issetuid=nullptr, bool* inodesMatchRuntime = nullptr) const = 0;
  76 };
  77 #pragma clang diagnostic pop
  78
  79 } //  namespace closure
  80 } //  namespace dyld3
  81
  82 #endif /* ClosureFileSystem_h */