1 /*
2  * Copyright (C) 2018 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  * Header file of an in-memory representation of DEX files.
17  */
18 
19 #ifndef ART_DEXLAYOUT_DEX_CONTAINER_H_
20 #define ART_DEXLAYOUT_DEX_CONTAINER_H_
21 
22 #include <vector>
23 
24 namespace art {
25 
26 // Dex container holds the artifacts produced by dexlayout and contains up to two sections: a main
27 // section and a data section.
28 // This container may also hold metadata used for multi dex deduplication in the future.
29 class DexContainer {
30  public:
~DexContainer()31   virtual ~DexContainer() {}
32 
33   class Section {
34    public:
~Section()35     virtual ~Section() {}
36 
37     // Returns the start of the memory region.
38     virtual uint8_t* Begin() = 0;
39 
40     // Size in bytes.
41     virtual size_t Size() const = 0;
42 
43     // Resize the backing storage.
44     virtual void Resize(size_t size) = 0;
45 
46     // Clear the container.
47     virtual void Clear() = 0;
48 
49     // Returns the end of the memory region.
End()50     uint8_t* End() {
51       return Begin() + Size();
52     }
53   };
54 
55   // Vector backed section.
56   class VectorSection : public Section {
57    public:
~VectorSection()58     virtual ~VectorSection() {}
59 
Begin()60     uint8_t* Begin() override {
61       return &data_[0];
62     }
63 
Size()64     size_t Size() const override {
65       return data_.size();
66     }
67 
Resize(size_t size)68     void Resize(size_t size) override {
69       data_.resize(size, 0u);
70     }
71 
Clear()72     void Clear() override {
73       data_.clear();
74     }
75 
76    private:
77     std::vector<uint8_t> data_;
78   };
79 
80   virtual Section* GetMainSection() = 0;
81   virtual Section* GetDataSection() = 0;
82   virtual bool IsCompactDexContainer() const = 0;
83 };
84 
85 }  // namespace art
86 
87 #endif  // ART_DEXLAYOUT_DEX_CONTAINER_H_
88