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_LIBARTBASE_BASE_FILE_UTILS_H_
18 #define ART_LIBARTBASE_BASE_FILE_UTILS_H_
19
20 #include <stdlib.h>
21
22 #include <string>
23 #include <string_view>
24
25 #include <android-base/logging.h>
26
27 #include "arch/instruction_set.h"
28
29 namespace art {
30
31 static constexpr const char kAndroidArtApexDefaultPath[] = "/apex/com.android.art";
32 static constexpr const char kArtApexDataDefaultPath[] = "/data/misc/apexdata/com.android.art";
33 static constexpr const char kAndroidConscryptApexDefaultPath[] = "/apex/com.android.conscrypt";
34 static constexpr const char kAndroidI18nApexDefaultPath[] = "/apex/com.android.i18n";
35
36 static constexpr const char* kOatExtension = ".oat";
37 static constexpr const char* kOdexExtension = ".odex";
38 static constexpr const char* kVdexExtension = ".vdex";
39 static constexpr const char* kArtExtension = ".art";
40 static constexpr const char* kDmExtension = ".dm";
41 static constexpr const char* kSdmExtension = ".sdm";
42
43 // These methods return the Android Root, which is the historical location of
44 // the Android "system" directory, containing the built Android artifacts. On
45 // target, this is normally "/system". On host this is usually a directory under
46 // the build tree, e.g. "$ANDROID_BUILD_TOP/out/host/linux-x86". The location of
47 // the Android Root can be overriden using the ANDROID_ROOT environment
48 // variable.
49 //
50 // Find $ANDROID_ROOT, /system, or abort.
51 std::string GetAndroidRoot();
52 // Find $ANDROID_ROOT, /system, or return an empty string.
53 std::string GetAndroidRootSafe(/*out*/ std::string* error_msg);
54
55 // Find $SYSTEM_EXT_ROOT, /system_ext, or abort.
56 std::string GetSystemExtRoot();
57 // Find $SYSTEM_EXT_ROOT, /system_ext, or return an empty string.
58 std::string GetSystemExtRootSafe(/*out*/ std::string* error_msg);
59
60 // These methods return the ART Root, which is the location of the (activated)
61 // ART APEX module. On target, this is normally "/apex/com.android.art". On
62 // host, this is usually a subdirectory of the Android Root, e.g.
63 // "$ANDROID_BUILD_TOP/out/host/linux-x86/com.android.art". The location of the
64 // ART root can be overridden using the ANDROID_ART_ROOT environment variable.
65 //
66 // Find $ANDROID_ART_ROOT, /apex/com.android.art, or abort.
67 std::string GetArtRoot();
68 // Find $ANDROID_ART_ROOT, /apex/com.android.art, or return an empty string.
69 std::string GetArtRootSafe(/*out*/ std::string* error_msg);
70
71 // Return the path to the directory containing the ART binaries.
72 std::string GetArtBinDir();
73
74 // Find $ANDROID_DATA, /data, or abort.
75 std::string GetAndroidData();
76 // Find $ANDROID_DATA, /data, or return an empty string.
77 std::string GetAndroidDataSafe(/*out*/ std::string* error_msg);
78
79 // Find $ANDROID_EXPAND, /mnt/expand, or abort.
80 std::string GetAndroidExpand();
81 // Find $ANDROID_EXPAND, /mnt/expand, or return an empty string.
82 std::string GetAndroidExpandSafe(/*out*/ std::string* error_msg);
83
84 // Find $ART_APEX_DATA, /data/misc/apexdata/com.android.art, or abort.
85 std::string GetArtApexData();
86
87 // Returns the directory that contains the prebuilt version of the primary boot image (i.e., the one
88 // generated at build time).
89 std::string GetPrebuiltPrimaryBootImageDir();
90
91 // Returns the filename of the first mainline framework library.
92 std::string GetFirstMainlineFrameworkLibraryFilename(std::string* error_msg);
93
94 // Returns the default boot image location, based on the passed `android_root`.
95 // Returns an empty string if an error occurs.
96 // The default boot image location can only be used with the default bootclasspath (the value of the
97 // BOOTCLASSPATH environment variable).
98 std::string GetDefaultBootImageLocationSafe(const std::string& android_root,
99 bool deny_art_apex_data_files,
100 std::string* error_msg);
101
102 // Same as above, but fails if an error occurs.
103 std::string GetDefaultBootImageLocation(const std::string& android_root,
104 bool deny_art_apex_data_files);
105
106 // Returns the boot image location that forces the runtime to run in JIT Zygote mode.
107 std::string GetJitZygoteBootImageLocation();
108
109 // A helper function to pick the most appropriate boot image based on the given options.
110 // The boot image location can only be used with the default bootclasspath (the value of the
111 // BOOTCLASSPATH environment variable).
112 std::string GetBootImageLocationForDefaultBcp(bool no_boot_image,
113 std::string user_defined_boot_image,
114 bool deny_art_apex_data_files,
115 std::string* error_msg);
116
117 // A helper function to pick the most appropriate boot image based on system properties.
118 // The boot image location can only be used with the default bootclasspath (the value of the
119 // BOOTCLASSPATH environment variable).
120 std::string GetBootImageLocationForDefaultBcpRespectingSysProps(std::string* error_msg);
121
122 // Allows the name to be used for the dalvik cache directory (normally "dalvik-cache") to be
123 // overridden with a new value.
124 void OverrideDalvikCacheSubDirectory(std::string sub_dir);
125
126 // Return true if we found the dalvik cache and stored it in the dalvik_cache argument.
127 // `have_android_data` will be set to true if we have an ANDROID_DATA that exists,
128 // `dalvik_cache_exists` will be true if there is a dalvik-cache directory that is present.
129 // The flag `is_global_cache` tells whether this cache is /data/dalvik-cache.
130 void GetDalvikCache(const char* subdir, bool create_if_absent, std::string* dalvik_cache,
131 bool* have_android_data, bool* dalvik_cache_exists, bool* is_global_cache);
132
133 // Returns the absolute dalvik-cache path for a DexFile or OatFile. The path returned will be
134 // rooted at `cache_location`.
135 bool GetDalvikCacheFilename(std::string_view location,
136 std::string_view cache_location,
137 std::string* filename,
138 std::string* error_msg);
139
140 // Returns the absolute dalvik-cache path. The path may include the instruction set sub-directory
141 // if specified.
142 std::string GetApexDataDalvikCacheDirectory(InstructionSet isa);
143
144 // Gets the oat location in the ART APEX data directory for a DEX file installed anywhere other
145 // than in an APEX. Returns the oat filename if `location` is valid, empty string otherwise.
146 std::string GetApexDataOatFilename(std::string_view location, InstructionSet isa);
147
148 // Gets the odex location in the ART APEX data directory for a DEX file. Returns the odex filename
149 // if `location` is valid, empty string otherwise.
150 std::string GetApexDataOdexFilename(std::string_view location, InstructionSet isa);
151
152 // Gets the boot image in the ART APEX data directory for a DEX file installed anywhere other
153 // than in an APEX. Returns the image location if `dex_location` is valid, empty string otherwise.
154 std::string GetApexDataBootImage(std::string_view dex_location);
155
156 // Gets the image in the ART APEX data directory for a DEX file. Returns the image location if
157 // `dex_location` is valid, empty string otherwise.
158 std::string GetApexDataImage(std::string_view dex_location);
159
160 // Gets the name of a file in the ART APEX directory dalvik-cache. This method assumes the
161 // `dex_location` is for an application.
162 // Returns the location of the file in the dalvik-cache
163 std::string GetApexDataDalvikCacheFilename(std::string_view dex_location,
164 InstructionSet isa,
165 std::string_view file_extension);
166
167 // Returns the system location for an image. This method inserts the `isa` between the
168 // dirname and basename of `location`.
169 std::string GetSystemImageFilename(const char* location, InstructionSet isa);
170
171 // Returns the vdex filename for the given oat filename.
172 std::string GetVdexFilename(const std::string& oat_filename);
173
174 // Returns the dm filename for the given dex location.
175 std::string GetDmFilename(const std::string& dex_location);
176
177 // Returns the odex location on /system for a DEX file on /apex. The caller must make sure that
178 // `location` is on /apex.
179 std::string GetSystemOdexFilenameForApex(std::string_view location, InstructionSet isa);
180
181 // Returns `filename` with the text after the last occurrence of '.' replaced with
182 // `extension`. If `filename` does not contain a period, returns a string containing `filename`,
183 // a period, and `new_extension`.
184 // A leading period in `new_extension`, if exists, is ignored.
185 // Example: ReplaceFileExtension("foo.bar", "abc") == "foo.abc"
186 // ReplaceFileExtension("foo", "abc") == "foo.abc"
187 // ReplaceFileExtension("foo.bar", ".abc") == "foo.abc"
188 // ReplaceFileExtension("foo", ".abc") == "foo.abc"
189 std::string ReplaceFileExtension(std::string_view filename, std::string_view new_extension);
190
191 // Return whether the location is on /apex/com.android.art
192 bool LocationIsOnArtModule(std::string_view location);
193
194 // Return whether the location is on /data/misc/apexdata/com.android.art/.
195 bool LocationIsOnArtApexData(std::string_view location);
196
197 // Return whether the location is on /apex/com.android.conscrypt
198 bool LocationIsOnConscryptModule(std::string_view location);
199
200 // Return whether the location is on /apex/com.android.i18n
201 bool LocationIsOnI18nModule(std::string_view location);
202
203 // Return whether the location is on system (i.e. android root).
204 bool LocationIsOnSystem(const std::string& location);
205
206 // Return whether the location is on system_ext
207 bool LocationIsOnSystemExt(const std::string& location);
208
209 // Return whether the location is on system/framework (i.e. $ANDROID_ROOT/framework).
210 bool LocationIsOnSystemFramework(std::string_view location);
211
212 // Return whether the location is on system_ext/framework
213 bool LocationIsOnSystemExtFramework(std::string_view location);
214
215 // Return whether the location is on /apex/.
216 bool LocationIsOnApex(std::string_view location);
217
218 // If the given location is /apex/<apexname>/..., return <apexname>, otherwise return an empty
219 // string. Note that the result is a view into full_path and is valid only as long as it is.
220 std::string_view ApexNameFromLocation(std::string_view full_path);
221
222 // Returns whether the location is trusted for loading oat files. Trusted locations are protected
223 // by dm-verity or fs-verity. The recognized locations are on /system or
224 // /data/misc/apexdata/com.android.art.
225 bool LocationIsTrusted(const std::string& location, bool trust_art_apex_data_files);
226
227 // Compare the ART module root against android root. Returns true if they are
228 // both known and distinct. This is meant to be a proxy for 'running with apex'.
229 bool ArtModuleRootDistinctFromAndroidRoot();
230
231 // dup(2), except setting the O_CLOEXEC flag atomically, when possible.
232 int DupCloexec(int fd);
233
234 // Returns true if `path` begins with a slash.
IsAbsoluteLocation(const std::string & path)235 inline bool IsAbsoluteLocation(const std::string& path) { return !path.empty() && path[0] == '/'; }
236
237 } // namespace art
238
239 #endif // ART_LIBARTBASE_BASE_FILE_UTILS_H_
240