image_space.h revision 8d31bbd3d6536de12bc20e3d29cfe03fe848f9da 
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_GC_SPACE_IMAGE_SPACE_H_
18#define ART_RUNTIME_GC_SPACE_IMAGE_SPACE_H_
19
20#include "space.h"
21
22namespace art {
23
24class OatFile;
25
26namespace gc {
27namespace space {
28
29// An image space is a space backed with a memory mapped image.
30class ImageSpace : public MemMapSpace {
31 public:
32  bool CanAllocateInto() const {
33    return false;
34  }
35
36  SpaceType GetType() const {
37    return kSpaceTypeImageSpace;
38  }
39
40  // Create a Space from an image file. Cannot be used for future
41  // allocation or collected.
42  //
43  // Create also opens the OatFile associated with the image file so
44  // that it be contiguously allocated with the image before the
45  // creation of the alloc space. The ReleaseOatFile will later be
46  // used to transfer ownership of the OatFile to the ClassLinker when
47  // it is initialized.
48  static ImageSpace* Create(const char* image) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
49
50  // Releases the OatFile from the ImageSpace so it can be transfer to
51  // the caller, presumably the ClassLinker.
52  OatFile* ReleaseOatFile()
53      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
54
55  void VerifyImageAllocations()
56      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
57
58  const ImageHeader& GetImageHeader() const {
59    return *reinterpret_cast<ImageHeader*>(Begin());
60  }
61
62  const std::string GetImageFilename() const {
63    return GetName();
64  }
65
66  accounting::SpaceBitmap* GetLiveBitmap() const {
67    return live_bitmap_.get();
68  }
69
70  accounting::SpaceBitmap* GetMarkBitmap() const {
71    // ImageSpaces have the same bitmap for both live and marked. This helps reduce the number of
72    // special cases to test against.
73    return live_bitmap_.get();
74  }
75
76  void Dump(std::ostream& os) const;
77
78 private:
79  // Tries to initialize an ImageSpace from the given image path,
80  // returning NULL on error.
81  //
82  // If validate_oat_file is false (for /system), do not verify that
83  // image's OatFile is up-to-date relative to its DexFile
84  // inputs. Otherwise (for /data), validate the inputs and generate
85  // the OatFile in /data/dalvik-cache if necessary.
86  static ImageSpace* Init(const char* image, bool validate_oat_file, std::string* error_msg)
87      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
88
89  OatFile* OpenOatFile(std::string* error_msg) const
90      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
91
92  bool ValidateOatFile(std::string* error_msg) const
93      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_);
94
95  friend class Space;
96
97  static AtomicInteger bitmap_index_;
98
99  UniquePtr<accounting::SpaceBitmap> live_bitmap_;
100
101  ImageSpace(const std::string& name, MemMap* mem_map, accounting::SpaceBitmap* live_bitmap);
102
103  // The OatFile associated with the image during early startup to
104  // reserve space contiguous to the image. It is later released to
105  // the ClassLinker during it's initialization.
106  UniquePtr<OatFile> oat_file_;
107
108  DISALLOW_COPY_AND_ASSIGN(ImageSpace);
109};
110
111}  // namespace space
112}  // namespace gc
113}  // namespace art
114
115#endif  // ART_RUNTIME_GC_SPACE_IMAGE_SPACE_H_
116