-
Notifications
You must be signed in to change notification settings - Fork 107
/
Copy pathartd.cc
1579 lines (1363 loc) · 63.1 KB
/
artd.cc
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (C) 2021 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#include "artd.h"
#include <fcntl.h>
#include <stdlib.h>
#include <sys/mount.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <unistd.h>
#include <climits>
#include <csignal>
#include <cstddef>
#include <cstdint>
#include <cstring>
#include <filesystem>
#include <functional>
#include <iterator>
#include <map>
#include <memory>
#include <mutex>
#include <optional>
#include <ostream>
#include <string>
#include <string_view>
#include <system_error>
#include <type_traits>
#include <unordered_set>
#include <utility>
#include <vector>
#include "aidl/com/android/server/art/BnArtd.h"
#include "aidl/com/android/server/art/DexoptTrigger.h"
#include "aidl/com/android/server/art/IArtdCancellationSignal.h"
#include "android-base/errors.h"
#include "android-base/file.h"
#include "android-base/logging.h"
#include "android-base/result.h"
#include "android-base/scopeguard.h"
#include "android-base/strings.h"
#include "android/binder_auto_utils.h"
#include "android/binder_interface_utils.h"
#include "android/binder_manager.h"
#include "android/binder_process.h"
#include "base/compiler_filter.h"
#include "base/file_magic.h"
#include "base/file_utils.h"
#include "base/globals.h"
#include "base/logging.h"
#include "base/macros.h"
#include "base/mem_map.h"
#include "base/memfd.h"
#include "base/os.h"
#include "base/zip_archive.h"
#include "cmdline_types.h"
#include "dex/dex_file_loader.h"
#include "exec_utils.h"
#include "file_utils.h"
#include "fstab/fstab.h"
#include "oat/oat_file_assistant.h"
#include "oat/oat_file_assistant_context.h"
#include "path_utils.h"
#include "profman/profman_result.h"
#include "selinux/android.h"
#include "service.h"
#include "tools/cmdline_builder.h"
#include "tools/tools.h"
namespace art {
namespace artd {
namespace {
using ::aidl::com::android::server::art::ArtdDexoptResult;
using ::aidl::com::android::server::art::ArtifactsLocation;
using ::aidl::com::android::server::art::ArtifactsPath;
using ::aidl::com::android::server::art::CopyAndRewriteProfileResult;
using ::aidl::com::android::server::art::DexMetadataPath;
using ::aidl::com::android::server::art::DexoptOptions;
using ::aidl::com::android::server::art::DexoptTrigger;
using ::aidl::com::android::server::art::FileVisibility;
using ::aidl::com::android::server::art::FsPermission;
using ::aidl::com::android::server::art::GetDexoptNeededResult;
using ::aidl::com::android::server::art::GetDexoptStatusResult;
using ::aidl::com::android::server::art::IArtdCancellationSignal;
using ::aidl::com::android::server::art::MergeProfileOptions;
using ::aidl::com::android::server::art::OutputArtifacts;
using ::aidl::com::android::server::art::OutputProfile;
using ::aidl::com::android::server::art::PriorityClass;
using ::aidl::com::android::server::art::ProfilePath;
using ::aidl::com::android::server::art::RuntimeArtifactsPath;
using ::aidl::com::android::server::art::VdexPath;
using ::android::base::Dirname;
using ::android::base::ErrnoError;
using ::android::base::Error;
using ::android::base::Join;
using ::android::base::make_scope_guard;
using ::android::base::ReadFileToString;
using ::android::base::Result;
using ::android::base::Split;
using ::android::base::StringReplace;
using ::android::base::WriteStringToFd;
using ::android::fs_mgr::FstabEntry;
using ::art::service::ValidateDexPath;
using ::art::tools::CmdlineBuilder;
using ::ndk::ScopedAStatus;
using TmpProfilePath = ProfilePath::TmpProfilePath;
constexpr const char* kServiceName = "artd";
constexpr const char* kPreRebootServiceName = "artd_pre_reboot";
constexpr const char* kArtdCancellationSignalType = "ArtdCancellationSignal";
// Timeout for short operations, such as merging profiles.
constexpr int kShortTimeoutSec = 60; // 1 minute.
// Timeout for long operations, such as compilation. We set it to be smaller than the Package
// Manager watchdog (PackageManagerService.WATCHDOG_TIMEOUT, 10 minutes), so that if the operation
// is called from the Package Manager's thread handler, it will be aborted before that watchdog
// would take down the system server.
constexpr int kLongTimeoutSec = 570; // 9.5 minutes.
std::optional<int64_t> GetSize(std::string_view path) {
std::error_code ec;
int64_t size = std::filesystem::file_size(path, ec);
if (ec) {
// It is okay if the file does not exist. We don't have to log it.
if (ec.value() != ENOENT) {
LOG(ERROR) << ART_FORMAT("Failed to get the file size of '{}': {}", path, ec.message());
}
return std::nullopt;
}
return size;
}
// Deletes a file. Returns the size of the deleted file, or 0 if the deleted file is empty or an
// error occurs.
int64_t GetSizeAndDeleteFile(const std::string& path) {
std::optional<int64_t> size = GetSize(path);
if (!size.has_value()) {
return 0;
}
std::error_code ec;
if (!std::filesystem::remove(path, ec)) {
LOG(ERROR) << ART_FORMAT("Failed to remove '{}': {}", path, ec.message());
return 0;
}
return size.value();
}
std::string EscapeErrorMessage(const std::string& message) {
return StringReplace(message, std::string("\0", /*n=*/1), "\\0", /*all=*/true);
}
// Indicates an error that should never happen (e.g., illegal arguments passed by service-art
// internally). System server should crash if this kind of error happens.
ScopedAStatus Fatal(const std::string& message) {
return ScopedAStatus::fromExceptionCodeWithMessage(EX_ILLEGAL_STATE,
EscapeErrorMessage(message).c_str());
}
// Indicates an error that service-art should handle (e.g., I/O errors, sub-process crashes).
// The scope of the error depends on the function that throws it, so service-art should catch the
// error at every call site and take different actions.
// Ideally, this should be a checked exception or an additional return value that forces service-art
// to handle it, but `ServiceSpecificException` (a separate runtime exception type) is the best
// approximate we have given the limitation of Java and Binder.
ScopedAStatus NonFatal(const std::string& message) {
constexpr int32_t kArtdNonFatalErrorCode = 1;
return ScopedAStatus::fromServiceSpecificErrorWithMessage(kArtdNonFatalErrorCode,
EscapeErrorMessage(message).c_str());
}
Result<CompilerFilter::Filter> ParseCompilerFilter(const std::string& compiler_filter_str) {
CompilerFilter::Filter compiler_filter;
if (!CompilerFilter::ParseCompilerFilter(compiler_filter_str.c_str(), &compiler_filter)) {
return Errorf("Failed to parse compiler filter '{}'", compiler_filter_str);
}
return compiler_filter;
}
OatFileAssistant::DexOptTrigger DexOptTriggerFromAidl(int32_t aidl_value) {
OatFileAssistant::DexOptTrigger trigger{};
if ((aidl_value & static_cast<int32_t>(DexoptTrigger::COMPILER_FILTER_IS_BETTER)) != 0) {
trigger.targetFilterIsBetter = true;
}
if ((aidl_value & static_cast<int32_t>(DexoptTrigger::COMPILER_FILTER_IS_SAME)) != 0) {
trigger.targetFilterIsSame = true;
}
if ((aidl_value & static_cast<int32_t>(DexoptTrigger::COMPILER_FILTER_IS_WORSE)) != 0) {
trigger.targetFilterIsWorse = true;
}
if ((aidl_value & static_cast<int32_t>(DexoptTrigger::PRIMARY_BOOT_IMAGE_BECOMES_USABLE)) != 0) {
trigger.primaryBootImageBecomesUsable = true;
}
if ((aidl_value & static_cast<int32_t>(DexoptTrigger::NEED_EXTRACTION)) != 0) {
trigger.needExtraction = true;
}
return trigger;
}
ArtifactsLocation ArtifactsLocationToAidl(OatFileAssistant::Location location) {
switch (location) {
case OatFileAssistant::Location::kLocationNoneOrError:
return ArtifactsLocation::NONE_OR_ERROR;
case OatFileAssistant::Location::kLocationOat:
return ArtifactsLocation::DALVIK_CACHE;
case OatFileAssistant::Location::kLocationOdex:
return ArtifactsLocation::NEXT_TO_DEX;
case OatFileAssistant::Location::kLocationDm:
return ArtifactsLocation::DM;
// No default. All cases should be explicitly handled, or the compilation will fail.
}
// This should never happen. Just in case we get a non-enumerator value.
LOG(FATAL) << "Unexpected Location " << location;
}
Result<void> PrepareArtifactsDir(const std::string& path, const FsPermission& fs_permission) {
std::error_code ec;
bool created = std::filesystem::create_directory(path, ec);
if (ec) {
return Errorf("Failed to create directory '{}': {}", path, ec.message());
}
auto cleanup = make_scope_guard([&] {
if (created) {
std::filesystem::remove(path, ec);
}
});
if (chmod(path.c_str(), DirFsPermissionToMode(fs_permission)) != 0) {
return ErrnoErrorf("Failed to chmod directory '{}'", path);
}
OR_RETURN(Chown(path, fs_permission));
cleanup.Disable();
return {};
}
Result<void> PrepareArtifactsDirs(const OutputArtifacts& output_artifacts,
/*out*/ std::string* oat_dir_path) {
if (output_artifacts.artifactsPath.isInDalvikCache) {
return {};
}
std::filesystem::path oat_path(OR_RETURN(BuildOatPath(output_artifacts.artifactsPath)));
std::filesystem::path isa_dir = oat_path.parent_path();
std::filesystem::path oat_dir = isa_dir.parent_path();
DCHECK_EQ(oat_dir.filename(), "oat");
OR_RETURN(PrepareArtifactsDir(oat_dir, output_artifacts.permissionSettings.dirFsPermission));
OR_RETURN(PrepareArtifactsDir(isa_dir, output_artifacts.permissionSettings.dirFsPermission));
*oat_dir_path = oat_dir;
return {};
}
Result<void> Restorecon(
const std::string& path,
const std::optional<OutputArtifacts::PermissionSettings::SeContext>& se_context) {
if (!kIsTargetAndroid) {
return {};
}
int res = 0;
if (se_context.has_value()) {
res = selinux_android_restorecon_pkgdir(path.c_str(),
se_context->seInfo.c_str(),
se_context->uid,
SELINUX_ANDROID_RESTORECON_RECURSE);
} else {
res = selinux_android_restorecon(path.c_str(), SELINUX_ANDROID_RESTORECON_RECURSE);
}
if (res != 0) {
return ErrnoErrorf("Failed to restorecon directory '{}'", path);
}
return {};
}
Result<FileVisibility> GetFileVisibility(const std::string& file) {
std::error_code ec;
std::filesystem::file_status status = std::filesystem::status(file, ec);
if (!std::filesystem::status_known(status)) {
return Errorf("Failed to get status of '{}': {}", file, ec.message());
}
if (!std::filesystem::exists(status)) {
return FileVisibility::NOT_FOUND;
}
return (status.permissions() & std::filesystem::perms::others_read) !=
std::filesystem::perms::none ?
FileVisibility::OTHER_READABLE :
FileVisibility::NOT_OTHER_READABLE;
}
Result<ArtdCancellationSignal*> ToArtdCancellationSignal(IArtdCancellationSignal* input) {
if (input == nullptr) {
return Error() << "Cancellation signal must not be nullptr";
}
// We cannot use `dynamic_cast` because ART code is compiled with `-fno-rtti`, so we have to check
// the magic number.
int64_t type;
if (!input->getType(&type).isOk() ||
type != reinterpret_cast<intptr_t>(kArtdCancellationSignalType)) {
// The cancellation signal must be created by `Artd::createCancellationSignal`.
return Error() << "Invalid cancellation signal type";
}
return static_cast<ArtdCancellationSignal*>(input);
}
Result<void> CopyFile(const std::string& src_path, const NewFile& dst_file) {
std::string content;
if (!ReadFileToString(src_path, &content)) {
return Errorf("Failed to read file '{}': {}", src_path, strerror(errno));
}
if (!WriteStringToFd(content, dst_file.Fd())) {
return Errorf("Failed to write file '{}': {}", dst_file.TempPath(), strerror(errno));
}
if (fsync(dst_file.Fd()) != 0) {
return Errorf("Failed to flush file '{}': {}", dst_file.TempPath(), strerror(errno));
}
if (lseek(dst_file.Fd(), /*offset=*/0, SEEK_SET) != 0) {
return Errorf(
"Failed to reset the offset for file '{}': {}", dst_file.TempPath(), strerror(errno));
}
return {};
}
Result<void> SetLogVerbosity() {
std::string options =
android::base::GetProperty("dalvik.vm.artd-verbose", /*default_value=*/"oat");
if (options.empty()) {
return {};
}
CmdlineType<LogVerbosity> parser;
CmdlineParseResult<LogVerbosity> result = parser.Parse(options);
if (!result.IsSuccess()) {
return Error() << result.GetMessage();
}
gLogVerbosity = result.ReleaseValue();
return {};
}
CopyAndRewriteProfileResult AnalyzeCopyAndRewriteProfileFailure(
File* src, ProfmanResult::CopyAndUpdateResult result) {
DCHECK(result == ProfmanResult::kCopyAndUpdateNoMatch ||
result == ProfmanResult::kCopyAndUpdateErrorFailedToLoadProfile);
auto bad_profile = [&](std::string_view error_msg) {
return CopyAndRewriteProfileResult{
.status = CopyAndRewriteProfileResult::Status::BAD_PROFILE,
.errorMsg = ART_FORMAT("Failed to load profile '{}': {}", src->GetPath(), error_msg)};
};
CopyAndRewriteProfileResult no_profile{.status = CopyAndRewriteProfileResult::Status::NO_PROFILE,
.errorMsg = ""};
int64_t length = src->GetLength();
if (length < 0) {
return bad_profile(strerror(-length));
}
if (length == 0) {
return no_profile;
}
std::string error_msg;
uint32_t magic;
if (!ReadMagicAndReset(src->Fd(), &magic, &error_msg)) {
return bad_profile(error_msg);
}
if (IsZipMagic(magic)) {
std::unique_ptr<ZipArchive> zip_archive(
ZipArchive::OpenFromOwnedFd(src->Fd(), src->GetPath().c_str(), &error_msg));
if (zip_archive == nullptr) {
return bad_profile(error_msg);
}
std::unique_ptr<ZipEntry> zip_entry(zip_archive->Find("primary.prof", &error_msg));
if (zip_entry == nullptr || zip_entry->GetUncompressedLength() == 0) {
return no_profile;
}
}
if (result == ProfmanResult::kCopyAndUpdateNoMatch) {
return bad_profile(
"The profile does not match the APK (The checksums in the profile do not match the "
"checksums of the .dex files in the APK)");
}
return bad_profile("The profile is in the wrong format or an I/O error has occurred");
}
// Returns the fd on success, or an invalid fd if the dex file contains no profile, or error if any
// error occurs.
Result<File> ExtractEmbeddedProfileToFd(const std::string& dex_path) {
std::unique_ptr<File> dex_file = OR_RETURN(OpenFileForReading(dex_path));
std::string error_msg;
uint32_t magic;
if (!ReadMagicAndReset(dex_file->Fd(), &magic, &error_msg)) {
return Error() << error_msg;
}
if (!IsZipMagic(magic)) {
if (DexFileLoader::IsMagicValid(magic)) {
// The dex file can be a plain dex file. This is expected.
return File();
}
return Error() << "File is neither a zip file nor a plain dex file";
}
std::unique_ptr<ZipArchive> zip_archive(
ZipArchive::OpenFromOwnedFd(dex_file->Fd(), dex_path.c_str(), &error_msg));
if (zip_archive == nullptr) {
return Error() << error_msg;
}
constexpr const char* kEmbeddedProfileEntry = "assets/art-profile/baseline.prof";
std::unique_ptr<ZipEntry> zip_entry(zip_archive->Find(kEmbeddedProfileEntry, &error_msg));
size_t size;
if (zip_entry == nullptr || (size = zip_entry->GetUncompressedLength()) == 0) {
// From system/libziparchive/zip_error.cpp.
constexpr const char* kEntryNotFound = "Entry not found";
if (error_msg != kEntryNotFound) {
LOG(WARNING) << ART_FORMAT(
"Failed to find zip entry '{}' in '{}': {}", kEmbeddedProfileEntry, dex_path, error_msg);
}
// The dex file doesn't necessarily contain a profile. This is expected.
return File();
}
// The name is for debugging only.
std::string memfd_name =
ART_FORMAT("{} extracted in memory from {}", kEmbeddedProfileEntry, dex_path);
File memfd(memfd_create(memfd_name.c_str(), /*flags=*/0),
memfd_name,
/*check_usage=*/false);
if (!memfd.IsValid()) {
return ErrnoError() << "Failed to create memfd";
}
if (ftruncate(memfd.Fd(), size) != 0) {
return ErrnoError() << "Failed to ftruncate memfd";
}
// Map with MAP_SHARED because we're feeding the fd to profman.
MemMap mem_map = MemMap::MapFile(size,
PROT_READ | PROT_WRITE,
MAP_SHARED,
memfd.Fd(),
/*start=*/0,
/*low_4gb=*/false,
memfd_name.c_str(),
&error_msg);
if (!mem_map.IsValid()) {
return Errorf("Failed to mmap memfd: {}", error_msg);
}
if (!zip_entry->ExtractToMemory(mem_map.Begin(), &error_msg)) {
return Errorf("Failed to extract '{}': {}", kEmbeddedProfileEntry, error_msg);
}
// Reopen the memfd with readonly to make SELinux happy when the fd is passed to a child process
// who doesn't have write permission. (b/303909581)
std::string path = ART_FORMAT("/proc/self/fd/{}", memfd.Fd());
File memfd_readonly(
open(path.c_str(), O_RDONLY), memfd_name, /*check_usage=*/false, /*read_only_mode=*/true);
if (!memfd_readonly.IsOpened()) {
return ErrnoErrorf("Failed to open file '{}' ('{}')", path, memfd_name);
}
return memfd_readonly;
}
class FdLogger {
public:
void Add(const NewFile& file) { fd_mapping_.emplace_back(file.Fd(), file.TempPath()); }
void Add(const File& file) { fd_mapping_.emplace_back(file.Fd(), file.GetPath()); }
std::string GetFds() {
std::vector<int> fds;
fds.reserve(fd_mapping_.size());
for (const auto& [fd, path] : fd_mapping_) {
fds.push_back(fd);
}
return Join(fds, ':');
}
private:
std::vector<std::pair<int, std::string>> fd_mapping_;
friend std::ostream& operator<<(std::ostream& os, const FdLogger& fd_logger);
};
std::ostream& operator<<(std::ostream& os, const FdLogger& fd_logger) {
for (const auto& [fd, path] : fd_logger.fd_mapping_) {
os << fd << ":" << path << ' ';
}
return os;
}
} // namespace
#define OR_RETURN_ERROR(func, expr) \
({ \
decltype(expr)&& __or_return_error_tmp = (expr); \
if (!__or_return_error_tmp.ok()) { \
return (func)(__or_return_error_tmp.error().message()); \
} \
std::move(__or_return_error_tmp).value(); \
})
#define OR_RETURN_FATAL(expr) OR_RETURN_ERROR(Fatal, expr)
#define OR_RETURN_NON_FATAL(expr) OR_RETURN_ERROR(NonFatal, expr)
#define OR_LOG_AND_RETURN_OK(expr) \
OR_RETURN_ERROR( \
[](const std::string& message) { \
LOG(ERROR) << message; \
return ScopedAStatus::ok(); \
}, \
expr)
ScopedAStatus Artd::isAlive(bool* _aidl_return) {
*_aidl_return = true;
return ScopedAStatus::ok();
}
ScopedAStatus Artd::deleteArtifacts(const ArtifactsPath& in_artifactsPath, int64_t* _aidl_return) {
std::string oat_path = OR_RETURN_FATAL(BuildOatPath(in_artifactsPath));
*_aidl_return = 0;
*_aidl_return += GetSizeAndDeleteFile(oat_path);
*_aidl_return += GetSizeAndDeleteFile(OatPathToVdexPath(oat_path));
*_aidl_return += GetSizeAndDeleteFile(OatPathToArtPath(oat_path));
return ScopedAStatus::ok();
}
ScopedAStatus Artd::getDexoptStatus(const std::string& in_dexFile,
const std::string& in_instructionSet,
const std::optional<std::string>& in_classLoaderContext,
GetDexoptStatusResult* _aidl_return) {
Result<OatFileAssistantContext*> ofa_context = GetOatFileAssistantContext();
if (!ofa_context.ok()) {
return NonFatal("Failed to get runtime options: " + ofa_context.error().message());
}
std::unique_ptr<ClassLoaderContext> context;
std::string error_msg;
auto oat_file_assistant = OatFileAssistant::Create(in_dexFile,
in_instructionSet,
in_classLoaderContext,
/*load_executable=*/false,
/*only_load_trusted_executable=*/true,
ofa_context.value(),
&context,
&error_msg);
if (oat_file_assistant == nullptr) {
return NonFatal("Failed to create OatFileAssistant: " + error_msg);
}
std::string ignored_odex_status;
OatFileAssistant::Location location;
oat_file_assistant->GetOptimizationStatus(&_aidl_return->locationDebugString,
&_aidl_return->compilerFilter,
&_aidl_return->compilationReason,
&ignored_odex_status,
&location);
_aidl_return->artifactsLocation = ArtifactsLocationToAidl(location);
// We ignore odex_status because it is not meaningful. It can only be either "up-to-date",
// "apk-more-recent", or "io-error-no-oat", which means it doesn't give us information in addition
// to what we can learn from compiler_filter because compiler_filter will be the actual compiler
// filter, "run-from-apk-fallback", and "run-from-apk" in those three cases respectively.
DCHECK(ignored_odex_status == "up-to-date" || ignored_odex_status == "apk-more-recent" ||
ignored_odex_status == "io-error-no-oat");
return ScopedAStatus::ok();
}
ndk::ScopedAStatus Artd::isProfileUsable(const ProfilePath& in_profile,
const std::string& in_dexFile,
bool* _aidl_return) {
std::string profile_path = OR_RETURN_FATAL(BuildProfileOrDmPath(in_profile));
OR_RETURN_FATAL(ValidateDexPath(in_dexFile));
FdLogger fd_logger;
CmdlineBuilder art_exec_args;
art_exec_args.Add(OR_RETURN_FATAL(GetArtExec())).Add("--drop-capabilities");
CmdlineBuilder args;
args.Add(OR_RETURN_FATAL(GetProfman()));
Result<std::unique_ptr<File>> profile = OpenFileForReading(profile_path);
if (!profile.ok()) {
if (profile.error().code() == ENOENT) {
*_aidl_return = false;
return ScopedAStatus::ok();
}
return NonFatal(
ART_FORMAT("Failed to open profile '{}': {}", profile_path, profile.error().message()));
}
args.Add("--reference-profile-file-fd=%d", profile.value()->Fd());
fd_logger.Add(*profile.value());
std::unique_ptr<File> dex_file = OR_RETURN_NON_FATAL(OpenFileForReading(in_dexFile));
args.Add("--apk-fd=%d", dex_file->Fd());
fd_logger.Add(*dex_file);
art_exec_args.Add("--keep-fds=%s", fd_logger.GetFds()).Add("--").Concat(std::move(args));
LOG(INFO) << "Running profman: " << Join(art_exec_args.Get(), /*separator=*/" ")
<< "\nOpened FDs: " << fd_logger;
Result<int> result = ExecAndReturnCode(art_exec_args.Get(), kShortTimeoutSec);
if (!result.ok()) {
return NonFatal("Failed to run profman: " + result.error().message());
}
LOG(INFO) << ART_FORMAT("profman returned code {}", result.value());
if (result.value() != ProfmanResult::kSkipCompilationSmallDelta &&
result.value() != ProfmanResult::kSkipCompilationEmptyProfiles) {
return NonFatal(ART_FORMAT("profman returned an unexpected code: {}", result.value()));
}
*_aidl_return = result.value() == ProfmanResult::kSkipCompilationSmallDelta;
return ScopedAStatus::ok();
}
ndk::ScopedAStatus Artd::CopyAndRewriteProfileImpl(File src,
OutputProfile* dst_aidl,
const std::string& dex_path,
CopyAndRewriteProfileResult* aidl_return) {
std::string dst_path = OR_RETURN_FATAL(BuildFinalProfilePath(dst_aidl->profilePath));
OR_RETURN_FATAL(ValidateDexPath(dex_path));
FdLogger fd_logger;
CmdlineBuilder art_exec_args;
art_exec_args.Add(OR_RETURN_FATAL(GetArtExec())).Add("--drop-capabilities");
CmdlineBuilder args;
args.Add(OR_RETURN_FATAL(GetProfman())).Add("--copy-and-update-profile-key");
args.Add("--profile-file-fd=%d", src.Fd());
fd_logger.Add(src);
std::unique_ptr<File> dex_file = OR_RETURN_NON_FATAL(OpenFileForReading(dex_path));
args.Add("--apk-fd=%d", dex_file->Fd());
fd_logger.Add(*dex_file);
std::unique_ptr<NewFile> dst =
OR_RETURN_NON_FATAL(NewFile::Create(dst_path, dst_aidl->fsPermission));
args.Add("--reference-profile-file-fd=%d", dst->Fd());
fd_logger.Add(*dst);
art_exec_args.Add("--keep-fds=%s", fd_logger.GetFds()).Add("--").Concat(std::move(args));
LOG(INFO) << "Running profman: " << Join(art_exec_args.Get(), /*separator=*/" ")
<< "\nOpened FDs: " << fd_logger;
Result<int> result = ExecAndReturnCode(art_exec_args.Get(), kShortTimeoutSec);
if (!result.ok()) {
return NonFatal("Failed to run profman: " + result.error().message());
}
LOG(INFO) << ART_FORMAT("profman returned code {}", result.value());
if (result.value() == ProfmanResult::kCopyAndUpdateNoMatch ||
result.value() == ProfmanResult::kCopyAndUpdateErrorFailedToLoadProfile) {
*aidl_return = AnalyzeCopyAndRewriteProfileFailure(
&src, static_cast<ProfmanResult::CopyAndUpdateResult>(result.value()));
return ScopedAStatus::ok();
}
if (result.value() != ProfmanResult::kCopyAndUpdateSuccess) {
return NonFatal(ART_FORMAT("profman returned an unexpected code: {}", result.value()));
}
OR_RETURN_NON_FATAL(dst->Keep());
aidl_return->status = CopyAndRewriteProfileResult::Status::SUCCESS;
dst_aidl->profilePath.id = dst->TempId();
dst_aidl->profilePath.tmpPath = dst->TempPath();
return ScopedAStatus::ok();
}
ndk::ScopedAStatus Artd::copyAndRewriteProfile(const ProfilePath& in_src,
OutputProfile* in_dst,
const std::string& in_dexFile,
CopyAndRewriteProfileResult* _aidl_return) {
std::string src_path = OR_RETURN_FATAL(BuildProfileOrDmPath(in_src));
Result<std::unique_ptr<File>> src = OpenFileForReading(src_path);
if (!src.ok()) {
if (src.error().code() == ENOENT) {
_aidl_return->status = CopyAndRewriteProfileResult::Status::NO_PROFILE;
return ScopedAStatus::ok();
}
return NonFatal(
ART_FORMAT("Failed to open src profile '{}': {}", src_path, src.error().message()));
}
return CopyAndRewriteProfileImpl(std::move(*src.value()), in_dst, in_dexFile, _aidl_return);
}
ndk::ScopedAStatus Artd::copyAndRewriteEmbeddedProfile(OutputProfile* in_dst,
const std::string& in_dexFile,
CopyAndRewriteProfileResult* _aidl_return) {
OR_RETURN_FATAL(ValidateDexPath(in_dexFile));
Result<File> src = ExtractEmbeddedProfileToFd(in_dexFile);
if (!src.ok()) {
return NonFatal(ART_FORMAT(
"Failed to extract profile from dex file '{}': {}", in_dexFile, src.error().message()));
}
if (!src->IsValid()) {
_aidl_return->status = CopyAndRewriteProfileResult::Status::NO_PROFILE;
return ScopedAStatus::ok();
}
return CopyAndRewriteProfileImpl(std::move(src.value()), in_dst, in_dexFile, _aidl_return);
}
ndk::ScopedAStatus Artd::commitTmpProfile(const TmpProfilePath& in_profile) {
std::string tmp_profile_path = OR_RETURN_FATAL(BuildTmpProfilePath(in_profile));
std::string ref_profile_path = OR_RETURN_FATAL(BuildFinalProfilePath(in_profile));
std::error_code ec;
std::filesystem::rename(tmp_profile_path, ref_profile_path, ec);
if (ec) {
return NonFatal(ART_FORMAT(
"Failed to move '{}' to '{}': {}", tmp_profile_path, ref_profile_path, ec.message()));
}
return ScopedAStatus::ok();
}
ndk::ScopedAStatus Artd::deleteProfile(const ProfilePath& in_profile) {
std::string profile_path = OR_RETURN_FATAL(BuildProfileOrDmPath(in_profile));
std::error_code ec;
std::filesystem::remove(profile_path, ec);
if (ec) {
LOG(ERROR) << ART_FORMAT("Failed to remove '{}': {}", profile_path, ec.message());
}
return ScopedAStatus::ok();
}
ndk::ScopedAStatus Artd::getProfileVisibility(const ProfilePath& in_profile,
FileVisibility* _aidl_return) {
std::string profile_path = OR_RETURN_FATAL(BuildProfileOrDmPath(in_profile));
*_aidl_return = OR_RETURN_NON_FATAL(GetFileVisibility(profile_path));
return ScopedAStatus::ok();
}
ndk::ScopedAStatus Artd::getArtifactsVisibility(const ArtifactsPath& in_artifactsPath,
FileVisibility* _aidl_return) {
std::string oat_path = OR_RETURN_FATAL(BuildOatPath(in_artifactsPath));
*_aidl_return = OR_RETURN_NON_FATAL(GetFileVisibility(oat_path));
return ScopedAStatus::ok();
}
ndk::ScopedAStatus Artd::getDexFileVisibility(const std::string& in_dexFile,
FileVisibility* _aidl_return) {
OR_RETURN_FATAL(ValidateDexPath(in_dexFile));
*_aidl_return = OR_RETURN_NON_FATAL(GetFileVisibility(in_dexFile));
return ScopedAStatus::ok();
}
ndk::ScopedAStatus Artd::getDmFileVisibility(const DexMetadataPath& in_dmFile,
FileVisibility* _aidl_return) {
std::string dm_path = OR_RETURN_FATAL(BuildDexMetadataPath(in_dmFile));
*_aidl_return = OR_RETURN_NON_FATAL(GetFileVisibility(dm_path));
return ScopedAStatus::ok();
}
ndk::ScopedAStatus Artd::mergeProfiles(const std::vector<ProfilePath>& in_profiles,
const std::optional<ProfilePath>& in_referenceProfile,
OutputProfile* in_outputProfile,
const std::vector<std::string>& in_dexFiles,
const MergeProfileOptions& in_options,
bool* _aidl_return) {
std::vector<std::string> profile_paths;
for (const ProfilePath& profile : in_profiles) {
std::string profile_path = OR_RETURN_FATAL(BuildProfileOrDmPath(profile));
if (profile.getTag() == ProfilePath::dexMetadataPath) {
return Fatal(ART_FORMAT("Does not support DM file, got '{}'", profile_path));
}
profile_paths.push_back(std::move(profile_path));
}
std::string output_profile_path =
OR_RETURN_FATAL(BuildFinalProfilePath(in_outputProfile->profilePath));
for (const std::string& dex_file : in_dexFiles) {
OR_RETURN_FATAL(ValidateDexPath(dex_file));
}
if (in_options.forceMerge + in_options.dumpOnly + in_options.dumpClassesAndMethods > 1) {
return Fatal("Only one of 'forceMerge', 'dumpOnly', and 'dumpClassesAndMethods' can be set");
}
FdLogger fd_logger;
CmdlineBuilder art_exec_args;
art_exec_args.Add(OR_RETURN_FATAL(GetArtExec())).Add("--drop-capabilities");
CmdlineBuilder args;
args.Add(OR_RETURN_FATAL(GetProfman()));
std::vector<std::unique_ptr<File>> profile_files;
for (const std::string& profile_path : profile_paths) {
Result<std::unique_ptr<File>> profile_file = OpenFileForReading(profile_path);
if (!profile_file.ok()) {
if (profile_file.error().code() == ENOENT) {
// Skip non-existing file.
continue;
}
return NonFatal(ART_FORMAT(
"Failed to open profile '{}': {}", profile_path, profile_file.error().message()));
}
args.Add("--profile-file-fd=%d", profile_file.value()->Fd());
fd_logger.Add(*profile_file.value());
profile_files.push_back(std::move(profile_file.value()));
}
if (profile_files.empty()) {
LOG(INFO) << "Merge skipped because there are no existing profiles";
*_aidl_return = false;
return ScopedAStatus::ok();
}
std::unique_ptr<NewFile> output_profile_file =
OR_RETURN_NON_FATAL(NewFile::Create(output_profile_path, in_outputProfile->fsPermission));
if (in_referenceProfile.has_value()) {
if (in_options.dumpOnly || in_options.dumpClassesAndMethods) {
return Fatal(
"Reference profile must not be set when 'dumpOnly' or 'dumpClassesAndMethods' is set");
}
std::string reference_profile_path =
OR_RETURN_FATAL(BuildProfileOrDmPath(*in_referenceProfile));
if (in_referenceProfile->getTag() == ProfilePath::dexMetadataPath) {
return Fatal(ART_FORMAT("Does not support DM file, got '{}'", reference_profile_path));
}
OR_RETURN_NON_FATAL(CopyFile(reference_profile_path, *output_profile_file));
}
if (in_options.dumpOnly || in_options.dumpClassesAndMethods) {
args.Add("--dump-output-to-fd=%d", output_profile_file->Fd());
} else {
// profman is ok with this being an empty file when in_referenceProfile isn't set.
args.Add("--reference-profile-file-fd=%d", output_profile_file->Fd());
}
fd_logger.Add(*output_profile_file);
std::vector<std::unique_ptr<File>> dex_files;
for (const std::string& dex_path : in_dexFiles) {
std::unique_ptr<File> dex_file = OR_RETURN_NON_FATAL(OpenFileForReading(dex_path));
args.Add("--apk-fd=%d", dex_file->Fd());
fd_logger.Add(*dex_file);
dex_files.push_back(std::move(dex_file));
}
if (in_options.dumpOnly || in_options.dumpClassesAndMethods) {
args.Add(in_options.dumpOnly ? "--dump-only" : "--dump-classes-and-methods");
} else {
args.AddIfNonEmpty("--min-new-classes-percent-change=%s",
props_->GetOrEmpty("dalvik.vm.bgdexopt.new-classes-percent"))
.AddIfNonEmpty("--min-new-methods-percent-change=%s",
props_->GetOrEmpty("dalvik.vm.bgdexopt.new-methods-percent"))
.AddIf(in_options.forceMerge, "--force-merge-and-analyze")
.AddIf(in_options.forBootImage, "--boot-image-merge");
}
art_exec_args.Add("--keep-fds=%s", fd_logger.GetFds()).Add("--").Concat(std::move(args));
LOG(INFO) << "Running profman: " << Join(art_exec_args.Get(), /*separator=*/" ")
<< "\nOpened FDs: " << fd_logger;
Result<int> result = ExecAndReturnCode(art_exec_args.Get(), kShortTimeoutSec);
if (!result.ok()) {
return NonFatal("Failed to run profman: " + result.error().message());
}
LOG(INFO) << ART_FORMAT("profman returned code {}", result.value());
if (result.value() == ProfmanResult::kSkipCompilationSmallDelta ||
result.value() == ProfmanResult::kSkipCompilationEmptyProfiles) {
*_aidl_return = false;
return ScopedAStatus::ok();
}
ProfmanResult::ProcessingResult expected_result =
(in_options.dumpOnly || in_options.dumpClassesAndMethods) ? ProfmanResult::kSuccess :
ProfmanResult::kCompile;
if (result.value() != expected_result) {
return NonFatal(ART_FORMAT("profman returned an unexpected code: {}", result.value()));
}
OR_RETURN_NON_FATAL(output_profile_file->Keep());
*_aidl_return = true;
in_outputProfile->profilePath.id = output_profile_file->TempId();
in_outputProfile->profilePath.tmpPath = output_profile_file->TempPath();
return ScopedAStatus::ok();
}
ndk::ScopedAStatus Artd::getDexoptNeeded(const std::string& in_dexFile,
const std::string& in_instructionSet,
const std::optional<std::string>& in_classLoaderContext,
const std::string& in_compilerFilter,
int32_t in_dexoptTrigger,
GetDexoptNeededResult* _aidl_return) {
Result<OatFileAssistantContext*> ofa_context = GetOatFileAssistantContext();
if (!ofa_context.ok()) {
return NonFatal("Failed to get runtime options: " + ofa_context.error().message());
}
std::unique_ptr<ClassLoaderContext> context;
std::string error_msg;
auto oat_file_assistant = OatFileAssistant::Create(in_dexFile,
in_instructionSet,
in_classLoaderContext,
/*load_executable=*/false,
/*only_load_trusted_executable=*/true,
ofa_context.value(),
&context,
&error_msg);
if (oat_file_assistant == nullptr) {
return NonFatal("Failed to create OatFileAssistant: " + error_msg);
}
OatFileAssistant::DexOptStatus status;
_aidl_return->isDexoptNeeded =
oat_file_assistant->GetDexOptNeeded(OR_RETURN_FATAL(ParseCompilerFilter(in_compilerFilter)),
DexOptTriggerFromAidl(in_dexoptTrigger),
&status);
_aidl_return->isVdexUsable = status.IsVdexUsable();
_aidl_return->artifactsLocation = ArtifactsLocationToAidl(status.GetLocation());
std::optional<bool> has_dex_files = oat_file_assistant->HasDexFiles(&error_msg);
if (!has_dex_files.has_value()) {
return NonFatal("Failed to open dex file: " + error_msg);
}
_aidl_return->hasDexCode = *has_dex_files;
return ScopedAStatus::ok();
}
ndk::ScopedAStatus Artd::dexopt(
const OutputArtifacts& in_outputArtifacts,
const std::string& in_dexFile,
const std::string& in_instructionSet,
const std::optional<std::string>& in_classLoaderContext,
const std::string& in_compilerFilter,
const std::optional<ProfilePath>& in_profile,
const std::optional<VdexPath>& in_inputVdex,
const std::optional<DexMetadataPath>& in_dmFile,
PriorityClass in_priorityClass,
const DexoptOptions& in_dexoptOptions,
const std::shared_ptr<IArtdCancellationSignal>& in_cancellationSignal,
ArtdDexoptResult* _aidl_return) {
_aidl_return->cancelled = false;
std::string oat_path = OR_RETURN_FATAL(BuildOatPath(in_outputArtifacts.artifactsPath));
std::string vdex_path = OatPathToVdexPath(oat_path);
std::string art_path = OatPathToArtPath(oat_path);
OR_RETURN_FATAL(ValidateDexPath(in_dexFile));
std::optional<std::string> profile_path =
in_profile.has_value() ?
std::make_optional(OR_RETURN_FATAL(BuildProfileOrDmPath(in_profile.value()))) :
std::nullopt;
ArtdCancellationSignal* cancellation_signal =
OR_RETURN_FATAL(ToArtdCancellationSignal(in_cancellationSignal.get()));
std::unique_ptr<ClassLoaderContext> context = nullptr;
if (in_classLoaderContext.has_value()) {
context = ClassLoaderContext::Create(in_classLoaderContext.value());
if (context == nullptr) {
return Fatal(
ART_FORMAT("Class loader context '{}' is invalid", in_classLoaderContext.value()));
}
}
std::string oat_dir_path; // For restorecon, can be empty if the artifacts are in dalvik-cache.
OR_RETURN_NON_FATAL(PrepareArtifactsDirs(in_outputArtifacts, &oat_dir_path));
// First-round restorecon. artd doesn't have the permission to create files with the
// `apk_data_file` label, so we need to restorecon the "oat" directory first so that files will
// inherit `dalvikcache_data_file` rather than `apk_data_file`.