/
SystemModulesPlugin.java
1965 lines (1754 loc) · 80.6 KB
/
SystemModulesPlugin.java
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) 2015, 2024, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package jdk.tools.jlink.internal.plugins;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.lang.constant.ClassDesc;
import java.lang.constant.ConstantDesc;
import static java.lang.constant.ConstantDescs.*;
import java.lang.constant.MethodTypeDesc;
import java.lang.module.Configuration;
import java.lang.module.ModuleDescriptor;
import java.lang.module.ModuleDescriptor.Exports;
import java.lang.module.ModuleDescriptor.Opens;
import java.lang.module.ModuleDescriptor.Provides;
import java.lang.module.ModuleDescriptor.Requires;
import java.lang.module.ModuleDescriptor.Version;
import java.lang.module.ModuleFinder;
import java.lang.module.ModuleReader;
import java.lang.module.ModuleReference;
import java.lang.module.ResolvedModule;
import java.lang.reflect.ClassFileFormatVersion;
import java.net.URI;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.EnumSet;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.Set;
import java.util.TreeMap;
import java.util.TreeSet;
import java.util.function.IntSupplier;
import java.util.function.Supplier;
import java.util.stream.Collectors;
import jdk.internal.module.Checks;
import jdk.internal.module.DefaultRoots;
import jdk.internal.module.Modules;
import jdk.internal.module.ModuleHashes;
import jdk.internal.module.ModuleInfo.Attributes;
import jdk.internal.module.ModuleInfoExtender;
import jdk.internal.module.ModuleReferenceImpl;
import jdk.internal.module.ModuleResolution;
import jdk.internal.module.ModuleTarget;
import java.lang.classfile.attribute.ModulePackagesAttribute;
import java.lang.classfile.ClassBuilder;
import java.lang.classfile.ClassFile;
import java.lang.classfile.TypeKind;
import static java.lang.classfile.ClassFile.*;
import java.lang.classfile.CodeBuilder;
import jdk.tools.jlink.internal.ModuleSorter;
import jdk.tools.jlink.plugin.PluginException;
import jdk.tools.jlink.plugin.ResourcePool;
import jdk.tools.jlink.plugin.ResourcePoolBuilder;
import jdk.tools.jlink.plugin.ResourcePoolEntry;
/**
* Jlink plugin to reconstitute module descriptors and other attributes for system
* modules. The plugin generates implementations of SystemModules to avoid parsing
* module-info.class files at startup. It also generates SystemModulesMap to return
* the SystemModules implementation for a specific initial module.
*
* As a side effect, the plugin adds the ModulePackages class file attribute to the
* module-info.class files that don't have the attribute.
*
* @see jdk.internal.module.SystemModuleFinders
* @see jdk.internal.module.SystemModules
*/
public final class SystemModulesPlugin extends AbstractPlugin {
private static final int CLASSFILE_VERSION =
ClassFileFormatVersion.latest().major();
private static final String SYSTEM_MODULES_MAP_CLASSNAME =
"jdk/internal/module/SystemModulesMap";
private static final String SYSTEM_MODULES_CLASS_PREFIX =
"jdk/internal/module/SystemModules$";
private static final String ALL_SYSTEM_MODULES_CLASSNAME =
SYSTEM_MODULES_CLASS_PREFIX + "all";
private static final String DEFAULT_SYSTEM_MODULES_CLASSNAME =
SYSTEM_MODULES_CLASS_PREFIX + "default";
private static final ClassDesc CD_ALL_SYSTEM_MODULES =
ClassDesc.ofInternalName(ALL_SYSTEM_MODULES_CLASSNAME);
private static final ClassDesc CD_SYSTEM_MODULES =
ClassDesc.ofInternalName("jdk/internal/module/SystemModules");
private static final ClassDesc CD_SYSTEM_MODULES_MAP =
ClassDesc.ofInternalName(SYSTEM_MODULES_MAP_CLASSNAME);
private static final MethodTypeDesc MTD_StringArray = MethodTypeDesc.of(CD_String.arrayType());
private static final MethodTypeDesc MTD_SystemModules = MethodTypeDesc.of(CD_SYSTEM_MODULES);
private int moduleDescriptorsPerMethod = 75;
private boolean enabled;
public SystemModulesPlugin() {
super("system-modules");
this.enabled = true;
}
@Override
public Set<State> getState() {
return enabled ? EnumSet.of(State.AUTO_ENABLED, State.FUNCTIONAL)
: EnumSet.of(State.DISABLED);
}
@Override
public boolean hasArguments() {
return true;
}
@Override
public void configure(Map<String, String> config) {
String arg = config.get(getName());
if (arg != null) {
String[] split = arg.split("=");
if (split.length != 2) {
throw new IllegalArgumentException(getName() + ": " + arg);
}
if (!split[0].equals("batch-size")) {
throw new IllegalArgumentException(getName() + ": " + arg);
}
this.moduleDescriptorsPerMethod = Integer.parseInt(split[1]);
}
}
@Override
public ResourcePool transform(ResourcePool in, ResourcePoolBuilder out) {
if (!enabled) {
throw new PluginException(getName() + " was set");
}
// validate, transform (if needed), and add the module-info.class files
List<ModuleInfo> moduleInfos = transformModuleInfos(in, out);
// generate and add the SystemModuleMap and SystemModules classes
Set<String> generated = genSystemModulesClasses(moduleInfos, out);
// pass through all other resources
in.entries()
.filter(data -> !data.path().endsWith("/module-info.class")
&& !generated.contains(data.path()))
.forEach(data -> out.add(data));
return out.build();
}
/**
* Validates and transforms the module-info.class files in the modules, adding
* the ModulePackages class file attribute if needed.
*
* @return the list of ModuleInfo objects, the first element is java.base
*/
List<ModuleInfo> transformModuleInfos(ResourcePool in, ResourcePoolBuilder out) {
List<ModuleInfo> moduleInfos = new ArrayList<>();
// Sort modules in the topological order so that java.base is always first.
new ModuleSorter(in.moduleView()).sorted().forEach(module -> {
ResourcePoolEntry data = module.findEntry("module-info.class").orElseThrow(
// automatic modules not supported
() -> new PluginException("module-info.class not found for " +
module.name() + " module")
);
assert module.name().equals(data.moduleName());
try {
byte[] content = data.contentBytes();
Set<String> packages = module.packages();
ModuleInfo moduleInfo = new ModuleInfo(content, packages);
// link-time validation
moduleInfo.validateNames();
// check if any exported or open package is not present
moduleInfo.validatePackages();
// module-info.class may be overridden to add ModulePackages
if (moduleInfo.shouldRewrite()) {
data = data.copyWithContent(moduleInfo.getBytes());
}
moduleInfos.add(moduleInfo);
// add resource pool entry
out.add(data);
} catch (IOException e) {
throw new PluginException(e);
}
});
return moduleInfos;
}
/**
* Generates the SystemModules classes (at least one) and the SystemModulesMap
* class to map initial modules to a SystemModules class.
*
* @return the resource names of the resources added to the pool
*/
private Set<String> genSystemModulesClasses(List<ModuleInfo> moduleInfos,
ResourcePoolBuilder out) {
int moduleCount = moduleInfos.size();
ModuleFinder finder = finderOf(moduleInfos);
assert finder.findAll().size() == moduleCount;
// map of initial module name to SystemModules class name
Map<String, String> map = new LinkedHashMap<>();
// the names of resources written to the pool
Set<String> generated = new HashSet<>();
// generate the SystemModules implementation to reconstitute all modules
Set<String> allModuleNames = moduleInfos.stream()
.map(ModuleInfo::moduleName)
.collect(Collectors.toSet());
String rn = genSystemModulesClass(moduleInfos,
resolve(finder, allModuleNames),
ALL_SYSTEM_MODULES_CLASSNAME,
out);
generated.add(rn);
// generate, if needed, a SystemModules class to reconstitute the modules
// needed for the case that the initial module is the unnamed module.
String defaultSystemModulesClassName;
Configuration cf = resolve(finder, DefaultRoots.compute(finder));
if (cf.modules().size() == moduleCount) {
// all modules are resolved so no need to generate a class
defaultSystemModulesClassName = ALL_SYSTEM_MODULES_CLASSNAME;
} else {
defaultSystemModulesClassName = DEFAULT_SYSTEM_MODULES_CLASSNAME;
rn = genSystemModulesClass(sublist(moduleInfos, cf),
cf,
defaultSystemModulesClassName,
out);
generated.add(rn);
}
// Generate a SystemModules class for each module with a main class
int suffix = 0;
for (ModuleInfo mi : moduleInfos) {
if (mi.descriptor().mainClass().isPresent()) {
String moduleName = mi.moduleName();
cf = resolve(finder, Set.of(moduleName));
if (cf.modules().size() == moduleCount) {
// resolves all modules so no need to generate a class
map.put(moduleName, ALL_SYSTEM_MODULES_CLASSNAME);
} else {
String cn = SYSTEM_MODULES_CLASS_PREFIX + (suffix++);
rn = genSystemModulesClass(sublist(moduleInfos, cf), cf, cn, out);
map.put(moduleName, cn);
generated.add(rn);
}
}
}
// generate SystemModulesMap
rn = genSystemModulesMapClass(CD_ALL_SYSTEM_MODULES,
ClassDesc.ofInternalName(defaultSystemModulesClassName),
map,
out);
generated.add(rn);
// return the resource names of the generated classes
return generated;
}
/**
* Resolves a collection of root modules, with service binding, to create
* a Configuration for the boot layer.
*/
private Configuration resolve(ModuleFinder finder, Set<String> roots) {
return Modules.newBootLayerConfiguration(finder, roots, null);
}
/**
* Returns the list of ModuleInfo objects that correspond to the modules in
* the given configuration.
*/
private List<ModuleInfo> sublist(List<ModuleInfo> moduleInfos, Configuration cf) {
Set<String> names = cf.modules()
.stream()
.map(ResolvedModule::name)
.collect(Collectors.toSet());
return moduleInfos.stream()
.filter(mi -> names.contains(mi.moduleName()))
.toList();
}
/**
* Generate a SystemModules implementation class and add it as a resource.
*
* @return the name of the class resource added to the pool
*/
private String genSystemModulesClass(List<ModuleInfo> moduleInfos,
Configuration cf,
String className,
ResourcePoolBuilder out) {
SystemModulesClassGenerator generator
= new SystemModulesClassGenerator(className, moduleInfos, moduleDescriptorsPerMethod);
byte[] bytes = generator.genClassBytes(cf);
String rn = "/java.base/" + className + ".class";
ResourcePoolEntry e = ResourcePoolEntry.create(rn, bytes);
out.add(e);
return rn;
}
static class ModuleInfo {
private final ByteArrayInputStream bais;
private final Attributes attrs;
private final Set<String> packages;
private final boolean addModulePackages;
private ModuleDescriptor descriptor; // may be different that the original one
ModuleInfo(byte[] bytes, Set<String> packages) throws IOException {
this.bais = new ByteArrayInputStream(bytes);
this.packages = packages;
this.attrs = jdk.internal.module.ModuleInfo.read(bais, null);
// If ModulePackages attribute is present, the packages from this
// module descriptor returns the packages in that attribute.
// If it's not present, ModuleDescriptor::packages only contains
// the exported and open packages from module-info.class
this.descriptor = attrs.descriptor();
if (descriptor.isAutomatic()) {
throw new InternalError("linking automatic module is not supported");
}
// add ModulePackages attribute if this module contains some packages
// and ModulePackages is not present
this.addModulePackages = packages.size() > 0 && !hasModulePackages();
}
String moduleName() {
return attrs.descriptor().name();
}
ModuleDescriptor descriptor() {
return descriptor;
}
Set<String> packages() {
return packages;
}
ModuleTarget target() {
return attrs.target();
}
ModuleHashes recordedHashes() {
return attrs.recordedHashes();
}
ModuleResolution moduleResolution() {
return attrs.moduleResolution();
}
/**
* Validates names in ModuleDescriptor
*/
void validateNames() {
Checks.requireModuleName(descriptor.name());
for (Requires req : descriptor.requires()) {
Checks.requireModuleName(req.name());
}
for (Exports e : descriptor.exports()) {
Checks.requirePackageName(e.source());
if (e.isQualified())
e.targets().forEach(Checks::requireModuleName);
}
for (Opens opens : descriptor.opens()) {
Checks.requirePackageName(opens.source());
if (opens.isQualified())
opens.targets().forEach(Checks::requireModuleName);
}
for (Provides provides : descriptor.provides()) {
Checks.requireServiceTypeName(provides.service());
provides.providers().forEach(Checks::requireServiceProviderName);
}
for (String service : descriptor.uses()) {
Checks.requireServiceTypeName(service);
}
for (String pn : descriptor.packages()) {
Checks.requirePackageName(pn);
}
for (String pn : packages) {
Checks.requirePackageName(pn);
}
}
/**
* Validates if exported and open packages are present
*/
void validatePackages() {
Set<String> nonExistPackages = new TreeSet<>();
descriptor.exports().stream()
.map(Exports::source)
.filter(pn -> !packages.contains(pn))
.forEach(nonExistPackages::add);
descriptor.opens().stream()
.map(Opens::source)
.filter(pn -> !packages.contains(pn))
.forEach(nonExistPackages::add);
if (!nonExistPackages.isEmpty()) {
throw new PluginException("Packages that are exported or open in "
+ descriptor.name() + " are not present: " + nonExistPackages);
}
}
boolean hasModulePackages() throws IOException {
try (InputStream in = getInputStream()) {
// parse module-info.class
return ClassFile.of().parse(in.readAllBytes()).elementStream()
.anyMatch(e -> e instanceof ModulePackagesAttribute mpa
&& !mpa.packages().isEmpty());
}
}
/**
* Returns true if module-info.class should be rewritten to add the
* ModulePackages attribute.
*/
boolean shouldRewrite() {
return addModulePackages;
}
/**
* Returns the bytes for the (possibly updated) module-info.class.
*/
byte[] getBytes() throws IOException {
try (InputStream in = getInputStream()) {
if (shouldRewrite()) {
ModuleInfoRewriter rewriter = new ModuleInfoRewriter(in);
if (addModulePackages) {
rewriter.addModulePackages(packages);
}
// rewritten module descriptor
byte[] bytes = rewriter.getBytes();
try (ByteArrayInputStream bais = new ByteArrayInputStream(bytes)) {
this.descriptor = ModuleDescriptor.read(bais);
}
return bytes;
} else {
return in.readAllBytes();
}
}
}
/*
* Returns the input stream of the module-info.class
*/
InputStream getInputStream() {
bais.reset();
return bais;
}
static class ModuleInfoRewriter extends ByteArrayOutputStream {
final ModuleInfoExtender extender;
ModuleInfoRewriter(InputStream in) {
this.extender = ModuleInfoExtender.newExtender(in);
}
void addModulePackages(Set<String> packages) {
// Add ModulePackages attribute
if (packages.size() > 0) {
extender.packages(packages);
}
}
byte[] getBytes() throws IOException {
extender.write(this);
return buf;
}
}
}
/**
* Generates a SystemModules class to reconstitute the ModuleDescriptor
* and other attributes of system modules.
*/
static class SystemModulesClassGenerator {
private static final ClassDesc CD_MODULE_DESCRIPTOR =
ClassDesc.ofInternalName("java/lang/module/ModuleDescriptor");
private static final ClassDesc CD_MODULE_BUILDER =
ClassDesc.ofInternalName("jdk/internal/module/Builder");
private static final ClassDesc CD_REQUIRES_MODIFIER =
ClassDesc.ofInternalName("java/lang/module/ModuleDescriptor$Requires$Modifier");
private static final ClassDesc CD_EXPORTS_MODIFIER =
ClassDesc.ofInternalName("java/lang/module/ModuleDescriptor$Exports$Modifier");
private static final ClassDesc CD_OPENS_MODIFIER =
ClassDesc.ofInternalName("java/lang/module/ModuleDescriptor$Opens$Modifier");
private static final ClassDesc CD_MODULE_TARGET =
ClassDesc.ofInternalName("jdk/internal/module/ModuleTarget");
private static final ClassDesc CD_MODULE_HASHES =
ClassDesc.ofInternalName("jdk/internal/module/ModuleHashes");
private static final ClassDesc CD_MODULE_RESOLUTION =
ClassDesc.ofInternalName("jdk/internal/module/ModuleResolution");
private static final ClassDesc CD_Map_Entry = ClassDesc.ofInternalName("java/util/Map$Entry");
private static final MethodTypeDesc MTD_boolean = MethodTypeDesc.of(CD_boolean);
private static final MethodTypeDesc MTD_ModuleDescriptorArray = MethodTypeDesc.of(CD_MODULE_DESCRIPTOR.arrayType());
private static final MethodTypeDesc MTD_ModuleTargetArray = MethodTypeDesc.of(CD_MODULE_TARGET.arrayType());
private static final MethodTypeDesc MTD_void_String = MethodTypeDesc.of(CD_void, CD_String);
private static final MethodTypeDesc MTD_void_int = MethodTypeDesc.of(CD_void, CD_int);
private static final MethodTypeDesc MTD_ModuleHashesArray = MethodTypeDesc.of(CD_MODULE_HASHES.arrayType());
private static final MethodTypeDesc MTD_ModuleResolutionArray = MethodTypeDesc.of(CD_MODULE_RESOLUTION.arrayType());
private static final MethodTypeDesc MTD_Map = MethodTypeDesc.of(CD_Map);
private static final MethodTypeDesc MTD_MapEntry_Object_Object = MethodTypeDesc.of(CD_Map_Entry, CD_Object, CD_Object);
private static final MethodTypeDesc MTD_Map_MapEntryArray = MethodTypeDesc.of(CD_Map, CD_Map_Entry.arrayType());
private static final MethodTypeDesc MTD_Set_ObjectArray = MethodTypeDesc.of(CD_Set, CD_Object.arrayType());
private static final int MAX_LOCAL_VARS = 256;
private final int MD_VAR = 1; // variable for ModuleDescriptor
private final int MT_VAR = 1; // variable for ModuleTarget
private final int MH_VAR = 1; // variable for ModuleHashes
private final int DEDUP_LIST_VAR = 2;
private final int BUILDER_VAR = 3;
private int nextLocalVar = 4; // index to next local variable
// name of class to generate
private final ClassDesc classDesc;
// list of all ModuleInfos
private final List<ModuleInfo> moduleInfos;
private final int moduleDescriptorsPerMethod;
// A builder to create one single Set instance for a given set of
// names or modifiers to reduce the footprint
// e.g. target modules of qualified exports
private final DedupSetBuilder dedupSetBuilder
= new DedupSetBuilder(this::getNextLocalVar);
public SystemModulesClassGenerator(String className,
List<ModuleInfo> moduleInfos,
int moduleDescriptorsPerMethod) {
this.classDesc = ClassDesc.ofInternalName(className);
this.moduleInfos = moduleInfos;
this.moduleDescriptorsPerMethod = moduleDescriptorsPerMethod;
moduleInfos.forEach(mi -> dedups(mi.descriptor()));
}
private int getNextLocalVar() {
return nextLocalVar++;
}
/*
* Adds the given ModuleDescriptor to the system module list.
* It performs link-time validation and prepares mapping from various
* Sets to SetBuilders to emit an optimized number of sets during build.
*/
private void dedups(ModuleDescriptor md) {
// exports
for (Exports e : md.exports()) {
dedupSetBuilder.stringSet(e.targets());
dedupSetBuilder.exportsModifiers(e.modifiers());
}
// opens
for (Opens opens : md.opens()) {
dedupSetBuilder.stringSet(opens.targets());
dedupSetBuilder.opensModifiers(opens.modifiers());
}
// requires
for (Requires r : md.requires()) {
dedupSetBuilder.requiresModifiers(r.modifiers());
}
// uses
dedupSetBuilder.stringSet(md.uses());
}
/**
* Generate SystemModules class
*/
public byte[] genClassBytes(Configuration cf) {
return ClassFile.of().build(classDesc,
clb -> {
clb.withFlags(ACC_FINAL + ACC_SUPER)
.withInterfaceSymbols(List.of(CD_SYSTEM_MODULES))
.withVersion(CLASSFILE_VERSION, 0);
// generate <init>
genConstructor(clb);
// generate hasSplitPackages
genHasSplitPackages(clb);
// generate hasIncubatorModules
genIncubatorModules(clb);
// generate moduleDescriptors
genModuleDescriptorsMethod(clb);
// generate moduleTargets
genModuleTargetsMethod(clb);
// generate moduleHashes
genModuleHashesMethod(clb);
// generate moduleResolutions
genModuleResolutionsMethod(clb);
// generate moduleReads
genModuleReads(clb, cf);
});
}
/**
* Generate bytecode for no-arg constructor
*/
private void genConstructor(ClassBuilder clb) {
clb.withMethodBody(
INIT_NAME,
MTD_void,
ACC_PUBLIC,
cob -> cob.aload(0)
.invokespecial(CD_Object,
INIT_NAME,
MTD_void)
.return_());
}
/**
* Generate bytecode for hasSplitPackages method
*/
private void genHasSplitPackages(ClassBuilder clb) {
boolean distinct = moduleInfos.stream()
.map(ModuleInfo::packages)
.flatMap(Set::stream)
.allMatch(new HashSet<>()::add);
boolean hasSplitPackages = !distinct;
clb.withMethodBody(
"hasSplitPackages",
MTD_boolean,
ACC_PUBLIC,
cob -> cob.loadConstant(hasSplitPackages ? 1 : 0)
.ireturn());
}
/**
* Generate bytecode for hasIncubatorModules method
*/
private void genIncubatorModules(ClassBuilder clb) {
boolean hasIncubatorModules = moduleInfos.stream()
.map(ModuleInfo::moduleResolution)
.filter(mres -> (mres != null && mres.hasIncubatingWarning()))
.findFirst()
.isPresent();
clb.withMethodBody(
"hasIncubatorModules",
MTD_boolean,
ACC_PUBLIC,
cob -> cob.loadConstant(hasIncubatorModules ? 1 : 0)
.ireturn());
}
/**
* Generate bytecode for moduleDescriptors method
*/
private void genModuleDescriptorsMethod(ClassBuilder clb) {
if (moduleInfos.size() <= moduleDescriptorsPerMethod) {
clb.withMethodBody(
"moduleDescriptors",
MTD_ModuleDescriptorArray,
ACC_PUBLIC,
cob -> {
cob.loadConstant(moduleInfos.size())
.anewarray(CD_MODULE_DESCRIPTOR)
.astore(MD_VAR);
for (int index = 0; index < moduleInfos.size(); index++) {
ModuleInfo minfo = moduleInfos.get(index);
new ModuleDescriptorBuilder(cob,
minfo.descriptor(),
minfo.packages(),
index).build();
}
cob.aload(MD_VAR)
.areturn();
});
return;
}
// Split the module descriptors be created by multiple helper methods.
// Each helper method "subi" creates the maximum N number of module descriptors
// mi, m{i+1} ...
// to avoid exceeding the 64kb limit of method length. Then it will call
// "sub{i+1}" to creates the next batch of module descriptors m{i+n}, m{i+n+1}...
// and so on. During the construction of the module descriptors, the string sets and
// modifier sets are deduplicated (see SystemModulesClassGenerator.DedupSetBuilder)
// and cached in the locals. These locals are saved in an array list so
// that the helper method can restore the local variables that may be
// referenced by the bytecode generated for creating module descriptors.
// Pseudo code looks like this:
//
// void subi(ModuleDescriptor[] mdescs, ArrayList<Object> localvars) {
// // assign localvars to local variables
// var l3 = localvars.get(0);
// var l4 = localvars.get(1);
// :
// // fill mdescs[i] to mdescs[i+n-1]
// mdescs[i] = ...
// mdescs[i+1] = ...
// :
// // save new local variables added
// localvars.add(lx)
// localvars.add(l{x+1})
// :
// sub{i+i}(mdescs, localvars);
// }
List<List<ModuleInfo>> splitModuleInfos = new ArrayList<>();
List<ModuleInfo> currentModuleInfos = null;
for (int index = 0; index < moduleInfos.size(); index++) {
if (index % moduleDescriptorsPerMethod == 0) {
currentModuleInfos = new ArrayList<>();
splitModuleInfos.add(currentModuleInfos);
}
currentModuleInfos.add(moduleInfos.get(index));
}
String helperMethodNamePrefix = "sub";
ClassDesc arrayListClassDesc = ClassDesc.ofInternalName("java/util/ArrayList");
clb.withMethodBody(
"moduleDescriptors",
MTD_ModuleDescriptorArray,
ACC_PUBLIC,
cob -> {
cob.loadConstant(moduleInfos.size())
.anewarray(CD_MODULE_DESCRIPTOR)
.dup()
.astore(MD_VAR);
cob.new_(arrayListClassDesc)
.dup()
.loadConstant(moduleInfos.size())
.invokespecial(arrayListClassDesc, INIT_NAME, MethodTypeDesc.of(CD_void, CD_int))
.astore(DEDUP_LIST_VAR);
cob.aload(0)
.aload(MD_VAR)
.aload(DEDUP_LIST_VAR)
.invokevirtual(
this.classDesc,
helperMethodNamePrefix + "0",
MethodTypeDesc.of(CD_void, CD_MODULE_DESCRIPTOR.arrayType(), arrayListClassDesc)
)
.areturn();
});
int dedupVarStart = nextLocalVar;
for (int n = 0, count = 0; n < splitModuleInfos.size(); count += splitModuleInfos.get(n).size(), n++) {
int index = n; // the index of which ModuleInfo being processed in the current batch
int start = count; // the start index to the return ModuleDescriptor array for the current batch
int curDedupVar = nextLocalVar;
clb.withMethodBody(
helperMethodNamePrefix + index,
MethodTypeDesc.of(CD_void, CD_MODULE_DESCRIPTOR.arrayType(), arrayListClassDesc),
ACC_PUBLIC,
cob -> {
if (curDedupVar > dedupVarStart) {
for (int i = dedupVarStart; i < curDedupVar; i++) {
cob.aload(DEDUP_LIST_VAR)
.loadConstant(i - dedupVarStart)
.invokevirtual(arrayListClassDesc, "get", MethodTypeDesc.of(CD_Object, CD_int))
.astore(i);
}
}
List<ModuleInfo> currentBatch = splitModuleInfos.get(index);
for (int j = 0; j < currentBatch.size(); j++) {
ModuleInfo minfo = currentBatch.get(j);
new ModuleDescriptorBuilder(cob,
minfo.descriptor(),
minfo.packages(),
start + j).build();
}
if (index < splitModuleInfos.size() - 1) {
if (nextLocalVar > curDedupVar) {
for (int i = curDedupVar; i < nextLocalVar; i++) {
cob.aload(DEDUP_LIST_VAR)
.aload(i)
.invokevirtual(arrayListClassDesc, "add", MethodTypeDesc.of(CD_boolean, CD_Object))
.pop();
}
}
cob.aload(0)
.aload(MD_VAR)
.aload(DEDUP_LIST_VAR)
.invokevirtual(
this.classDesc,
helperMethodNamePrefix + (index+1),
MethodTypeDesc.of(CD_void, CD_MODULE_DESCRIPTOR.arrayType(), arrayListClassDesc)
);
}
cob.return_();
});
}
}
/**
* Generate bytecode for moduleTargets method
*/
private void genModuleTargetsMethod(ClassBuilder clb) {
clb.withMethodBody(
"moduleTargets",
MTD_ModuleTargetArray,
ACC_PUBLIC,
cob -> {
cob.loadConstant(moduleInfos.size())
.anewarray(CD_MODULE_TARGET)
.astore(MT_VAR);
// if java.base has a ModuleTarget attribute then generate the array
// with one element, all other elements will be null.
ModuleInfo base = moduleInfos.get(0);
if (!base.moduleName().equals("java.base"))
throw new InternalError("java.base should be first module in list");
ModuleTarget target = base.target();
int count;
if (target != null && target.targetPlatform() != null) {
count = 1;
} else {
count = moduleInfos.size();
}
for (int index = 0; index < count; index++) {
ModuleInfo minfo = moduleInfos.get(index);
if (minfo.target() != null) {
cob.aload(MT_VAR)
.loadConstant(index);
// new ModuleTarget(String)
cob.new_(CD_MODULE_TARGET)
.dup()
.loadConstant(minfo.target().targetPlatform())
.invokespecial(CD_MODULE_TARGET,
INIT_NAME,
MTD_void_String);
cob.aastore();
}
}
cob.aload(MT_VAR)
.areturn();
});
}
/**
* Generate bytecode for moduleHashes method
*/
private void genModuleHashesMethod(ClassBuilder clb) {
clb.withMethodBody(
"moduleHashes",
MTD_ModuleHashesArray,
ACC_PUBLIC,
cob -> {
cob.loadConstant(moduleInfos.size())
.anewarray(CD_MODULE_HASHES)
.astore(MH_VAR);
for (int index = 0; index < moduleInfos.size(); index++) {
ModuleInfo minfo = moduleInfos.get(index);
if (minfo.recordedHashes() != null) {
new ModuleHashesBuilder(minfo.recordedHashes(),
index,
cob).build();
}
}
cob.aload(MH_VAR)
.areturn();
});
}
/**
* Generate bytecode for moduleResolutions method
*/
private void genModuleResolutionsMethod(ClassBuilder clb) {
clb.withMethodBody(
"moduleResolutions",
MTD_ModuleResolutionArray,
ACC_PUBLIC,
cob -> {
cob.loadConstant(moduleInfos.size())
.anewarray(CD_MODULE_RESOLUTION)
.astore(0);
for (int index=0; index < moduleInfos.size(); index++) {
ModuleInfo minfo = moduleInfos.get(index);
if (minfo.moduleResolution() != null) {
cob.aload(0)
.loadConstant(index)
.new_(CD_MODULE_RESOLUTION)
.dup()
.loadConstant(minfo.moduleResolution().value())
.invokespecial(CD_MODULE_RESOLUTION,
INIT_NAME,
MTD_void_int)
.aastore();
}
}
cob.aload(0)
.areturn();
});
}
/**
* Generate bytecode for moduleReads method
*/
private void genModuleReads(ClassBuilder clb, Configuration cf) {
// module name -> names of modules that it reads
Map<String, Set<String>> map = cf.modules().stream()
.collect(Collectors.toMap(
ResolvedModule::name,
m -> m.reads().stream()
.map(ResolvedModule::name)
.collect(Collectors.toSet())));
generate(clb, "moduleReads", map, true);
}
/**
* Generate method to return {@code Map<String, Set<String>>}.
*
* If {@code dedup} is true then the values are de-duplicated.
*/
private void generate(ClassBuilder clb,
String methodName,
Map<String, Set<String>> map,
boolean dedup) {
clb.withMethodBody(
methodName,
MTD_Map,
ACC_PUBLIC,
cob -> {
// map of Set -> local
Map<Set<String>, Integer> locals;
// generate code to create the sets that are duplicated
if (dedup) {
Collection<Set<String>> values = map.values();
Set<Set<String>> duplicateSets = values.stream()
.distinct()
.filter(s -> Collections.frequency(values, s) > 1)
.collect(Collectors.toSet());
locals = new HashMap<>();
int index = 1;
for (Set<String> s : duplicateSets) {
genImmutableSet(cob, s);
cob.astore(index);
locals.put(s, index);
if (++index >= MAX_LOCAL_VARS) {
break;
}
}
} else {
locals = Map.of();
}