blob: 44c6d87da5b7be49d3a2fc9d1c964fd915fd900d [file] [log] [blame]
Brian Carlstromf91c8c32011-09-21 17:30:34 -07001/*
2 * Copyright (C) 2008 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
Andreas Gampe277ccbd2014-11-03 21:36:10 -080017#include "dalvik_system_DexFile.h"
18
Calin Juravle9dae5b42014-04-07 16:36:21 +030019#include <algorithm>
Calin Juravle9dae5b42014-04-07 16:36:21 +030020#include <set>
Ian Rogersdd157d72014-05-15 14:47:50 -070021#include <fcntl.h>
Ian Rogersc5f17732014-06-05 20:48:42 -070022#ifdef __linux__
Calin Juravle52214102014-06-04 12:01:50 +010023#include <sys/sendfile.h>
Ian Rogersc5f17732014-06-05 20:48:42 -070024#else
25#include <sys/socket.h>
26#endif
Calin Juravle52214102014-06-04 12:01:50 +010027#include <sys/stat.h>
Calin Juravle9dae5b42014-04-07 16:36:21 +030028#include <unistd.h>
Brian Carlstrom1d9f52b2011-10-13 10:50:45 -070029
Elliott Hughes07ed66b2012-12-12 18:34:25 -080030#include "base/logging.h"
Andreas Gampe833a4852014-05-21 18:46:59 -070031#include "base/stl_util.h"
Andreas Gampe20c89302014-08-19 17:28:06 -070032#include "base/stringprintf.h"
Brian Carlstromaded5f72011-10-07 17:15:04 -070033#include "class_linker.h"
Ian Rogers62d6c772013-02-27 08:32:07 -080034#include "common_throws.h"
Ian Rogers4f6ad8a2013-03-18 15:27:28 -070035#include "dex_file-inl.h"
Ian Rogers1d54e732013-05-02 21:10:01 -070036#include "gc/space/image_space.h"
37#include "gc/space/space-inl.h"
Brian Carlstrom81f3ca12012-03-17 00:27:35 -070038#include "image.h"
Elliott Hugheseac76672012-05-24 21:56:51 -070039#include "jni_internal.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080040#include "mirror/class_loader.h"
Ian Rogers05f30572013-02-20 12:13:11 -080041#include "mirror/object-inl.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080042#include "mirror/string.h"
Brian Carlstrom700c8d32012-11-05 10:42:02 -080043#include "oat.h"
Brian Carlstrom1d9f52b2011-10-13 10:50:45 -070044#include "os.h"
Calin Juravle9dae5b42014-04-07 16:36:21 +030045#include "profiler.h"
Brian Carlstromaded5f72011-10-07 17:15:04 -070046#include "runtime.h"
Ian Rogers00f7d0e2012-07-19 15:28:27 -070047#include "scoped_thread_state_change.h"
Ian Rogersc9818482012-01-11 08:52:51 -080048#include "ScopedLocalRef.h"
Brian Carlstromf91c8c32011-09-21 17:30:34 -070049#include "ScopedUtfChars.h"
Calin Juravlebb0b53f2014-05-23 17:33:29 +010050#include "utils.h"
Ian Rogersdd157d72014-05-15 14:47:50 -070051#include "well_known_classes.h"
Elliott Hugheseac76672012-05-24 21:56:51 -070052#include "zip_archive.h"
Brian Carlstromf91c8c32011-09-21 17:30:34 -070053
Andreas Gampe277ccbd2014-11-03 21:36:10 -080054#pragma GCC diagnostic push
55#pragma GCC diagnostic ignored "-Wshadow"
56#include "ScopedFd.h"
57#pragma GCC diagnostic pop
58
Brian Carlstromf91c8c32011-09-21 17:30:34 -070059namespace art {
60
Brian Carlstromf91c8c32011-09-21 17:30:34 -070061// A smart pointer that provides read-only access to a Java string's UTF chars.
62// Unlike libcore's NullableScopedUtfChars, this will *not* throw NullPointerException if
63// passed a null jstring. The correct idiom is:
64//
65// NullableScopedUtfChars name(env, javaName);
Brian Carlstromc252c3e2011-10-16 23:21:02 -070066// if (env->ExceptionCheck()) {
Brian Carlstromf91c8c32011-09-21 17:30:34 -070067// return NULL;
68// }
69// // ... use name.c_str()
70//
71// TODO: rewrite to get rid of this, or change ScopedUtfChars to offer this option.
72class NullableScopedUtfChars {
Elliott Hughesba8eee12012-01-24 20:25:24 -080073 public:
74 NullableScopedUtfChars(JNIEnv* env, jstring s) : mEnv(env), mString(s) {
75 mUtfChars = (s != NULL) ? env->GetStringUTFChars(s, NULL) : NULL;
76 }
77
78 ~NullableScopedUtfChars() {
79 if (mUtfChars) {
80 mEnv->ReleaseStringUTFChars(mString, mUtfChars);
Brian Carlstromf91c8c32011-09-21 17:30:34 -070081 }
Elliott Hughesba8eee12012-01-24 20:25:24 -080082 }
Brian Carlstromf91c8c32011-09-21 17:30:34 -070083
Elliott Hughesba8eee12012-01-24 20:25:24 -080084 const char* c_str() const {
85 return mUtfChars;
86 }
Brian Carlstromf91c8c32011-09-21 17:30:34 -070087
Elliott Hughesba8eee12012-01-24 20:25:24 -080088 size_t size() const {
89 return strlen(mUtfChars);
90 }
Brian Carlstromf91c8c32011-09-21 17:30:34 -070091
Elliott Hughesba8eee12012-01-24 20:25:24 -080092 // Element access.
93 const char& operator[](size_t n) const {
94 return mUtfChars[n];
95 }
Brian Carlstromf91c8c32011-09-21 17:30:34 -070096
Elliott Hughesba8eee12012-01-24 20:25:24 -080097 private:
98 JNIEnv* mEnv;
99 jstring mString;
100 const char* mUtfChars;
Brian Carlstromf91c8c32011-09-21 17:30:34 -0700101
Elliott Hughesba8eee12012-01-24 20:25:24 -0800102 // Disallow copy and assignment.
103 NullableScopedUtfChars(const NullableScopedUtfChars&);
104 void operator=(const NullableScopedUtfChars&);
Brian Carlstromf91c8c32011-09-21 17:30:34 -0700105};
106
Calin Juravlea2069c72014-08-06 19:07:41 +0000107static jlong DexFile_openDexFileNative(JNIEnv* env, jclass, jstring javaSourceName, jstring javaOutputName, jint) {
Brian Carlstromf91c8c32011-09-21 17:30:34 -0700108 ScopedUtfChars sourceName(env, javaSourceName);
109 if (sourceName.c_str() == NULL) {
110 return 0;
111 }
112 NullableScopedUtfChars outputName(env, javaOutputName);
Brian Carlstromc252c3e2011-10-16 23:21:02 -0700113 if (env->ExceptionCheck()) {
Brian Carlstromf91c8c32011-09-21 17:30:34 -0700114 return 0;
115 }
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700116
Brian Carlstrom756ee4e2013-10-03 15:46:12 -0700117 ClassLinker* linker = Runtime::Current()->GetClassLinker();
Andreas Gampe833a4852014-05-21 18:46:59 -0700118 std::unique_ptr<std::vector<const DexFile*>> dex_files(new std::vector<const DexFile*>());
119 std::vector<std::string> error_msgs;
120
121 bool success = linker->OpenDexFilesFromOat(sourceName.c_str(), outputName.c_str(), &error_msgs,
122 dex_files.get());
123
Nicolas Geoffray4fcdc942014-07-22 10:48:00 +0100124 if (success || !dex_files->empty()) {
125 // In the case of non-success, we have not found or could not generate the oat file.
126 // But we may still have found a dex file that we can use.
Andreas Gampe833a4852014-05-21 18:46:59 -0700127 return static_cast<jlong>(reinterpret_cast<uintptr_t>(dex_files.release()));
Brian Carlstrom756ee4e2013-10-03 15:46:12 -0700128 } else {
Andreas Gampe833a4852014-05-21 18:46:59 -0700129 // The vector should be empty after a failed loading attempt.
130 DCHECK_EQ(0U, dex_files->size());
131
Vladimir Marko60836d52014-01-16 15:53:38 +0000132 ScopedObjectAccess soa(env);
Andreas Gampe329d1882014-04-08 10:32:19 -0700133 CHECK(!error_msgs.empty());
134 // The most important message is at the end. So set up nesting by going forward, which will
135 // wrap the existing exception as a cause for the following one.
136 auto it = error_msgs.begin();
137 auto itEnd = error_msgs.end();
138 for ( ; it != itEnd; ++it) {
139 ThrowWrappedIOException("%s", it->c_str());
140 }
141
jeffhaoc393a4f2011-10-19 13:46:09 -0700142 return 0;
Brian Carlstromaded5f72011-10-07 17:15:04 -0700143 }
Brian Carlstromaded5f72011-10-07 17:15:04 -0700144}
145
Andreas Gampe833a4852014-05-21 18:46:59 -0700146static std::vector<const DexFile*>* toDexFiles(jlong dex_file_address, JNIEnv* env) {
147 std::vector<const DexFile*>* dex_files = reinterpret_cast<std::vector<const DexFile*>*>(
148 static_cast<uintptr_t>(dex_file_address));
149 if (UNLIKELY(dex_files == nullptr)) {
Ian Rogers1eb512d2013-10-18 15:42:20 -0700150 ScopedObjectAccess soa(env);
Ian Rogers62d6c772013-02-27 08:32:07 -0800151 ThrowNullPointerException(NULL, "dex_file == null");
Brian Carlstromaded5f72011-10-07 17:15:04 -0700152 }
Andreas Gampe833a4852014-05-21 18:46:59 -0700153 return dex_files;
Brian Carlstromf91c8c32011-09-21 17:30:34 -0700154}
155
Elliott Hughes2d983902014-02-04 16:17:13 -0800156static void DexFile_closeDexFile(JNIEnv* env, jclass, jlong cookie) {
Andreas Gampe833a4852014-05-21 18:46:59 -0700157 std::unique_ptr<std::vector<const DexFile*>> dex_files(toDexFiles(cookie, env));
158 if (dex_files.get() == nullptr) {
Brian Carlstromaded5f72011-10-07 17:15:04 -0700159 return;
160 }
Ian Rogersb0fa5dc2014-04-28 16:47:08 -0700161 ScopedObjectAccess soa(env);
Andreas Gampe833a4852014-05-21 18:46:59 -0700162
163 size_t index = 0;
164 for (const DexFile* dex_file : *dex_files) {
165 if (Runtime::Current()->GetClassLinker()->IsDexFileRegistered(*dex_file)) {
166 (*dex_files)[index] = nullptr;
167 }
168 index++;
Brian Carlstromaded5f72011-10-07 17:15:04 -0700169 }
Andreas Gampe833a4852014-05-21 18:46:59 -0700170
171 STLDeleteElements(dex_files.get());
172 // Unique_ptr will delete the vector itself.
Brian Carlstromf91c8c32011-09-21 17:30:34 -0700173}
174
Elliott Hughes0512f022012-03-15 22:10:52 -0700175static jclass DexFile_defineClassNative(JNIEnv* env, jclass, jstring javaName, jobject javaLoader,
Elliott Hughes2d983902014-02-04 16:17:13 -0800176 jlong cookie) {
Andreas Gampe833a4852014-05-21 18:46:59 -0700177 std::vector<const DexFile*>* dex_files = toDexFiles(cookie, env);
178 if (dex_files == NULL) {
Brian Carlstrom7571e8b2013-08-12 17:04:14 -0700179 VLOG(class_linker) << "Failed to find dex_file";
Brian Carlstromaded5f72011-10-07 17:15:04 -0700180 return NULL;
181 }
Brian Carlstromdf143242011-10-10 18:05:34 -0700182 ScopedUtfChars class_name(env, javaName);
183 if (class_name.c_str() == NULL) {
Brian Carlstrom2e450bf2013-09-06 15:39:46 -0700184 VLOG(class_linker) << "Failed to find class_name";
Brian Carlstromdf143242011-10-10 18:05:34 -0700185 return NULL;
186 }
Elliott Hughes95572412011-12-13 18:14:20 -0800187 const std::string descriptor(DotToDescriptor(class_name.c_str()));
Mathieu Chartiere7c9a8c2014-11-06 16:35:45 -0800188 const size_t hash(ComputeModifiedUtf8Hash(descriptor.c_str()));
Andreas Gampe833a4852014-05-21 18:46:59 -0700189 for (const DexFile* dex_file : *dex_files) {
Mathieu Chartiere7c9a8c2014-11-06 16:35:45 -0800190 const DexFile::ClassDef* dex_class_def = dex_file->FindClassDef(descriptor.c_str(), hash);
Andreas Gampe833a4852014-05-21 18:46:59 -0700191 if (dex_class_def != nullptr) {
192 ScopedObjectAccess soa(env);
193 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
194 class_linker->RegisterDexFile(*dex_file);
195 StackHandleScope<1> hs(soa.Self());
196 Handle<mirror::ClassLoader> class_loader(
197 hs.NewHandle(soa.Decode<mirror::ClassLoader*>(javaLoader)));
Mathieu Chartiere7c9a8c2014-11-06 16:35:45 -0800198 mirror::Class* result = class_linker->DefineClass(soa.Self(), descriptor.c_str(), hash,
Ian Rogers7b078e82014-09-10 14:44:24 -0700199 class_loader, *dex_file, *dex_class_def);
Andreas Gampe833a4852014-05-21 18:46:59 -0700200 if (result != nullptr) {
Brian Carlstrom667ab7c2014-10-16 19:12:28 -0700201 VLOG(class_linker) << "DexFile_defineClassNative returning " << result
202 << " for " << class_name.c_str();
Andreas Gampe833a4852014-05-21 18:46:59 -0700203 return soa.AddLocalReference<jclass>(result);
204 }
205 }
Brian Carlstromaded5f72011-10-07 17:15:04 -0700206 }
Brian Carlstrom667ab7c2014-10-16 19:12:28 -0700207 VLOG(class_linker) << "Failed to find dex_class_def " << class_name.c_str();
Andreas Gampe833a4852014-05-21 18:46:59 -0700208 return nullptr;
Brian Carlstromf91c8c32011-09-21 17:30:34 -0700209}
210
Andreas Gampe833a4852014-05-21 18:46:59 -0700211// Needed as a compare functor for sets of const char
212struct CharPointerComparator {
213 bool operator()(const char *str1, const char *str2) const {
214 return strcmp(str1, str2) < 0;
215 }
216};
217
218// Note: this can be an expensive call, as we sort out duplicates in MultiDex files.
Elliott Hughes2d983902014-02-04 16:17:13 -0800219static jobjectArray DexFile_getClassNameList(JNIEnv* env, jclass, jlong cookie) {
Ian Rogersdd157d72014-05-15 14:47:50 -0700220 jobjectArray result = nullptr;
Andreas Gampe833a4852014-05-21 18:46:59 -0700221 std::vector<const DexFile*>* dex_files = toDexFiles(cookie, env);
222
223 if (dex_files != nullptr) {
224 // Push all class descriptors into a set. Use set instead of unordered_set as we want to
225 // retrieve all in the end.
226 std::set<const char*, CharPointerComparator> descriptors;
227 for (const DexFile* dex_file : *dex_files) {
Ian Rogersdd157d72014-05-15 14:47:50 -0700228 for (size_t i = 0; i < dex_file->NumClassDefs(); ++i) {
229 const DexFile::ClassDef& class_def = dex_file->GetClassDef(i);
Andreas Gampe833a4852014-05-21 18:46:59 -0700230 const char* descriptor = dex_file->GetClassDescriptor(class_def);
231 descriptors.insert(descriptor);
232 }
233 }
234
235 // Now create output array and copy the set into it.
236 result = env->NewObjectArray(descriptors.size(), WellKnownClasses::java_lang_String, nullptr);
237 if (result != nullptr) {
238 auto it = descriptors.begin();
239 auto it_end = descriptors.end();
240 jsize i = 0;
241 for (; it != it_end; it++, ++i) {
242 std::string descriptor(DescriptorToDot(*it));
Brian Carlstromcf790bb2014-05-28 11:09:10 -0700243 ScopedLocalRef<jstring> jdescriptor(env, env->NewStringUTF(descriptor.c_str()));
Ian Rogersdd157d72014-05-15 14:47:50 -0700244 if (jdescriptor.get() == nullptr) {
245 return nullptr;
246 }
247 env->SetObjectArrayElement(result, i, jdescriptor.get());
248 }
249 }
Brian Carlstromaded5f72011-10-07 17:15:04 -0700250 }
Ian Rogersdd157d72014-05-15 14:47:50 -0700251 return result;
Brian Carlstromf91c8c32011-09-21 17:30:34 -0700252}
253
Dave Allison39c3bfb2014-01-28 18:33:52 -0800254static void CopyProfileFile(const char* oldfile, const char* newfile) {
Calin Juravle52214102014-06-04 12:01:50 +0100255 ScopedFd src(open(oldfile, O_RDONLY));
256 if (src.get() == -1) {
257 PLOG(ERROR) << "Failed to open profile file " << oldfile
258 << ". My uid:gid is " << getuid() << ":" << getgid();
259 return;
260 }
261
262 struct stat stat_src;
263 if (fstat(src.get(), &stat_src) == -1) {
264 PLOG(ERROR) << "Failed to get stats for profile file " << oldfile
265 << ". My uid:gid is " << getuid() << ":" << getgid();
Dave Allison39c3bfb2014-01-28 18:33:52 -0800266 return;
267 }
268
269 // Create the copy with rw------- (only accessible by system)
Calin Juravle52214102014-06-04 12:01:50 +0100270 ScopedFd dst(open(newfile, O_WRONLY|O_CREAT|O_TRUNC, 0600));
271 if (dst.get() == -1) {
272 PLOG(ERROR) << "Failed to create/write prev profile file " << newfile
273 << ". My uid:gid is " << getuid() << ":" << getgid();
Dave Allison39c3bfb2014-01-28 18:33:52 -0800274 return;
275 }
Calin Juravle52214102014-06-04 12:01:50 +0100276
Ian Rogersc5f17732014-06-05 20:48:42 -0700277#ifdef __linux__
Calin Juravle52214102014-06-04 12:01:50 +0100278 if (sendfile(dst.get(), src.get(), nullptr, stat_src.st_size) == -1) {
Ian Rogersc5f17732014-06-05 20:48:42 -0700279#else
280 off_t len;
281 if (sendfile(dst.get(), src.get(), 0, &len, nullptr, 0) == -1) {
282#endif
Calin Juravle52214102014-06-04 12:01:50 +0100283 PLOG(ERROR) << "Failed to copy profile file " << oldfile << " to " << newfile
284 << ". My uid:gid is " << getuid() << ":" << getgid();
Dave Allison39c3bfb2014-01-28 18:33:52 -0800285 }
Dave Allison39c3bfb2014-01-28 18:33:52 -0800286}
287
Alex Light6e183f22014-07-18 14:57:04 -0700288// Java: dalvik.system.DexFile.UP_TO_DATE
289static const jbyte kUpToDate = 0;
290// Java: dalvik.system.DexFile.DEXOPT_NEEDED
291static const jbyte kPatchoatNeeded = 1;
292// Java: dalvik.system.DexFile.PATCHOAT_NEEDED
293static const jbyte kDexoptNeeded = 2;
294
295template <const bool kVerboseLogging, const bool kReasonLogging>
296static jbyte IsDexOptNeededForFile(const std::string& oat_filename, const char* filename,
Igor Murashkin46774762014-10-22 11:37:02 -0700297 InstructionSet target_instruction_set,
298 bool* oat_is_pic) {
Alex Light6e183f22014-07-18 14:57:04 -0700299 std::string error_msg;
300 std::unique_ptr<const OatFile> oat_file(OatFile::Open(oat_filename, oat_filename, nullptr,
Igor Murashkin46774762014-10-22 11:37:02 -0700301 nullptr,
Alex Light6e183f22014-07-18 14:57:04 -0700302 false, &error_msg));
303 if (oat_file.get() == nullptr) {
Brian Carlstrom98515952015-01-06 12:05:34 -0800304 // Note that even though this is kDexoptNeeded, we use
305 // kVerboseLogging instead of the usual kReasonLogging since it is
306 // the common case on first boot and very spammy.
307 if (kVerboseLogging) {
Alex Light6e183f22014-07-18 14:57:04 -0700308 LOG(INFO) << "DexFile_isDexOptNeeded failed to open oat file '" << oat_filename
309 << "' for file location '" << filename << "': " << error_msg;
310 }
311 error_msg.clear();
312 return kDexoptNeeded;
313 }
Igor Murashkin46774762014-10-22 11:37:02 -0700314
315 // Pass-up the information about if this is PIC.
316 // TODO: Refactor this function to be less complicated.
317 *oat_is_pic = oat_file->IsPic();
318
Alex Light6e183f22014-07-18 14:57:04 -0700319 bool should_relocate_if_possible = Runtime::Current()->ShouldRelocate();
320 uint32_t location_checksum = 0;
321 const art::OatFile::OatDexFile* oat_dex_file = oat_file->GetOatDexFile(filename, nullptr,
322 kReasonLogging);
323 if (oat_dex_file != nullptr) {
324 // If its not possible to read the classes.dex assume up-to-date as we won't be able to
325 // compile it anyway.
326 if (!DexFile::GetChecksum(filename, &location_checksum, &error_msg)) {
327 if (kVerboseLogging) {
328 LOG(INFO) << "DexFile_isDexOptNeeded found precompiled stripped file: "
329 << filename << " for " << oat_filename << ": " << error_msg;
330 }
331 if (ClassLinker::VerifyOatChecksums(oat_file.get(), target_instruction_set, &error_msg)) {
332 if (kVerboseLogging) {
333 LOG(INFO) << "DexFile_isDexOptNeeded file " << oat_filename
334 << " is up-to-date for " << filename;
335 }
336 return kUpToDate;
337 } else if (should_relocate_if_possible &&
338 ClassLinker::VerifyOatImageChecksum(oat_file.get(), target_instruction_set)) {
Brian Carlstrome8e39892014-09-23 13:53:28 -0700339 if (kReasonLogging) {
Alex Light6e183f22014-07-18 14:57:04 -0700340 LOG(INFO) << "DexFile_isDexOptNeeded file " << oat_filename
341 << " needs to be relocated for " << filename;
342 }
343 return kPatchoatNeeded;
344 } else {
Brian Carlstrome8e39892014-09-23 13:53:28 -0700345 if (kReasonLogging) {
Alex Light6e183f22014-07-18 14:57:04 -0700346 LOG(INFO) << "DexFile_isDexOptNeeded file " << oat_filename
347 << " is out of date for " << filename;
348 }
349 return kDexoptNeeded;
350 }
351 // If we get here the file is out of date and we should use the system one to relocate.
352 } else {
353 if (ClassLinker::VerifyOatAndDexFileChecksums(oat_file.get(), filename, location_checksum,
354 target_instruction_set, &error_msg)) {
355 if (kVerboseLogging) {
356 LOG(INFO) << "DexFile_isDexOptNeeded file " << oat_filename
357 << " is up-to-date for " << filename;
358 }
359 return kUpToDate;
360 } else if (location_checksum == oat_dex_file->GetDexFileLocationChecksum()
361 && should_relocate_if_possible
362 && ClassLinker::VerifyOatImageChecksum(oat_file.get(), target_instruction_set)) {
Brian Carlstrome8e39892014-09-23 13:53:28 -0700363 if (kReasonLogging) {
Alex Light6e183f22014-07-18 14:57:04 -0700364 LOG(INFO) << "DexFile_isDexOptNeeded file " << oat_filename
365 << " needs to be relocated for " << filename;
366 }
367 return kPatchoatNeeded;
368 } else {
Brian Carlstrome8e39892014-09-23 13:53:28 -0700369 if (kReasonLogging) {
Alex Light6e183f22014-07-18 14:57:04 -0700370 LOG(INFO) << "DexFile_isDexOptNeeded file " << oat_filename
371 << " is out of date for " << filename;
372 }
373 return kDexoptNeeded;
374 }
375 }
376 } else {
Brian Carlstrome8e39892014-09-23 13:53:28 -0700377 if (kReasonLogging) {
Alex Light6e183f22014-07-18 14:57:04 -0700378 LOG(INFO) << "DexFile_isDexOptNeeded file " << oat_filename
379 << " does not contain " << filename;
380 }
381 return kDexoptNeeded;
382 }
383}
384
385static jbyte IsDexOptNeededInternal(JNIEnv* env, const char* filename,
Narayan Kamath11d9f062014-04-23 20:24:57 +0100386 const char* pkgname, const char* instruction_set, const jboolean defer) {
Brian Carlstrome8e39892014-09-23 13:53:28 -0700387 // Spammy logging for kUpToDate
388 const bool kVerboseLogging = false;
389 // Logging of reason for returning kDexoptNeeded or kPatchoatNeeded.
390 const bool kReasonLogging = true;
Brian Carlstrombf2cb162012-02-27 17:49:19 -0800391
Narayan Kamath11d9f062014-04-23 20:24:57 +0100392 if ((filename == nullptr) || !OS::FileExists(filename)) {
393 LOG(ERROR) << "DexFile_isDexOptNeeded file '" << filename << "' does not exist";
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700394 ScopedLocalRef<jclass> fnfe(env, env->FindClass("java/io/FileNotFoundException"));
Narayan Kamath11d9f062014-04-23 20:24:57 +0100395 const char* message = (filename == nullptr) ? "<empty file name>" : filename;
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700396 env->ThrowNew(fnfe.get(), message);
Alex Light6e183f22014-07-18 14:57:04 -0700397 return kUpToDate;
Brian Carlstrom1d9f52b2011-10-13 10:50:45 -0700398 }
399
400 // Always treat elements of the bootclasspath as up-to-date. The
401 // fact that code is running at all means that this should be true.
Brian Carlstrom81f3ca12012-03-17 00:27:35 -0700402 Runtime* runtime = Runtime::Current();
403 ClassLinker* class_linker = runtime->GetClassLinker();
Narayan Kamath11d9f062014-04-23 20:24:57 +0100404 // TODO: We're assuming that the 64 and 32 bit runtimes have identical
405 // class paths. isDexOptNeeded will not necessarily be called on a runtime
406 // that has the same instruction set as the file being dexopted.
Brian Carlstrom1d9f52b2011-10-13 10:50:45 -0700407 const std::vector<const DexFile*>& boot_class_path = class_linker->GetBootClassPath();
408 for (size_t i = 0; i < boot_class_path.size(); i++) {
Narayan Kamath11d9f062014-04-23 20:24:57 +0100409 if (boot_class_path[i]->GetLocation() == filename) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700410 if (kVerboseLogging) {
Narayan Kamath11d9f062014-04-23 20:24:57 +0100411 LOG(INFO) << "DexFile_isDexOptNeeded ignoring boot class path file: " << filename;
Brian Carlstrombf2cb162012-02-27 17:49:19 -0800412 }
Alex Light6e183f22014-07-18 14:57:04 -0700413 return kUpToDate;
Brian Carlstrom1d9f52b2011-10-13 10:50:45 -0700414 }
415 }
416
Alex Light6e183f22014-07-18 14:57:04 -0700417 bool force_system_only = false;
418 bool require_system_version = false;
Brian Carlstrome1ff1992014-05-18 22:37:51 -0700419
Dave Allison39c3bfb2014-01-28 18:33:52 -0800420 // Check the profile file. We need to rerun dex2oat if the profile has changed significantly
421 // since the last time, or it's new.
422 // If the 'defer' argument is true then this will be retried later. In this case we
423 // need to make sure that the profile file copy is not made so that we will get the
424 // same result second time.
Alex Light6e183f22014-07-18 14:57:04 -0700425 std::string profile_file;
426 std::string prev_profile_file;
427 bool should_copy_profile = false;
Calin Juravlec1b643c2014-05-30 23:44:11 +0100428 if (Runtime::Current()->GetProfilerOptions().IsEnabled() && (pkgname != nullptr)) {
Alex Light6e183f22014-07-18 14:57:04 -0700429 profile_file = GetDalvikCacheOrDie("profiles", false /* create_if_absent */)
Narayan Kamath11d9f062014-04-23 20:24:57 +0100430 + std::string("/") + pkgname;
Alex Light6e183f22014-07-18 14:57:04 -0700431 prev_profile_file = profile_file + std::string("@old");
Dave Allison39c3bfb2014-01-28 18:33:52 -0800432
433 struct stat profstat, prevstat;
434 int e1 = stat(profile_file.c_str(), &profstat);
Alex Light6e183f22014-07-18 14:57:04 -0700435 int e1_errno = errno;
Dave Allison39c3bfb2014-01-28 18:33:52 -0800436 int e2 = stat(prev_profile_file.c_str(), &prevstat);
Alex Light6e183f22014-07-18 14:57:04 -0700437 int e2_errno = errno;
Dave Allison39c3bfb2014-01-28 18:33:52 -0800438 if (e1 < 0) {
Alex Light6e183f22014-07-18 14:57:04 -0700439 if (e1_errno != EACCES) {
440 // No profile file, need to run dex2oat, unless we find a file in system
441 if (kReasonLogging) {
442 LOG(INFO) << "DexFile_isDexOptNeededInternal profile file " << profile_file << " doesn't exist. "
443 << "Will check odex to see if we can find a working version.";
444 }
445 // Force it to only accept system files/files with versions in system.
446 require_system_version = true;
447 } else {
448 LOG(INFO) << "DexFile_isDexOptNeededInternal recieved EACCES trying to stat profile file "
449 << profile_file;
Dave Allison39c3bfb2014-01-28 18:33:52 -0800450 }
Alex Light6e183f22014-07-18 14:57:04 -0700451 } else if (e2 == 0) {
Dave Allison39c3bfb2014-01-28 18:33:52 -0800452 // There is a previous profile file. Check if the profile has changed significantly.
Calin Juravle9dae5b42014-04-07 16:36:21 +0300453 // A change in profile is considered significant if X% (change_thr property) of the top K%
454 // (compile_thr property) samples has changed.
Calin Juravlec1b643c2014-05-30 23:44:11 +0100455 double top_k_threshold = Runtime::Current()->GetProfilerOptions().GetTopKThreshold();
456 double change_threshold = Runtime::Current()->GetProfilerOptions().GetTopKChangeThreshold();
Calin Juravlebb0b53f2014-05-23 17:33:29 +0100457 double change_percent = 0.0;
458 ProfileFile new_profile, old_profile;
459 bool new_ok = new_profile.LoadFile(profile_file);
460 bool old_ok = old_profile.LoadFile(prev_profile_file);
461 if (!new_ok || !old_ok) {
Brian Carlstrom09881a82014-04-18 17:44:01 -0700462 if (kVerboseLogging) {
Alex Light6e183f22014-07-18 14:57:04 -0700463 LOG(INFO) << "DexFile_isDexOptNeededInternal Ignoring invalid profiles: "
Calin Juravlebb0b53f2014-05-23 17:33:29 +0100464 << (new_ok ? "" : profile_file) << " " << (old_ok ? "" : prev_profile_file);
Calin Juravle9dae5b42014-04-07 16:36:21 +0300465 }
Calin Juravle9dae5b42014-04-07 16:36:21 +0300466 } else {
Calin Juravlebb0b53f2014-05-23 17:33:29 +0100467 std::set<std::string> new_top_k, old_top_k;
468 new_profile.GetTopKSamples(new_top_k, top_k_threshold);
469 old_profile.GetTopKSamples(old_top_k, top_k_threshold);
470 if (new_top_k.empty()) {
471 if (kVerboseLogging) {
Alex Light6e183f22014-07-18 14:57:04 -0700472 LOG(INFO) << "DexFile_isDexOptNeededInternal empty profile: " << profile_file;
Calin Juravlebb0b53f2014-05-23 17:33:29 +0100473 }
474 // If the new topK is empty we shouldn't optimize so we leave the change_percent at 0.0.
475 } else {
476 std::set<std::string> diff;
477 std::set_difference(new_top_k.begin(), new_top_k.end(), old_top_k.begin(), old_top_k.end(),
478 std::inserter(diff, diff.end()));
479 // TODO: consider using the usedPercentage instead of the plain diff count.
480 change_percent = 100.0 * static_cast<double>(diff.size()) / static_cast<double>(new_top_k.size());
481 if (kVerboseLogging) {
482 std::set<std::string>::iterator end = diff.end();
483 for (std::set<std::string>::iterator it = diff.begin(); it != end; it++) {
Alex Light6e183f22014-07-18 14:57:04 -0700484 LOG(INFO) << "DexFile_isDexOptNeededInternal new in topK: " << *it;
Calin Juravlebb0b53f2014-05-23 17:33:29 +0100485 }
Calin Juravle9dae5b42014-04-07 16:36:21 +0300486 }
487 }
Dave Allison39c3bfb2014-01-28 18:33:52 -0800488 }
489
Calin Juravlebb0b53f2014-05-23 17:33:29 +0100490 if (change_percent > change_threshold) {
Brian Carlstrom09881a82014-04-18 17:44:01 -0700491 if (kReasonLogging) {
Alex Light6e183f22014-07-18 14:57:04 -0700492 LOG(INFO) << "DexFile_isDexOptNeededInternal size of new profile file " << profile_file <<
Calin Juravle9dae5b42014-04-07 16:36:21 +0300493 " is significantly different from old profile file " << prev_profile_file << " (top "
Calin Juravlebb0b53f2014-05-23 17:33:29 +0100494 << top_k_threshold << "% samples changed in proportion of " << change_percent << "%)";
Dave Allison39c3bfb2014-01-28 18:33:52 -0800495 }
Alex Light6e183f22014-07-18 14:57:04 -0700496 should_copy_profile = !defer;
497 // Force us to only accept system files.
498 force_system_only = true;
Dave Allison39c3bfb2014-01-28 18:33:52 -0800499 }
Alex Light6e183f22014-07-18 14:57:04 -0700500 } else if (e2_errno == ENOENT) {
Dave Allison39c3bfb2014-01-28 18:33:52 -0800501 // Previous profile does not exist. Make a copy of the current one.
Brian Carlstrom09881a82014-04-18 17:44:01 -0700502 if (kVerboseLogging) {
Alex Light6e183f22014-07-18 14:57:04 -0700503 LOG(INFO) << "DexFile_isDexOptNeededInternal previous profile doesn't exist: " << prev_profile_file;
Dave Allison39c3bfb2014-01-28 18:33:52 -0800504 }
Alex Light6e183f22014-07-18 14:57:04 -0700505 should_copy_profile = !defer;
506 } else {
507 PLOG(INFO) << "Unable to stat previous profile file " << prev_profile_file;
Dave Allison39c3bfb2014-01-28 18:33:52 -0800508 }
509 }
510
Alex Light6e183f22014-07-18 14:57:04 -0700511 const InstructionSet target_instruction_set = GetInstructionSetFromString(instruction_set);
Andreas Gampe20c89302014-08-19 17:28:06 -0700512 if (target_instruction_set == kNone) {
513 ScopedLocalRef<jclass> iae(env, env->FindClass("java/lang/IllegalArgumentException"));
514 std::string message(StringPrintf("Instruction set %s is invalid.", instruction_set));
515 env->ThrowNew(iae.get(), message.c_str());
516 return 0;
517 }
Alex Light6e183f22014-07-18 14:57:04 -0700518
519 // Get the filename for odex file next to the dex file.
520 std::string odex_filename(DexFilenameToOdexFilename(filename, target_instruction_set));
521 // Get the filename for the dalvik-cache file
522 std::string cache_dir;
523 bool have_android_data = false;
524 bool dalvik_cache_exists = false;
Andreas Gampe3c13a792014-09-18 20:56:04 -0700525 bool is_global_cache = false;
526 GetDalvikCache(instruction_set, false, &cache_dir, &have_android_data, &dalvik_cache_exists,
527 &is_global_cache);
Alex Light6e183f22014-07-18 14:57:04 -0700528 std::string cache_filename; // was cache_location
529 bool have_cache_filename = false;
530 if (dalvik_cache_exists) {
531 std::string error_msg;
532 have_cache_filename = GetDalvikCacheFilename(filename, cache_dir.c_str(), &cache_filename,
533 &error_msg);
534 if (!have_cache_filename && kVerboseLogging) {
535 LOG(INFO) << "DexFile_isDexOptNeededInternal failed to find cache file for dex file " << filename
536 << ": " << error_msg;
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700537 }
Brian Carlstrom5b332c82012-02-01 15:02:31 -0800538 }
539
Alex Light6e183f22014-07-18 14:57:04 -0700540 bool should_relocate_if_possible = Runtime::Current()->ShouldRelocate();
541
Alex Light6e183f22014-07-18 14:57:04 -0700542 jbyte dalvik_cache_decision = -1;
543 // Lets try the cache first (since we want to load from there since thats where the relocated
544 // versions will be).
545 if (have_cache_filename && !force_system_only) {
Igor Murashkin46774762014-10-22 11:37:02 -0700546 bool oat_is_pic;
Alex Light6e183f22014-07-18 14:57:04 -0700547 // We can use the dalvik-cache if we find a good file.
548 dalvik_cache_decision =
Narayan Kamath202d1f02014-08-08 16:19:44 +0100549 IsDexOptNeededForFile<kVerboseLogging, kReasonLogging>(cache_filename, filename,
Igor Murashkin46774762014-10-22 11:37:02 -0700550 target_instruction_set, &oat_is_pic);
551
552 // Apps that are compiled with --compile-pic never need to be patchoat-d
553 if (oat_is_pic && dalvik_cache_decision == kPatchoatNeeded) {
554 dalvik_cache_decision = kUpToDate;
555 }
Alex Light6e183f22014-07-18 14:57:04 -0700556 // We will only return DexOptNeeded if both the cache and system return it.
557 if (dalvik_cache_decision != kDexoptNeeded && !require_system_version) {
558 CHECK(!(dalvik_cache_decision == kPatchoatNeeded && !should_relocate_if_possible))
559 << "May not return PatchoatNeeded when patching is disabled.";
560 return dalvik_cache_decision;
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700561 }
Alex Light6e183f22014-07-18 14:57:04 -0700562 // We couldn't find one thats easy. We should now try the system.
Brian Carlstroma004aa92012-02-08 18:05:09 -0800563 }
564
Igor Murashkin46774762014-10-22 11:37:02 -0700565 bool oat_is_pic;
Alex Light6e183f22014-07-18 14:57:04 -0700566 jbyte system_decision =
Narayan Kamath202d1f02014-08-08 16:19:44 +0100567 IsDexOptNeededForFile<kVerboseLogging, kReasonLogging>(odex_filename, filename,
Igor Murashkin46774762014-10-22 11:37:02 -0700568 target_instruction_set, &oat_is_pic);
Alex Light6e183f22014-07-18 14:57:04 -0700569 CHECK(!(system_decision == kPatchoatNeeded && !should_relocate_if_possible))
570 << "May not return PatchoatNeeded when patching is disabled.";
571
Igor Murashkin46774762014-10-22 11:37:02 -0700572 // Apps that are compiled with --compile-pic never need to be patchoat-d
573 if (oat_is_pic && system_decision == kPatchoatNeeded) {
574 system_decision = kUpToDate;
575 }
576
Alex Light6e183f22014-07-18 14:57:04 -0700577 if (require_system_version && system_decision == kPatchoatNeeded
578 && dalvik_cache_decision == kUpToDate) {
579 // We have a version from system relocated to the cache. Return it.
580 return dalvik_cache_decision;
Brian Carlstrom5b332c82012-02-01 15:02:31 -0800581 }
582
Alex Light6e183f22014-07-18 14:57:04 -0700583 if (should_copy_profile && system_decision == kDexoptNeeded) {
584 CopyProfileFile(profile_file.c_str(), prev_profile_file.c_str());
Brian Carlstrombf2cb162012-02-27 17:49:19 -0800585 }
Alex Light6e183f22014-07-18 14:57:04 -0700586
587 return system_decision;
Brian Carlstromf91c8c32011-09-21 17:30:34 -0700588}
589
Alex Light6e183f22014-07-18 14:57:04 -0700590static jbyte DexFile_isDexOptNeededInternal(JNIEnv* env, jclass, jstring javaFilename,
Narayan Kamath11d9f062014-04-23 20:24:57 +0100591 jstring javaPkgname, jstring javaInstructionSet, jboolean defer) {
592 ScopedUtfChars filename(env, javaFilename);
Andreas Gampe20c89302014-08-19 17:28:06 -0700593 if (env->ExceptionCheck()) {
594 return 0;
595 }
596
Narayan Kamath11d9f062014-04-23 20:24:57 +0100597 NullableScopedUtfChars pkgname(env, javaPkgname);
Andreas Gampe20c89302014-08-19 17:28:06 -0700598
Narayan Kamath11d9f062014-04-23 20:24:57 +0100599 ScopedUtfChars instruction_set(env, javaInstructionSet);
Andreas Gampe20c89302014-08-19 17:28:06 -0700600 if (env->ExceptionCheck()) {
601 return 0;
602 }
Narayan Kamath11d9f062014-04-23 20:24:57 +0100603
604 return IsDexOptNeededInternal(env, filename.c_str(), pkgname.c_str(),
605 instruction_set.c_str(), defer);
606}
607
Dave Allison39c3bfb2014-01-28 18:33:52 -0800608// public API, NULL pkgname
Narayan Kamath11d9f062014-04-23 20:24:57 +0100609static jboolean DexFile_isDexOptNeeded(JNIEnv* env, jclass, jstring javaFilename) {
610 const char* instruction_set = GetInstructionSetString(kRuntimeISA);
611 ScopedUtfChars filename(env, javaFilename);
Alex Light6e183f22014-07-18 14:57:04 -0700612 return kUpToDate != IsDexOptNeededInternal(env, filename.c_str(), nullptr /* pkgname */,
613 instruction_set, false /* defer */);
Dave Allison39c3bfb2014-01-28 18:33:52 -0800614}
615
616
Brian Carlstromf91c8c32011-09-21 17:30:34 -0700617static JNINativeMethod gMethods[] = {
Elliott Hughes2d983902014-02-04 16:17:13 -0800618 NATIVE_METHOD(DexFile, closeDexFile, "(J)V"),
619 NATIVE_METHOD(DexFile, defineClassNative, "(Ljava/lang/String;Ljava/lang/ClassLoader;J)Ljava/lang/Class;"),
620 NATIVE_METHOD(DexFile, getClassNameList, "(J)[Ljava/lang/String;"),
Brian Carlstromf91c8c32011-09-21 17:30:34 -0700621 NATIVE_METHOD(DexFile, isDexOptNeeded, "(Ljava/lang/String;)Z"),
Alex Light6e183f22014-07-18 14:57:04 -0700622 NATIVE_METHOD(DexFile, isDexOptNeededInternal, "(Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Z)B"),
Calin Juravlea2069c72014-08-06 19:07:41 +0000623 NATIVE_METHOD(DexFile, openDexFileNative, "(Ljava/lang/String;Ljava/lang/String;I)J"),
Brian Carlstromf91c8c32011-09-21 17:30:34 -0700624};
625
Brian Carlstromf91c8c32011-09-21 17:30:34 -0700626void register_dalvik_system_DexFile(JNIEnv* env) {
Elliott Hugheseac76672012-05-24 21:56:51 -0700627 REGISTER_NATIVE_METHODS("dalvik/system/DexFile");
Brian Carlstromf91c8c32011-09-21 17:30:34 -0700628}
629
630} // namespace art