launch-cache/dsc_iterator.h

   1 /* -*- mode: C++; c-basic-offset: 4; tab-width: 4 -*-
   2  *
   3  * Copyright (c) 2009-2012 Apple Inc. All rights reserved.
   4  *
   5  * @APPLE_LICENSE_HEADER_START@
   6  *
   7  * This file contains Original Code and/or Modifications of Original Code
   8  * as defined in and that are subject to the Apple Public Source License
   9  * Version 2.0 (the 'License'). You may not use this file except in
  10  * compliance with the License. Please obtain a copy of the License at
  11  * http://www.opensource.apple.com/apsl/ and read it before using this
  12  * file.
  13  *
  14  * The Original Code and all software distributed under the License are
  15  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  16  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  17  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  19  * Please see the License for the specific language governing rights and
  20  * limitations under the License.
  21  *
  22  * @APPLE_LICENSE_HEADER_END@
  23  */
  24
  25 #include <stdint.h>
  26 #include <uuid/uuid.h>
  27
  28 struct dyld_shared_cache_dylib_info {
  29         uint32_t                version;                // current version 2
  30         // following fields all exist in version 1
  31         uint32_t                isAlias;                // this is alternate path (symlink)
  32         const void*             machHeader;             // of dylib in mapped cached file
  33         const char*             path;                   // of dylib
  34         const uuid_t*   uuid;                   // of dylib, or NULL is missing
  35         // following fields all exist in version 2
  36         uint64_t                inode;                  // of dylib file or path hash
  37         uint64_t                modTime;                // of dylib file
  38 };
  39 typedef struct dyld_shared_cache_dylib_info dyld_shared_cache_dylib_info;
  40
  41 struct dyld_shared_cache_segment_info {
  42         uint64_t                version;                // initial version 1
  43         // following fields exist in version 1
  44         const char*             name;                   // of segment
  45         uint64_t                fileOffset;             // of segment in cache file
  46         uint64_t                fileSize;               // of segment
  47         uint64_t                address;                // of segment when cache mapped with ASLR (sliding) off
  48     // following fields exist in version 2
  49         uint64_t                addressOffset;  // of segment from base of mapped cache
  50 };
  51 typedef struct dyld_shared_cache_segment_info dyld_shared_cache_segment_info;
  52
  53
  54 #ifdef __cplusplus
  55 extern "C" {
  56 #endif
  57
  58
  59 // Given a pointer and size of an in-memory copy of a dyld shared cache file,
  60 // this routine will call the callback block once for each segment in each dylib
  61 // in the shared cache file.
  62 // Returns -1 if there was an error, otherwise 0.
  63 extern int dyld_shared_cache_iterate(const void* shared_cache_file, uint32_t shared_cache_size,
  64                                                                         void (^callback)(const dyld_shared_cache_dylib_info* dylibInfo, const dyld_shared_cache_segment_info* segInfo));
  65
  66
  67
  68 //
  69 // The following iterator functions are deprecated:
  70 //
  71 typedef void (^dyld_shared_cache_iterator_t)(const char* dylibName, const char* segName, uint64_t offset, uint64_t size, uint64_t mappedddress);
  72 typedef void (^dyld_shared_cache_iterator_slide_t)(const char* dylibName, const char* segName, uint64_t offset, uint64_t size, uint64_t mappedddress, uint64_t slide);
  73 typedef void (*dyld_shared_cache_iterator_nb_t)(const char* dylibName, const char* segName, uint64_t offset, uint64_t sizem, uint64_t mappedddress, void* userData);
  74 typedef void (*dyld_shared_cache_iterator_slide_nb_t)(const char* dylibName, const char* segName, uint64_t offset, uint64_t sizem, uint64_t mappedddress, uint64_t slide, void* userData);
  75
  76 extern int dyld_shared_cache_iterate_segments(const void* shared_cache_file, dyld_shared_cache_iterator_t callback) __attribute__((deprecated));
  77 extern int dyld_shared_cache_iterate_segments_with_slide(const void* shared_cache_file, dyld_shared_cache_iterator_slide_t callback) __attribute__((deprecated));
  78 extern int dyld_shared_cache_iterate_segments_nb(const void* shared_cache_file, dyld_shared_cache_iterator_nb_t callback, void* userData) __attribute__((deprecated));
  79 extern int dyld_shared_cache_iterate_segments_with_slide_nb(const void* shared_cache_file, dyld_shared_cache_iterator_slide_nb_t callback, void* userData) __attribute__((deprecated));
  80
  81
  82 #ifdef __cplusplus
  83 }
  84 #endif