image.h revision bdf7f1c3ab65ccb70f62db5ab31dba060632d458 
1/*
2 * Copyright (C) 2011 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#ifndef ART_RUNTIME_IMAGE_H_
18#define ART_RUNTIME_IMAGE_H_
19
20#include <string.h>
21
22#include "base/enums.h"
23#include "globals.h"
24#include "mirror/object.h"
25
26namespace art {
27
28class ArtField;
29class ArtMethod;
30
31class ArtMethodVisitor {
32 public:
33  virtual ~ArtMethodVisitor() {}
34
35  virtual void Visit(ArtMethod* method) = 0;
36};
37
38class ArtFieldVisitor {
39 public:
40  virtual ~ArtFieldVisitor() {}
41
42  virtual void Visit(ArtField* method) = 0;
43};
44
45class PACKED(4) ImageSection {
46 public:
47  ImageSection() : offset_(0), size_(0) { }
48  ImageSection(uint32_t offset, uint32_t size) : offset_(offset), size_(size) { }
49  ImageSection(const ImageSection& section) = default;
50  ImageSection& operator=(const ImageSection& section) = default;
51
52  uint32_t Offset() const {
53    return offset_;
54  }
55
56  uint32_t Size() const {
57    return size_;
58  }
59
60  uint32_t End() const {
61    return Offset() + Size();
62  }
63
64  bool Contains(uint64_t offset) const {
65    return offset - offset_ < size_;
66  }
67
68 private:
69  uint32_t offset_;
70  uint32_t size_;
71};
72
73// header of image files written by ImageWriter, read and validated by Space.
74class PACKED(4) ImageHeader {
75 public:
76  enum StorageMode : uint32_t {
77    kStorageModeUncompressed,
78    kStorageModeLZ4,
79    kStorageModeLZ4HC,
80    kStorageModeCount,  // Number of elements in enum.
81  };
82  static constexpr StorageMode kDefaultStorageMode = kStorageModeUncompressed;
83
84  ImageHeader()
85      : image_begin_(0U),
86        image_size_(0U),
87        oat_checksum_(0U),
88        oat_file_begin_(0U),
89        oat_data_begin_(0U),
90        oat_data_end_(0U),
91        oat_file_end_(0U),
92        boot_image_begin_(0U),
93        boot_image_size_(0U),
94        boot_oat_begin_(0U),
95        boot_oat_size_(0U),
96        patch_delta_(0),
97        image_roots_(0U),
98        pointer_size_(0U),
99        compile_pic_(0),
100        is_pic_(0),
101        storage_mode_(kDefaultStorageMode),
102        data_size_(0) {}
103
104  ImageHeader(uint32_t image_begin,
105              uint32_t image_size,
106              ImageSection* sections,
107              uint32_t image_roots,
108              uint32_t oat_checksum,
109              uint32_t oat_file_begin,
110              uint32_t oat_data_begin,
111              uint32_t oat_data_end,
112              uint32_t oat_file_end,
113              uint32_t boot_image_begin,
114              uint32_t boot_image_size,
115              uint32_t boot_oat_begin,
116              uint32_t boot_oat_size,
117              uint32_t pointer_size,
118              bool compile_pic,
119              bool is_pic,
120              StorageMode storage_mode,
121              size_t data_size);
122
123  bool IsValid() const;
124  const char* GetMagic() const;
125
126  uint8_t* GetImageBegin() const {
127    return reinterpret_cast<uint8_t*>(image_begin_);
128  }
129
130  size_t GetImageSize() const {
131    return static_cast<uint32_t>(image_size_);
132  }
133
134  uint32_t GetOatChecksum() const {
135    return oat_checksum_;
136  }
137
138  void SetOatChecksum(uint32_t oat_checksum) {
139    oat_checksum_ = oat_checksum;
140  }
141
142  // The location that the oat file was expected to be when the image was created. The actual
143  // oat file may be at a different location for application images.
144  uint8_t* GetOatFileBegin() const {
145    return reinterpret_cast<uint8_t*>(oat_file_begin_);
146  }
147
148  uint8_t* GetOatDataBegin() const {
149    return reinterpret_cast<uint8_t*>(oat_data_begin_);
150  }
151
152  uint8_t* GetOatDataEnd() const {
153    return reinterpret_cast<uint8_t*>(oat_data_end_);
154  }
155
156  uint8_t* GetOatFileEnd() const {
157    return reinterpret_cast<uint8_t*>(oat_file_end_);
158  }
159
160  PointerSize GetPointerSize() const {
161    return ConvertToPointerSize(pointer_size_);
162  }
163
164  uint32_t GetPointerSizeUnchecked() const {
165    return pointer_size_;
166  }
167
168  off_t GetPatchDelta() const {
169    return patch_delta_;
170  }
171
172  static std::string GetOatLocationFromImageLocation(const std::string& image) {
173    std::string oat_filename = image;
174    if (oat_filename.length() <= 3) {
175      oat_filename += ".oat";
176    } else {
177      oat_filename.replace(oat_filename.length() - 3, 3, "oat");
178    }
179    return oat_filename;
180  }
181
182  enum ImageMethod {
183    kResolutionMethod,
184    kImtConflictMethod,
185    kImtUnimplementedMethod,
186    kSaveAllCalleeSavesMethod,
187    kSaveRefsOnlyMethod,
188    kSaveRefsAndArgsMethod,
189    kSaveEverythingMethod,
190    kImageMethodsCount,  // Number of elements in enum.
191  };
192
193  enum ImageRoot {
194    kDexCaches,
195    kClassRoots,
196    kImageRootsMax,
197  };
198
199  enum ImageSections {
200    kSectionObjects,
201    kSectionArtFields,
202    kSectionArtMethods,
203    kSectionRuntimeMethods,
204    kSectionImTables,
205    kSectionIMTConflictTables,
206    kSectionDexCacheArrays,
207    kSectionInternedStrings,
208    kSectionClassTable,
209    kSectionImageBitmap,
210    kSectionCount,  // Number of elements in enum.
211  };
212
213  ArtMethod* GetImageMethod(ImageMethod index) const;
214  void SetImageMethod(ImageMethod index, ArtMethod* method);
215
216  const ImageSection& GetImageSection(ImageSections index) const;
217
218  const ImageSection& GetMethodsSection() const {
219    return GetImageSection(kSectionArtMethods);
220  }
221
222  const ImageSection& GetRuntimeMethodsSection() const {
223    return GetImageSection(kSectionRuntimeMethods);
224  }
225
226  const ImageSection& GetFieldsSection() const {
227    return GetImageSection(ImageHeader::kSectionArtFields);
228  }
229
230  template <ReadBarrierOption kReadBarrierOption = kWithReadBarrier>
231  mirror::Object* GetImageRoot(ImageRoot image_root) const
232      REQUIRES_SHARED(Locks::mutator_lock_);
233
234  template <ReadBarrierOption kReadBarrierOption = kWithReadBarrier>
235  mirror::ObjectArray<mirror::Object>* GetImageRoots() const
236      REQUIRES_SHARED(Locks::mutator_lock_);
237
238  void RelocateImage(off_t delta);
239  void RelocateImageMethods(off_t delta);
240  void RelocateImageObjects(off_t delta);
241
242  bool CompilePic() const {
243    return compile_pic_ != 0;
244  }
245
246  bool IsPic() const {
247    return is_pic_ != 0;
248  }
249
250  uint32_t GetBootImageBegin() const {
251    return boot_image_begin_;
252  }
253
254  uint32_t GetBootImageSize() const {
255    return boot_image_size_;
256  }
257
258  uint32_t GetBootOatBegin() const {
259    return boot_oat_begin_;
260  }
261
262  uint32_t GetBootOatSize() const {
263    return boot_oat_size_;
264  }
265
266  StorageMode GetStorageMode() const {
267    return storage_mode_;
268  }
269
270  uint64_t GetDataSize() const {
271    return data_size_;
272  }
273
274  bool IsAppImage() const {
275    // App images currently require a boot image, if the size is non zero then it is an app image
276    // header.
277    return boot_image_size_ != 0u;
278  }
279
280  // Visit ArtMethods in the section starting at base. Includes runtime methods.
281  // TODO: Delete base parameter if it is always equal to GetImageBegin.
282  void VisitPackedArtMethods(ArtMethodVisitor* visitor,
283                             uint8_t* base,
284                             PointerSize pointer_size) const;
285
286  // Visit ArtMethods in the section starting at base.
287  // TODO: Delete base parameter if it is always equal to GetImageBegin.
288  void VisitPackedArtFields(ArtFieldVisitor* visitor, uint8_t* base) const;
289
290  template <typename Visitor>
291  void VisitPackedImTables(const Visitor& visitor,
292                           uint8_t* base,
293                           PointerSize pointer_size) const;
294
295  template <typename Visitor>
296  void VisitPackedImtConflictTables(const Visitor& visitor,
297                                    uint8_t* base,
298                                    PointerSize pointer_size) const;
299
300 private:
301  static const uint8_t kImageMagic[4];
302  static const uint8_t kImageVersion[4];
303
304  uint8_t magic_[4];
305  uint8_t version_[4];
306
307  // Required base address for mapping the image.
308  uint32_t image_begin_;
309
310  // Image size, not page aligned.
311  uint32_t image_size_;
312
313  // Checksum of the oat file we link to for load time sanity check.
314  uint32_t oat_checksum_;
315
316  // Start address for oat file. Will be before oat_data_begin_ for .so files.
317  uint32_t oat_file_begin_;
318
319  // Required oat address expected by image Method::GetCode() pointers.
320  uint32_t oat_data_begin_;
321
322  // End of oat data address range for this image file.
323  uint32_t oat_data_end_;
324
325  // End of oat file address range. will be after oat_data_end_ for
326  // .so files. Used for positioning a following alloc spaces.
327  uint32_t oat_file_end_;
328
329  // Boot image begin and end (app image headers only).
330  uint32_t boot_image_begin_;
331  uint32_t boot_image_size_;
332
333  // Boot oat begin and end (app image headers only).
334  uint32_t boot_oat_begin_;
335  uint32_t boot_oat_size_;
336
337  // TODO: We should probably insert a boot image checksum for app images.
338
339  // The total delta that this image has been patched.
340  int32_t patch_delta_;
341
342  // Absolute address of an Object[] of objects needed to reinitialize from an image.
343  uint32_t image_roots_;
344
345  // Pointer size, this affects the size of the ArtMethods.
346  uint32_t pointer_size_;
347
348  // Boolean (0 or 1) to denote if the image was compiled with --compile-pic option
349  const uint32_t compile_pic_;
350
351  // Boolean (0 or 1) to denote if the image can be mapped at a random address, this only refers to
352  // the .art file. Currently, app oat files do not depend on their app image. There are no pointers
353  // from the app oat code to the app image.
354  const uint32_t is_pic_;
355
356  // Image section sizes/offsets correspond to the uncompressed form.
357  ImageSection sections_[kSectionCount];
358
359  // Image methods, may be inside of the boot image for app images.
360  uint64_t image_methods_[kImageMethodsCount];
361
362  // Storage method for the image, the image may be compressed.
363  StorageMode storage_mode_;
364
365  // Data size for the image data excluding the bitmap and the header. For compressed images, this
366  // is the compressed size in the file.
367  uint32_t data_size_;
368
369  friend class ImageWriter;
370};
371
372std::ostream& operator<<(std::ostream& os, const ImageHeader::ImageMethod& policy);
373std::ostream& operator<<(std::ostream& os, const ImageHeader::ImageRoot& policy);
374std::ostream& operator<<(std::ostream& os, const ImageHeader::ImageSections& section);
375std::ostream& operator<<(std::ostream& os, const ImageSection& section);
376std::ostream& operator<<(std::ostream& os, const ImageHeader::StorageMode& mode);
377
378}  // namespace art
379
380#endif  // ART_RUNTIME_IMAGE_H_
381