-
Notifications
You must be signed in to change notification settings - Fork 653
/
InterDex.cpp
1674 lines (1488 loc) · 60.6 KB
/
InterDex.cpp
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) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/
#include "InterDex.h"
#include <boost/algorithm/string/predicate.hpp>
#include <algorithm>
#include <cinttypes>
#include <string>
#include <unordered_set>
#include <vector>
#include "CppUtil.h"
#include "Creators.h"
#include "Debug.h"
#include "DexAsm.h"
#include "DexClass.h"
#include "DexLoader.h"
#include "DexOutput.h"
#include "IOUtil.h"
#include "IRCode.h"
#include "IRInstruction.h"
#include "InterDexPassPlugin.h"
#include "MethodProfiles.h"
#include "ReachableClasses.h"
#include "Show.h"
#include "StlUtil.h"
#include "StringUtil.h"
#include "Walkers.h"
#include "WorkQueue.h"
#include "file-utils.h"
namespace {
constexpr const char* END_MARKER_FORMAT = "LDexEndMarker";
constexpr const char* SCROLL_SET_START_FORMAT = "LScrollSetStart";
constexpr const char* SCROLL_SET_END_FORMAT = "LScrollSetEnd";
constexpr const char* BG_SET_START_FORMAT = "LBackgroundSetStart";
constexpr const char* BG_SET_END_FORMAT = "LBackgroundSetEnd";
// This is only necessary when "exclude_baseline_profile_classes" and
// "include_betamap_20pct_coldstart" are set.
constexpr const char* COLD_START_20PCT_END_FORMAT = "LColdStart20PctEnd";
constexpr const char* COLD_START_1PCT_END_FORMAT = "LColdStart1PctEnd";
static DexInfo EMPTY_DEX_INFO;
std::unordered_set<DexClass*> find_unrefenced_coldstart_classes(
const Scope& scope,
const std::vector<DexType*>& interdex_types,
bool static_prune_classes,
ClassReferencesCache& class_references_cache) {
int old_no_ref = -1;
int new_no_ref = 0;
std::unordered_set<DexType*> coldstart_classes(interdex_types.begin(),
interdex_types.end());
std::unordered_set<DexType*> cold_cold_references;
std::unordered_set<DexClass*> unreferenced_classes;
Scope input_scope = scope;
// Don't do analysis if we're not doing pruning.
if (!static_prune_classes) {
return unreferenced_classes;
}
while (old_no_ref != new_no_ref) {
old_no_ref = new_no_ref;
new_no_ref = 0;
cold_cold_references.clear();
walk::code(
input_scope,
[&](DexMethod* meth) {
return coldstart_classes.count(meth->get_class()) > 0;
},
[&](DexMethod* meth, const IRCode& code) {
auto base_cls = meth->get_class();
always_assert(meth->get_code()->editable_cfg_built());
for (auto& mie : cfg::InstructionIterable(meth->get_code()->cfg())) {
auto inst = mie.insn;
DexType* called_cls = nullptr;
if (inst->has_method()) {
called_cls = inst->get_method()->get_class();
} else if (inst->has_field()) {
called_cls = inst->get_field()->get_class();
} else if (inst->has_type()) {
called_cls = inst->get_type();
}
if (called_cls != nullptr && base_cls != called_cls &&
coldstart_classes.count(called_cls) > 0) {
cold_cold_references.insert(called_cls);
}
}
});
for (const auto& cls : scope) {
// Make sure we don't drop classes which might be
// called from native code.
if (!can_rename(cls)) {
cold_cold_references.insert(cls->get_type());
}
}
// Get all classes in the reference set, even if they are not referenced by
// opcodes directly.
for (const auto& cls : input_scope) {
if (cold_cold_references.count(cls->get_type())) {
const auto& refs = class_references_cache.get(cls);
for (const auto& type : refs.types) {
cold_cold_references.insert(type);
}
}
}
Scope output_scope;
for (auto& cls : coldstart_classes) {
if (can_rename(type_class(cls)) && cold_cold_references.count(cls) == 0) {
new_no_ref++;
unreferenced_classes.insert(type_class(cls));
} else {
output_scope.push_back(type_class(cls));
}
}
TRACE(IDEX, 4, "Found %d classes in coldstart with no references.",
new_no_ref);
input_scope = output_scope;
}
return unreferenced_classes;
}
void gather_refs(
ClassReferencesCache& class_references_cache,
const std::vector<std::unique_ptr<interdex::InterDexPassPlugin>>& plugins,
const DexClass* cls,
MethodRefs* mrefs,
FieldRefs* frefs,
TypeRefs* trefs,
TypeRefs* itrefs) {
const auto& refs = class_references_cache.get(cls);
mrefs->insert(refs.method_refs.begin(), refs.method_refs.end());
frefs->insert(refs.field_refs.begin(), refs.field_refs.end());
trefs->insert(refs.types.begin(), refs.types.end());
itrefs->insert(refs.init_types.begin(), refs.init_types.end());
std::vector<DexMethodRef*> method_refs;
std::vector<DexFieldRef*> field_refs;
std::vector<DexType*> type_refs;
std::vector<DexType*> init_type_refs;
for (const auto& plugin : plugins) {
plugin->gather_refs(cls, method_refs, field_refs, type_refs,
init_type_refs);
}
mrefs->insert(method_refs.begin(), method_refs.end());
frefs->insert(field_refs.begin(), field_refs.end());
trefs->insert(type_refs.begin(), type_refs.end());
itrefs->insert(init_type_refs.begin(), init_type_refs.end());
}
void print_stats(DexesStructure* dexes_structure) {
TRACE(IDEX, 2, "InterDex Stats:");
TRACE(IDEX, 2, "\t dex count: %zu", dexes_structure->get_num_dexes());
TRACE(IDEX, 2, "\t secondary dex count: %zu",
dexes_structure->get_num_secondary_dexes());
TRACE(IDEX, 2, "\t coldstart dex count: %zu",
dexes_structure->get_num_coldstart_dexes());
TRACE(IDEX, 2, "\t extendex dex count: %zu",
dexes_structure->get_num_extended_dexes());
TRACE(IDEX, 2, "\t scroll dex count: %zu",
dexes_structure->get_num_scroll_dexes());
TRACE(IDEX, 2, "Global stats:");
TRACE(IDEX, 2, "\t %zu classes", dexes_structure->get_num_classes());
TRACE(IDEX, 2, "\t %zu mrefs", dexes_structure->get_num_mrefs());
TRACE(IDEX, 2, "\t %zu frefs", dexes_structure->get_num_frefs());
TRACE(IDEX, 2, "\t %zu dmethods", dexes_structure->get_num_dmethods());
TRACE(IDEX, 2, "\t %zu vmethods", dexes_structure->get_num_vmethods());
TRACE(IDEX, 2, "\t %zu mrefs", dexes_structure->get_num_mrefs());
}
/**
* Order the classes in `scope` according to the`coldstart_class_names`.
*/
void do_order_classes(const std::vector<std::string>& coldstart_class_names,
Scope* scope) {
std::unordered_map<const DexClass*, uint32_t> class_to_priority;
uint32_t priority = 0;
for (const auto& class_name : coldstart_class_names) {
if (DexType* type = DexType::get_type(class_name)) {
if (auto cls = type_class(type)) {
class_to_priority[cls] = priority++;
cls->set_perf_sensitive(PerfSensitiveGroup::BETAMAP_ORDERED);
}
}
}
TRACE(IDEX, 3, "IDEX: Ordered around %d classes at the beginning", priority);
std::stable_sort(
scope->begin(), scope->end(),
[&class_to_priority](const DexClass* left, const DexClass* right) {
uint32_t left_priority = std::numeric_limits<uint32_t>::max();
uint32_t right_priority = std::numeric_limits<uint32_t>::max();
auto it = class_to_priority.find(left);
if (it != class_to_priority.end()) {
left_priority = it->second;
}
it = class_to_priority.find(right);
if (it != class_to_priority.end()) {
right_priority = it->second;
}
return left_priority < right_priority;
});
}
// Perf sensitive classes and all the classes they reference via super classes
// can not be dynamically_dead.
void exclude_extra_dynamically_dead_class(
const std::vector<DexClass*>& candidates) {
for (auto const& cls : candidates) {
DexType* super_type;
super_type = cls->get_super_class();
while (super_type) {
DexClass* super_cls = type_class(super_type);
if (super_cls->is_dynamically_dead()) {
super_cls->set_dynamically_dead(false);
}
super_type = super_cls->get_super_class();
}
}
}
} // namespace
namespace interdex {
void InterDex::get_movable_coldstart_classes(
const std::vector<DexType*>& interdex_types,
std::unordered_map<const DexClass*, std::string>& move_coldstart_classes) {
auto class_freqs = m_conf.get_class_frequencies();
const std::vector<std::string>& interactions = m_conf.get_interactions();
always_assert_log(!class_freqs.empty(), "empty class freqs map");
// all betamaps should have a ColdStart section, so this is a sanity check
auto coldstart_it =
std::find(interactions.begin(), interactions.end(), "ColdStart");
always_assert_log(coldstart_it != interactions.end(),
"no ColdStart in class frequencies");
size_t coldstart_idx = std::distance(interactions.begin(), coldstart_it);
auto backgroundset_it =
std::find(interactions.begin(), interactions.end(), "BackgroundSet");
size_t backgroundset_idx =
backgroundset_it != interactions.end()
? std::distance(interactions.begin(), backgroundset_it)
: interactions.size();
size_t curr_idx = coldstart_idx;
for (auto* type : interdex_types) {
DexClass* cls = type_class(type);
if (!cls) {
if (boost::algorithm::starts_with(type->get_name()->str(),
BG_SET_START_FORMAT)) {
curr_idx = backgroundset_idx;
continue;
}
auto index_it = std::find(interactions.begin(), interactions.end(),
type->str().substr(1, type->str().size() - 8));
if (index_it == interactions.end()) {
continue;
}
curr_idx = std::distance(interactions.begin(), index_it);
continue;
}
if (class_freqs.count(cls->get_name()) != 1) {
continue;
}
auto freqs = class_freqs.at(cls->get_name());
if (freqs.size() <= curr_idx) {
continue;
}
auto curr_interaction_freq = freqs.at(curr_idx);
if (curr_interaction_freq == 0) {
continue;
}
// if we've already marked the class for moving, don't check it again
else if (move_coldstart_classes.find(cls) != move_coldstart_classes.end()) {
continue;
}
// if the class has more than m_max_betamap_move_threshold% freq in
// coldstart, do not move it elsewhere
else if (curr_idx == coldstart_idx &&
curr_interaction_freq > m_max_betamap_move_threshold) {
continue;
} else if (curr_idx == backgroundset_idx) {
size_t max_idx = curr_idx;
bool move_class = false;
for (size_t i = 0; i < freqs.size(); i++) {
auto freq = freqs.at(i);
if (i != backgroundset_idx && freq > m_min_betamap_move_threshold) {
if (move_class) {
move_class = false;
break;
} else if (freq > freqs.at(curr_idx)) {
move_class = true;
max_idx = i;
}
}
}
if (move_class && max_idx != curr_idx) {
move_coldstart_classes.emplace(cls, interactions.at(max_idx));
TRACE(IDEX, 3, "moving %s from backgroundset to %s", SHOW(cls),
interactions.at(max_idx).c_str());
}
} else {
auto max_freq = freqs.at(curr_idx);
size_t max_idx = curr_idx;
for (size_t i = 0; i < freqs.size(); i++) {
auto freq = freqs.at(i);
// backgroundset classes are deduped from coldstart classes, so do
// not check the backgorundset frequencies when moving coldstart
// classes. The backgroundset threshold is 10%, so if the backgroundset
// frequency is at least 10%, we've already seen the class before and do
// not need to consider it again.
if (curr_idx != coldstart_idx &&
((i == coldstart_idx && freq > m_max_betamap_move_threshold) ||
(i == backgroundset_idx && freq > 10))) {
max_idx = i;
break;
}
if (freq > max_freq) {
max_freq = freq;
max_idx = i;
}
}
if (curr_idx == coldstart_idx) {
if (max_freq > curr_interaction_freq &&
max_freq > m_min_betamap_move_threshold &&
max_idx != backgroundset_idx) {
move_coldstart_classes.emplace(cls, interactions.at(max_idx));
TRACE(IDEX, 3, "moving %s from coldstart to %s", SHOW(cls),
interactions.at(max_idx).c_str());
}
} else if (max_idx != coldstart_idx && max_idx != backgroundset_idx) {
if (max_idx != curr_idx) {
move_coldstart_classes.emplace(cls, interactions.at(max_idx));
TRACE(IDEX, 3, "moving %s from %s to %s", SHOW(cls),
interactions.at(curr_idx).c_str(),
interactions.at(max_idx).c_str());
}
}
}
}
}
bool InterDex::should_skip_class_due_to_dynamically_dead(
DexClass* clazz) const {
return clazz->is_dynamically_dead();
}
bool InterDex::should_skip_class_due_to_plugin(DexClass* clazz) const {
for (const auto& plugin : m_plugins) {
if (plugin->should_skip_class(clazz)) {
TRACE(IDEX, 4, "IDEX: Skipping class from %s :: %s",
plugin->name().c_str(), SHOW(clazz));
return true;
}
}
return false;
}
InterDex::EmitResult InterDex::emit_class(
EmittingState& emitting_state,
DexInfo& dex_info,
DexClass* clazz,
bool check_if_skip,
bool perf_sensitive,
DexClass** canary_cls,
std::optional<FlushOutDexResult>* opt_fodr,
bool skip_dynamically_dead) const {
if (is_canary(clazz)) {
// Nothing to do here.
return {false, false};
}
if (emitting_state.dexes_structure.has_class(clazz)) {
TRACE(IDEX, 6, "Trying to re-add class %s!", SHOW(clazz));
return {false, false};
}
if (check_if_skip && should_skip_class_due_to_plugin(clazz)) {
return {false, false};
}
if (perf_sensitive) {
clazz->set_perf_sensitive(PerfSensitiveGroup::BETAMAP_ORDERED);
}
if (m_reorder_dynamically_dead_classes && skip_dynamically_dead &&
should_skip_class_due_to_dynamically_dead(clazz)) {
return {false, false};
}
// Calculate the extra method and field refs that we would need to add to
// the current dex if we defined clazz in it.
MethodRefs clazz_mrefs;
FieldRefs clazz_frefs;
TypeRefs clazz_trefs;
TypeRefs clazz_itrefs;
gather_refs(m_class_references_cache, m_plugins, clazz, &clazz_mrefs,
&clazz_frefs, &clazz_trefs, &clazz_itrefs);
bool fits_current_dex =
emitting_state.dexes_structure.add_class_to_current_dex(
clazz_mrefs, clazz_frefs, clazz_trefs, clazz_itrefs, clazz);
if (!fits_current_dex) {
auto fodr = flush_out_dex(emitting_state, dex_info, *canary_cls);
*canary_cls = get_canary_cls(emitting_state, dex_info);
if (opt_fodr) {
*opt_fodr = fodr;
return {false, true};
}
post_process_dex(emitting_state, fodr);
emitting_state.dexes_structure.add_class_no_checks(
clazz_mrefs, clazz_frefs, clazz_trefs, clazz_itrefs, clazz);
}
return {true, !fits_current_dex};
}
void InterDex::emit_primary_dex(
const DexClasses& primary_dex,
const std::vector<DexType*>& interdex_order,
const std::unordered_set<DexClass*>& unreferenced_classes) {
std::unordered_set<DexClass*> primary_dex_set(primary_dex.begin(),
primary_dex.end());
DexInfo primary_dex_info;
primary_dex_info.primary = true;
size_t coldstart_classes_in_primary = 0;
size_t coldstart_classes_skipped_in_primary = 0;
// Sort the primary dex according to interdex order (aka emit first the
// primary classes that appear in the interdex order, in the order that
// they appear there).
for (DexType* type : interdex_order) {
DexClass* cls = type_class(type);
if (!cls) {
continue;
}
if (primary_dex_set.count(cls) > 0) {
if (unreferenced_classes.count(cls) > 0) {
TRACE(IDEX, 5, "[primary dex]: %s no longer linked to coldstart set.",
SHOW(cls));
coldstart_classes_skipped_in_primary++;
continue;
}
emit_class(m_emitting_state, primary_dex_info, cls,
/* check_if_skip */ true,
/* perf_sensitive */ true, /* canary_cls */ nullptr);
coldstart_classes_in_primary++;
}
}
// Now add the rest.
for (DexClass* cls : primary_dex) {
emit_class(m_emitting_state, primary_dex_info, cls,
/* check_if_skip */ true,
/* perf_sensitive */ false, /* canary_cls */ nullptr);
}
TRACE(IDEX, 2,
"[primary dex]: %zu out of %zu classes in primary dex "
"from interdex list.",
coldstart_classes_in_primary, primary_dex.size());
TRACE(IDEX, 2,
"[primary dex]: %zu out of %zu classes in primary dex skipped "
"from interdex list.",
coldstart_classes_skipped_in_primary, primary_dex.size());
auto fodr = flush_out_dex(m_emitting_state, primary_dex_info,
/* canary_cls */ nullptr);
post_process_dex(m_emitting_state, fodr);
// Double check only 1 dex was created.
always_assert_log(
m_emitting_state.dexes_structure.get_num_dexes() == 1,
"[error]: Primary dex doesn't fit in only 1 dex anymore :|, but in %zu\n",
m_emitting_state.dexes_structure.get_num_dexes());
}
void InterDex::emit_interdex_classes(
DexInfo& dex_info,
const std::vector<DexType*>& interdex_types,
const std::unordered_set<DexClass*>& unreferenced_classes,
DexClass** canary_cls) {
if (interdex_types.empty()) {
TRACE(IDEX, 2, "No interdex classes passed.");
return;
}
if (!m_order_interdex) {
// We still want to mark the interdex classes as perf-sensitive, so that
// other optimizations such as outlining and sort-remaining-classes treat
// interdex classes appropriately.
for (auto* type : interdex_types) {
DexClass* cls = type_class(type);
if (cls && !unreferenced_classes.count(cls)) {
cls->set_perf_sensitive(PerfSensitiveGroup::BETAMAP_ORDERED);
m_interdex_order.emplace(cls, m_interdex_order.size());
}
}
return;
}
auto class_freqs = m_conf.get_class_frequencies();
const std::vector<std::string>& interactions = m_conf.get_interactions();
std::unordered_map<const DexClass*, std::string> move_coldstart_classes;
if (m_move_coldstart_classes) {
get_movable_coldstart_classes(interdex_types, move_coldstart_classes);
}
// NOTE: coldstart has no interaction with extended and scroll set, but that
// is not true for the later 2.
dex_info.coldstart = true;
size_t cls_skipped_in_secondary = 0;
std::string curr_interaction = "ColdStart";
bool reset_coldstart_on_overflow = false;
for (auto it = interdex_types.begin(); it != interdex_types.end(); ++it) {
DexType* type = *it;
DexClass* cls = type_class(type);
if (!cls) {
TRACE(IDEX, 5, "[interdex classes]: No such entry %s.", SHOW(type));
if (boost::algorithm::starts_with(type->get_name()->str(),
SCROLL_SET_START_FORMAT)) {
always_assert_log(
!m_emitting_scroll_set,
"Scroll start marker discovered after another scroll start marker");
always_assert_log(
!m_emitting_bg_set,
"Scroll start marker discovered between background set markers");
m_emitting_scroll_set = true;
TRACE(IDEX, 2, "Marking dex as scroll at betamap entry %zu",
std::distance(interdex_types.begin(), it));
dex_info.scroll = true;
} else if (boost::algorithm::starts_with(type->get_name()->str(),
SCROLL_SET_END_FORMAT)) {
always_assert_log(
m_emitting_scroll_set,
"Scroll end marker discovered without scroll start marker");
m_emitting_scroll_set = false;
} else if (boost::algorithm::starts_with(type->get_name()->str(),
BG_SET_START_FORMAT)) {
always_assert_log(!m_emitting_bg_set,
"Background start marker discovered after another "
"background start marker");
always_assert_log(
!m_emitting_scroll_set,
"Background start marker discovered between scroll set markers");
TRACE(IDEX, 2, "Marking dex as background at betamap entry %zu",
std::distance(interdex_types.begin(), it));
m_emitting_bg_set = true;
dex_info.background = true;
} else if (boost::algorithm::starts_with(type->get_name()->str(),
BG_SET_END_FORMAT)) {
always_assert_log(
m_emitting_bg_set,
"Background end marker discovered without background start marker");
m_emitting_bg_set = false;
m_emitted_bg_set = true;
} else {
auto end_marker =
std::find(m_end_markers.begin(), m_end_markers.end(), type);
// Cold start end marker is the last dex end marker
auto cold_start_end_marker = !m_end_markers.empty()
? m_end_markers.end() - 1
: m_end_markers.end();
if (end_marker != m_end_markers.end()) {
always_assert_log(
!m_emitting_scroll_set,
"End marker discovered between scroll start/end markers");
always_assert_log(
!m_emitting_bg_set,
"End marker discovered between background start/end markers");
TRACE(IDEX, 2, "Terminating dex due to %s", SHOW(type));
if (end_marker != cold_start_end_marker ||
!m_fill_last_coldstart_dex || m_end_markers.size() == 1) {
auto fodr = flush_out_dex(m_emitting_state, dex_info, *canary_cls);
post_process_dex(m_emitting_state, fodr);
*canary_cls = get_canary_cls(m_emitting_state, dex_info);
if (end_marker == cold_start_end_marker) {
dex_info.coldstart = false;
}
} else if (m_move_coldstart_classes &&
std::find(interactions.begin(), interactions.end(),
type->str().substr(1, type->str().size() - 8)) !=
interactions.end()) {
curr_interaction = type->str();
} else {
reset_coldstart_on_overflow = true;
TRACE(IDEX, 2, "Not flushing out marker %s to fill dex.",
SHOW(type));
}
}
}
} else {
if (unreferenced_classes.count(cls)) {
TRACE(IDEX, 3, "%s no longer linked to coldstart set.", SHOW(cls));
cls_skipped_in_secondary++;
continue;
}
if (m_emitted_bg_set) {
m_emitted_bg_set = false;
dex_info.extended = true;
m_emitting_extended = true;
}
dex_info.betamap_ordered = true;
if (m_move_coldstart_classes && move_coldstart_classes.count(cls)) {
auto interaction = move_coldstart_classes.at(cls);
if (!boost::starts_with(curr_interaction, "L" + interaction)) {
continue;
} else {
move_coldstart_classes.erase(cls);
}
}
auto res =
emit_class(m_emitting_state, dex_info, cls, /* check_if_skip */ true,
/* perf_sensitive */ true, canary_cls);
if (res.overflowed && reset_coldstart_on_overflow) {
dex_info.coldstart = false;
reset_coldstart_on_overflow = false;
TRACE(IDEX, 2, "Flushing cold-start after non-flushed end marker.");
}
}
}
// Now emit the classes we omitted from the original coldstart set.
TRACE(IDEX, 2, "Emitting %zu interdex types (reset_coldstart_on_overflow=%d)",
interdex_types.size(), reset_coldstart_on_overflow);
for (DexType* type : interdex_types) {
DexClass* cls = type_class(type);
if (cls && unreferenced_classes.count(cls)) {
auto res =
emit_class(m_emitting_state, dex_info, cls, /* check_if_skip */ true,
/* perf_sensitive */ false, canary_cls);
if (res.overflowed && reset_coldstart_on_overflow) {
dex_info.coldstart = false;
reset_coldstart_on_overflow = false;
TRACE(IDEX, 2, "Flushing cold-start after non-flushed end marker.");
}
}
}
TRACE(IDEX, 3,
"[interdex order]: %zu classes are unreferenced from the interdex "
"order in secondary dexes.",
cls_skipped_in_secondary);
// TODO: check for unterminated markers
always_assert_log(!m_emitting_scroll_set, "Unterminated scroll set marker");
always_assert_log(!m_emitting_bg_set, "Unterminated background set marker");
m_emitting_extended = false;
if (reset_coldstart_on_overflow) {
TRACE(IDEX, 2, "No overflow after cold-start dex, flushing now.");
auto fodr = flush_out_dex(m_emitting_state, dex_info, *canary_cls);
post_process_dex(m_emitting_state, fodr);
*canary_cls = get_canary_cls(m_emitting_state, dex_info);
dex_info.coldstart = false;
}
}
namespace {
/**
* Grab classes that should end up in a pre-defined interdex group.
*/
std::vector<std::vector<DexType*>> get_extra_classes_per_interdex_group(
const Scope& scope, const bool is_root_store) {
std::vector<std::vector<DexType*>> res(MAX_DEX_NUM);
InterdexSubgroupIdx num_interdex_groups = 0;
walk::classes(scope, [&](const DexClass* cls) {
// Interdex grouping is only relevant for root stores.
if (is_root_store && cls->rstate.has_interdex_subgroup()) {
InterdexSubgroupIdx interdex_subgroup =
cls->rstate.get_interdex_subgroup();
res[interdex_subgroup].push_back(cls->get_type());
num_interdex_groups =
std::max(num_interdex_groups, interdex_subgroup + 1);
}
});
TRACE(IDEX, 3,
" Populated interdex group with extra classes: num_interdex_groups %u",
num_interdex_groups);
res.resize(num_interdex_groups);
return res;
}
} // namespace
void InterDex::load_interdex_types() {
always_assert(m_interdex_types.empty());
const std::vector<std::string>& interdexorder =
m_conf.get_coldstart_classes();
// Find generated classes that should be in the interdex order.
std::vector<std::vector<DexType*>> interdex_group_classes =
get_extra_classes_per_interdex_group(m_scope, m_is_root_store);
size_t curr_interdex_group = 0;
std::unordered_set<DexClass*> classes(m_scope.begin(), m_scope.end());
std::unordered_set<DexType*> all_set{};
if (m_transitively_close_interdex_order && !m_force_single_dex) {
for (auto* cls : m_dexen[0]) {
all_set.insert(cls->get_type()); // Ignore primary.
}
}
std::unordered_set<DexType*> moved_or_double{};
std::unordered_set<DexType*> transitive_added{};
const std::vector<std::string>* interactions;
if (m_move_coldstart_classes) {
interactions = &m_conf.get_interactions();
}
for (const auto& entry : interdexorder) {
DexType* type = DexType::get_type(entry);
if (!type) {
if (boost::algorithm::starts_with(entry, END_MARKER_FORMAT)) {
type = DexType::make_type(entry);
m_end_markers.emplace_back(type);
if (interdex_group_classes.size() > curr_interdex_group) {
for (DexType* extra_type :
interdex_group_classes.at(curr_interdex_group)) {
m_interdex_types.emplace_back(extra_type);
}
curr_interdex_group++;
}
TRACE(IDEX, 4, "[interdex order]: Found class end marker %s.",
entry.c_str());
} else if (boost::algorithm::starts_with(entry,
SCROLL_SET_START_FORMAT)) {
type = DexType::make_type(entry);
TRACE(IDEX, 4,
"[interdex order]: Found scroll set start class marker %s.",
entry.c_str());
} else if (boost::algorithm::starts_with(entry, SCROLL_SET_END_FORMAT)) {
type = DexType::make_type(entry);
TRACE(IDEX, 4,
"[interdex order]: Found scroll set end class marker %s.",
entry.c_str());
} else if (boost::algorithm::starts_with(entry, BG_SET_START_FORMAT)) {
type = DexType::make_type(entry);
TRACE(IDEX, 4, "[interdex order]: Found bg set start class marker %s.",
entry.c_str());
} else if (boost::algorithm::starts_with(entry, BG_SET_END_FORMAT)) {
type = DexType::make_type(entry);
TRACE(IDEX, 4, "[interdex order]: Found bg set end class marker %s.",
entry.c_str());
} else if (boost::algorithm::starts_with(entry,
COLD_START_20PCT_END_FORMAT)) {
type = DexType::make_type(entry);
TRACE(IDEX, 4,
"[interdex order]: Found 20pct cold start end class marker %s.",
entry.c_str());
} else if (boost::algorithm::starts_with(entry,
COLD_START_1PCT_END_FORMAT)) {
type = DexType::make_type(entry);
TRACE(IDEX, 4,
"[interdex order]: Found 1pct cold start end class marker %s.",
entry.c_str());
// trim off the _Start suffix to get the interaction name
} else if (m_move_coldstart_classes &&
std::find(interactions->begin(), interactions->end(),
entry.substr(1, entry.size() - 8)) !=
interactions->end()) {
type = DexType::make_type(entry);
} else {
continue;
}
} else {
DexClass* cls = type_class(type);
if (!cls || classes.count(cls) == 0) {
continue;
}
if (cls->rstate.has_interdex_subgroup()) {
// Skipping generated classes that should end up in a specific group.
continue;
}
if (m_transitively_close_interdex_order) {
if (all_set.count(type) != 0) {
// Moved earlier.
moved_or_double.insert(type);
continue;
}
// Transitive closure.
self_recursive_fn(
[&](const auto& self, DexType* cur, bool add_self) {
DexClass* cur_cls = type_class(cur);
if (!cur_cls || classes.count(cur_cls) == 0 ||
all_set.count(cur) != 0 ||
cur_cls->rstate.has_interdex_subgroup()) {
return;
}
all_set.insert(cur);
if (add_self) {
transitive_added.insert(cur);
}
// Superclass first.
self(self, cur_cls->get_super_class(), true);
// Then interfaces.
for (auto* intf : *cur_cls->get_interfaces()) {
self(self, intf, true);
}
// Then self.
if (add_self) {
m_interdex_types.emplace_back(cur);
}
},
type, false);
}
}
m_interdex_types.emplace_back(type);
}
// We still want to add the ones in the last interdex group, if any.
always_assert_log(interdex_group_classes.size() <= curr_interdex_group + 2,
"Too many interdex subgroups! interdex group size %zu; "
"curr_interdex_group %zu\n",
interdex_group_classes.size(), curr_interdex_group);
if (interdex_group_classes.size() > curr_interdex_group) {
for (DexType* type : interdex_group_classes.at(curr_interdex_group)) {
// TODO: Does the above need to filter? Do we need to transitively close
// here, too?
if (!m_transitively_close_interdex_order || all_set.count(type) == 0) {
m_interdex_types.push_back(type);
}
}
}
if (m_transitively_close_interdex_order) {
std::unordered_set<DexType*> transitive_moved;
for (auto* t : moved_or_double) {
if (transitive_added.count(t) != 0) {
transitive_moved.insert(t);
transitive_added.erase(t);
}
}
m_transitive_closure_added = transitive_added.size();
m_transitive_closure_moved = transitive_moved.size();
}
}
void InterDex::update_interdexorder(const DexClasses& dex,
std::vector<DexType*>* interdex_types) {
std::vector<DexType*> primary_dex;
for (DexClass* cls : dex) {
primary_dex.emplace_back(cls->get_type());
}
// We keep the primary classes untouched - at the beginning of
// the interdex list.
interdex_types->insert(interdex_types->begin(), primary_dex.begin(),
primary_dex.end());
}
void InterDex::init_cross_dex_ref_minimizer() {
TRACE(IDEX, 2,
"[dex ordering] Cross-dex-ref-minimizer active with method ref weight "
"%" PRIu64 ", field ref weight %" PRIu64 ", type ref weight %" PRIu64
", large string ref weight %" PRIu64
", small string ref weight %" PRIu64 ", method seed weight %" PRIu64
", field seed weight %" PRIu64 ", type seed weight %" PRIu64
", large string seed weight %" PRIu64
", small string seed weight %" PRIu64 ".",
m_cross_dex_ref_minimizer.get_config().method_ref_weight,
m_cross_dex_ref_minimizer.get_config().field_ref_weight,
m_cross_dex_ref_minimizer.get_config().type_ref_weight,
m_cross_dex_ref_minimizer.get_config().large_string_ref_weight,
m_cross_dex_ref_minimizer.get_config().small_string_ref_weight,
m_cross_dex_ref_minimizer.get_config().method_seed_weight,
m_cross_dex_ref_minimizer.get_config().field_seed_weight,
m_cross_dex_ref_minimizer.get_config().type_seed_weight,
m_cross_dex_ref_minimizer.get_config().large_string_seed_weight,
m_cross_dex_ref_minimizer.get_config().small_string_seed_weight);
std::vector<DexClass*> classes_to_insert;
// Emit classes using some algorithm to group together classes which
// tend to share the same refs.
for (DexClass* cls : m_scope) {
// Don't bother with classes that emit_class will skip anyway.
if (is_canary(cls) || m_emitting_state.dexes_structure.has_class(cls)) {
continue;
}
// Don't bother with classes that emit_class will skip anyway
if (should_skip_class_due_to_plugin(cls)) {
// Skipping a class due to a plugin might mean that (members of) of the
// class will get emitted later via the additional-class mechanism.
// So we'll also sample those classes here.
m_cross_dex_ref_minimizer.sample(cls);
continue;
}
// Don't bother with these classes which will be emitted at the end of
// dexes.
if (m_reorder_dynamically_dead_classes &&
should_skip_class_due_to_dynamically_dead(cls)) {
continue;
}
classes_to_insert.emplace_back(cls);
}
// Initialize ref frequency counts
for (DexClass* cls : classes_to_insert) {
m_cross_dex_ref_minimizer.sample(cls);
}
// Emit classes using some algorithm to group together classes which
// tend to share the same refs.
for (DexClass* cls : classes_to_insert) {
m_cross_dex_ref_minimizer.insert(cls);
}
// A few classes might have already been emitted to the current dex which we
// are about to fill up. Make it so that the minimizer knows that all the refs
// of those classes have already been emitted.
for (auto cls :
m_emitting_state.dexes_structure.get_current_dex().get_classes()) {
m_cross_dex_ref_minimizer.sample(cls);
m_cross_dex_ref_minimizer.insert(cls);
m_cross_dex_ref_minimizer.erase(cls, /* emitted */ true);
}
}
std::vector<DexClasses> InterDex::get_stable_partitions() {
always_assert(m_stable_partitions > 0);
std::vector<DexClasses> partitions(m_stable_partitions);
auto partition_it = partitions.begin();
size_t partition_target_size =
(m_scope.size() + m_stable_partitions - 1) / m_stable_partitions;
for (auto* cls : m_scope) {
always_assert(partition_it < partitions.end());
partition_it->push_back(cls);
if (partition_it->size() >= partition_target_size) {
partition_it++;
}
}
return partitions;
}
void InterDex::emit_remaining_classes(DexInfo& dex_info,
DexClass** canary_cls) {
m_current_classes_when_emitting_remaining =
m_emitting_state.dexes_structure.get_current_dex().size();
if (!m_minimize_cross_dex_refs) {
auto emit_classes = [&](const DexClasses& classes) {
for (DexClass* cls : classes) {
emit_class(m_emitting_state, dex_info, cls, /* check_if_skip */ true,
/* perf_sensitive */ false, canary_cls, nullptr,
/* skip_dynamically_dead */ true);
}
};
if (m_stable_partitions > 0) {
auto partitions = get_stable_partitions();