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 bool ReadFileToString(const std::string& file_name, std::string* result);
31
32 // Find $ANDROID_ROOT, /system, or abort.
33 std::string GetAndroidRoot();
34 // Find $ANDROID_ROOT, /system, or return an empty string.
35 std::string GetAndroidRootSafe(/*out*/ std::string* error_msg);
36
37 // Find $ANDROID_RUNTIME_ROOT, /apex/com.android.runtime, or abort.
38 std::string GetAndroidRuntimeRoot();
39 // Find $ANDROID_RUNTIME_ROOT, /apex/com.android.runtime, or return an empty string.
40 std::string GetAndroidRuntimeRootSafe(/*out*/ std::string* error_msg);
41
42 // Find $ANDROID_DATA, /data, or abort.
43 std::string GetAndroidData();
44 // Find $ANDROID_DATA, /data, or return an empty string.
45 std::string GetAndroidDataSafe(/*out*/ std::string* error_msg);
46
47 // Returns the default boot image location (ANDROID_ROOT/framework/boot.art).
48 // Returns an empty string if ANDROID_ROOT is not set.
49 std::string GetDefaultBootImageLocation(std::string* error_msg);
50
51 // Returns the default boot image location, based on the passed android root.
52 std::string GetDefaultBootImageLocation(const std::string& android_root);
53
54 // Returns the dalvik-cache location, with subdir appended. Returns the empty string if the cache
55 // could not be found.
56 std::string GetDalvikCache(const char* subdir);
57
58 // Return true if we found the dalvik cache and stored it in the dalvik_cache argument.
59 // have_android_data will be set to true if we have an ANDROID_DATA that exists,
60 // dalvik_cache_exists will be true if there is a dalvik-cache directory that is present.
61 // The flag is_global_cache tells whether this cache is /data/dalvik-cache.
62 void GetDalvikCache(const char* subdir, bool create_if_absent, std::string* dalvik_cache,
63 bool* have_android_data, bool* dalvik_cache_exists, bool* is_global_cache);
64
65 // Returns the absolute dalvik-cache path for a DexFile or OatFile. The path returned will be
66 // rooted at cache_location.
67 bool GetDalvikCacheFilename(const char* file_location, const char* cache_location,
68 std::string* filename, std::string* error_msg);
69
70 // Returns the system location for an image
71 std::string GetSystemImageFilename(const char* location, InstructionSet isa);
72
73 // Returns the vdex filename for the given oat filename.
74 std::string GetVdexFilename(const std::string& oat_filename);
75
76 // Returns `filename` with the text after the last occurrence of '.' replaced with
77 // `extension`. If `filename` does not contain a period, returns a string containing `filename`,
78 // a period, and `new_extension`.
79 // Example: ReplaceFileExtension("foo.bar", "abc") == "foo.abc"
80 // ReplaceFileExtension("foo", "abc") == "foo.abc"
81 std::string ReplaceFileExtension(const std::string& filename, const std::string& new_extension);
82
83 // Return whether the location is on /apex/com.android.runtime
84 bool LocationIsOnRuntimeModule(const char* location);
85
86 // Return whether the location is on /apex/com.android.conscrypt
87 bool LocationIsOnConscryptModule(const char* location);
88
89 // Return whether the location is on system (i.e. android root).
90 bool LocationIsOnSystem(const char* location);
91
92 // Return whether the location is on system/framework (i.e. android_root/framework).
93 bool LocationIsOnSystemFramework(const char* location);
94
95 // Return whether the location is on /apex/.
96 bool LocationIsOnApex(const char* location);
97
98 // Compare the runtime module root against android root. Returns true if they are
99 // both known and distinct. This is meant to be a proxy for 'running with apex'.
100 bool RuntimeModuleRootDistinctFromAndroidRoot();
101
102 // dup(2), except setting the O_CLOEXEC flag atomically, when possible.
103 int DupCloexec(int fd);
104
105 // Returns true if `path` begins with a slash.
IsAbsoluteLocation(const std::string & path)106 inline bool IsAbsoluteLocation(const std::string& path) { return !path.empty() && path[0] == '/'; }
107
108 } // namespace art
109
110 #endif // ART_LIBARTBASE_BASE_FILE_UTILS_H_
111