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
24 #include <android-base/logging.h>
25
26 #include "arch/instruction_set.h"
27
28 namespace art {
29
30 // These methods return the Android Root, which is the historical location of
31 // the Android "system" directory, containing the built Android artifacts. On
32 // target, this is normally "/system". On host this is usually a directory under
33 // the build tree, e.g. "$ANDROID_BUILD_TOP/out/host/linux-x86". The location of
34 // the Android Root can be overriden using the ANDROID_ROOT environment
35 // variable.
36 //
37 // Find $ANDROID_ROOT, /system, or abort.
38 std::string GetAndroidRoot();
39 // Find $ANDROID_ROOT, /system, or return an empty string.
40 std::string GetAndroidRootSafe(/*out*/ std::string* error_msg);
41
42 // These methods return the ART Root, which is the location of the (activated)
43 // ART APEX module. On target, this is normally "/apex/com.android.art". On
44 // host, this is usually a subdirectory of the Android Root, e.g.
45 // "$ANDROID_BUILD_TOP/out/host/linux-x86/com.android.art". The location of the
46 // ART root can be overridden using the ANDROID_ART_ROOT environment variable.
47 //
48 // Find $ANDROID_ART_ROOT, /apex/com.android.art, or abort.
49 std::string GetArtRoot();
50 // Find $ANDROID_ART_ROOT, /apex/com.android.art, or return an empty string.
51 std::string GetArtRootSafe(/*out*/ std::string* error_msg);
52
53 // Return the path to the directory containing the ART binaries.
54 std::string GetArtBinDir();
55
56 // Find $ANDROID_DATA, /data, or abort.
57 std::string GetAndroidData();
58 // Find $ANDROID_DATA, /data, or return an empty string.
59 std::string GetAndroidDataSafe(/*out*/ std::string* error_msg);
60
61 // Returns the default boot image location (ANDROID_ROOT/framework/boot.art).
62 // Returns an empty string if ANDROID_ROOT is not set.
63 std::string GetDefaultBootImageLocation(std::string* error_msg);
64
65 // Returns the default boot image location, based on the passed android root.
66 std::string GetDefaultBootImageLocation(const std::string& android_root);
67
68 // Returns the dalvik-cache location, with subdir appended. Returns the empty string if the cache
69 // could not be found.
70 std::string GetDalvikCache(const char* subdir);
71
72 // Return true if we found the dalvik cache and stored it in the dalvik_cache argument.
73 // have_android_data will be set to true if we have an ANDROID_DATA that exists,
74 // dalvik_cache_exists will be true if there is a dalvik-cache directory that is present.
75 // The flag is_global_cache tells whether this cache is /data/dalvik-cache.
76 void GetDalvikCache(const char* subdir, bool create_if_absent, std::string* dalvik_cache,
77 bool* have_android_data, bool* dalvik_cache_exists, bool* is_global_cache);
78
79 // Returns the absolute dalvik-cache path for a DexFile or OatFile. The path returned will be
80 // rooted at cache_location.
81 bool GetDalvikCacheFilename(const char* file_location, const char* cache_location,
82 std::string* filename, std::string* error_msg);
83
84 // Returns the system location for an image
85 std::string GetSystemImageFilename(const char* location, InstructionSet isa);
86
87 // Returns the vdex filename for the given oat filename.
88 std::string GetVdexFilename(const std::string& oat_filename);
89
90 // Returns `filename` with the text after the last occurrence of '.' replaced with
91 // `extension`. If `filename` does not contain a period, returns a string containing `filename`,
92 // a period, and `new_extension`.
93 // Example: ReplaceFileExtension("foo.bar", "abc") == "foo.abc"
94 // ReplaceFileExtension("foo", "abc") == "foo.abc"
95 std::string ReplaceFileExtension(const std::string& filename, const std::string& new_extension);
96
97 // Return whether the location is on /apex/com.android.art
98 bool LocationIsOnArtModule(const char* location);
99
100 // Return whether the location is on /apex/com.android.conscrypt
101 bool LocationIsOnConscryptModule(const char* location);
102
103 // Return whether the location is on system (i.e. android root).
104 bool LocationIsOnSystem(const char* location);
105
106 // Return whether the location is on system/framework (i.e. android_root/framework).
107 bool LocationIsOnSystemFramework(const char* location);
108
109 // Return whether the location is on /apex/.
110 bool LocationIsOnApex(const char* location);
111
112 // Compare the ART module root against android root. Returns true if they are
113 // both known and distinct. This is meant to be a proxy for 'running with apex'.
114 bool ArtModuleRootDistinctFromAndroidRoot();
115
116 // dup(2), except setting the O_CLOEXEC flag atomically, when possible.
117 int DupCloexec(int fd);
118
119 // Returns true if `path` begins with a slash.
IsAbsoluteLocation(const std::string & path)120 inline bool IsAbsoluteLocation(const std::string& path) { return !path.empty() && path[0] == '/'; }
121
122 } // namespace art
123
124 #endif // ART_LIBARTBASE_BASE_FILE_UTILS_H_
125