Repository navigation
Expand file tree
/
Copy pathModule.java
More file actions
1910 lines (1709 loc) · 69.1 KB
/
Copy pathModule.java
File metadata and controls
1910 lines (1709 loc) · 69.1 KB
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) 2014, 2026, 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 java.lang;
import java.io.IOException;
import java.io.InputStream;
import java.lang.annotation.Annotation;
import java.lang.module.Configuration;
import java.lang.module.ModuleReference;
import java.lang.module.ModuleDescriptor;
import java.lang.module.ModuleDescriptor.Exports;
import java.lang.module.ModuleDescriptor.Opens;
import java.lang.module.ModuleDescriptor.Version;
import java.lang.module.ResolvedModule;
import java.lang.reflect.AccessFlag;
import java.lang.reflect.AnnotatedElement;
import java.lang.reflect.Field;
import java.net.URI;
import java.net.URL;
import java.security.CodeSource;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import java.lang.classfile.AccessFlags;
import java.lang.classfile.Attribute;
import java.lang.classfile.ClassFile;
import java.lang.classfile.attribute.RuntimeVisibleAnnotationsAttribute;
import jdk.internal.loader.BuiltinClassLoader;
import jdk.internal.loader.BootLoader;
import jdk.internal.loader.ClassLoaders;
import jdk.internal.misc.CDS;
import jdk.internal.misc.Unsafe;
import jdk.internal.misc.VM;
import jdk.internal.module.ModuleBootstrap;
import jdk.internal.module.ModuleLoaderMap;
import jdk.internal.module.ServicesCatalog;
import jdk.internal.module.Resources;
import jdk.internal.reflect.CallerSensitive;
import jdk.internal.reflect.Reflection;
import jdk.internal.vm.annotation.AOTSafeClassInitializer;
import jdk.internal.vm.annotation.Stable;
/**
* Represents a run-time module, either {@link #isNamed() named} or unnamed.
*
* <p> Named modules have a {@link #getName() name} and are constructed by the
* Java Virtual Machine when a graph of modules is defined to the Java virtual
* machine to create a {@linkplain ModuleLayer module layer}. </p>
*
* <p> An unnamed module does not have a name. There is an unnamed module for
* each {@link ClassLoader ClassLoader}, obtained by invoking its {@link
* ClassLoader#getUnnamedModule() getUnnamedModule} method. All types that are
* not in a named module are members of their defining class loader's unnamed
* module. </p>
*
* <p> The package names that are parameters or returned by methods defined in
* this class are the fully-qualified names of the packages as defined in
* section {@jls 6.5.3} of <cite>The Java Language Specification</cite>, for
* example, {@code "java.lang"}. </p>
*
* <p> Unless otherwise specified, passing a {@code null} argument to a method
* in this class causes a {@link NullPointerException NullPointerException} to
* be thrown. </p>
*
* @since 9
* @see Class#getModule()
* @jls 7.7 Module Declarations
*/
public final class Module implements AnnotatedElement {
// the layer that contains this module, can be null
private final ModuleLayer layer;
// module name and loader, these fields are read by VM
private final String name;
private final ClassLoader loader;
// the module descriptor
private final ModuleDescriptor descriptor;
// true, if this module allows restricted native access
// Accessing this variable is made through Unsafe in order to use the
// memory semantics that preserves ordering and visibility across threads.
@Stable
private boolean enableNativeAccess;
// true if this module is allowed to mutate final instance fields
@Stable
private boolean enableFinalMutation;
/**
* Creates a new named Module. The resulting Module will be defined to the
* VM but will not read any other modules, will not have any exports setup
* and will not be registered in the service catalog.
*/
Module(ModuleLayer layer,
ClassLoader loader,
ModuleDescriptor descriptor,
URI uri)
{
this.layer = layer;
this.name = descriptor.name();
this.loader = loader;
this.descriptor = descriptor;
// define module to VM
boolean isOpen = descriptor.isOpen() || descriptor.isAutomatic();
Version version = descriptor.version().orElse(null);
String vs = Objects.toString(version, null);
String loc = Objects.toString(uri, null);
Object[] packages = descriptor.packages().toArray();
defineModule0(this, isOpen, vs, loc, packages);
}
/**
* Create the unnamed Module for the given ClassLoader.
*
* @see ClassLoader#getUnnamedModule
*/
Module(ClassLoader loader) {
this.layer = null;
this.name = null;
this.loader = loader;
this.descriptor = null;
}
/**
* Creates a named module but without defining the module to the VM.
*
* @apiNote This constructor is for VM white-box testing.
*/
Module(ClassLoader loader, ModuleDescriptor descriptor) {
this.layer = null;
this.name = descriptor.name();
this.loader = loader;
this.descriptor = descriptor;
}
/**
* Returns {@code true} if this module is a named module.
*
* @return {@code true} if this is a named module
*
* @see ClassLoader#getUnnamedModule()
* @jls 7.7.5 Unnamed Modules
*/
public boolean isNamed() {
return name != null;
}
/**
* Returns the module name or {@code null} if this module is an unnamed
* module.
*
* @return The module name
*/
public String getName() {
return name;
}
/**
* Returns the {@code ClassLoader} for this module.
*
* @return The class loader for this module
*/
public ClassLoader getClassLoader() {
return loader;
}
/**
* Returns the module descriptor for this module or {@code null} if this
* module is an unnamed module.
*
* @return The module descriptor for this module
*/
public ModuleDescriptor getDescriptor() {
return descriptor;
}
/**
* Returns the module layer that contains this module or {@code null} if
* this module is not in a module layer.
*
* A module layer contains named modules and therefore this method always
* returns {@code null} when invoked on an unnamed module.
*
* <p> <a href="reflect/Proxy.html#dynamicmodule">Dynamic modules</a> are
* named modules that are generated at runtime. A dynamic module may or may
* not be in a module layer. </p>
*
* @return The module layer that contains this module
*
* @see java.lang.reflect.Proxy
*/
public ModuleLayer getLayer() {
if (isNamed()) {
ModuleLayer layer = this.layer;
if (layer != null)
return layer;
// special-case java.base as it is created before the boot layer
if (loader == null && name.equals("java.base")) {
return ModuleLayer.boot();
}
}
return null;
}
/**
* Update this module to allow access to restricted methods.
*/
Module implAddEnableNativeAccess() {
EnableNativeAccess.trySetEnableNativeAccess(this);
return this;
}
/**
* Returns {@code true} if this module can access
* <a href="{@docRoot}/java.base/java/lang/doc-files/RestrictedMethods.html#restricted"><em>restricted</em></a> methods.
*
* @return {@code true} if this module can access <em>restricted</em> methods.
* @since 22
*/
public boolean isNativeAccessEnabled() {
Module target = moduleForNativeAccess();
return EnableNativeAccess.isNativeAccessEnabled(target);
}
/**
* This class is used to be able to bootstrap without using Unsafe
* in the outer Module class as that would create a circular initializer dependency.
*/
private static final class EnableNativeAccess {
private EnableNativeAccess() {}
private static final Unsafe UNSAFE = Unsafe.getUnsafe();
private static final long FIELD_OFFSET = UNSAFE.objectFieldOffset(Module.class, "enableNativeAccess");
private static boolean isNativeAccessEnabled(Module target) {
return UNSAFE.getBooleanVolatile(target, FIELD_OFFSET);
}
// Atomically sets enableNativeAccess if not already set
// returning if the value was updated
private static boolean trySetEnableNativeAccess(Module target) {
return UNSAFE.compareAndSetBoolean(target, FIELD_OFFSET, false, true);
}
}
// Returns the Module object that holds the enableNativeAccess
// flag for this module.
private Module moduleForNativeAccess() {
return isNamed() ? this : ALL_UNNAMED_MODULE;
}
// This is invoked from Reflection.ensureNativeAccess
void ensureNativeAccess(Class<?> owner, String methodName, Class<?> currentClass, boolean jni) {
// The target module whose enableNativeAccess flag is ensured
Module target = moduleForNativeAccess();
ModuleBootstrap.IllegalNativeAccess illegalNativeAccess = ModuleBootstrap.illegalNativeAccess();
if (illegalNativeAccess != ModuleBootstrap.IllegalNativeAccess.ALLOW &&
!EnableNativeAccess.isNativeAccessEnabled(target)) {
String mod = isNamed() ? "module " + getName() : "an unnamed module";
if (currentClass != null) {
// try to extract location of the current class (e.g. jar or folder)
CodeSource cs = currentClass.getProtectionDomain().getCodeSource();
if (cs != null) {
URL url = cs.getLocation();
if (url != null) {
mod += " (" + url + ")";
}
}
}
if (illegalNativeAccess == ModuleBootstrap.IllegalNativeAccess.DENY) {
throw new IllegalCallerException("Illegal native access from " + mod);
} else if (EnableNativeAccess.trySetEnableNativeAccess(target)) {
// warn and set flag, so that only one warning is reported per module
String cls = owner.getName();
String mtd = cls + "::" + methodName;
String modflag = isNamed() ? getName() : "ALL-UNNAMED";
String caller = currentClass != null ? currentClass.getName() : "code";
if (jni) {
VM.initialErr().printf("""
WARNING: A native method in %s has been bound
WARNING: %s is declared in %s
WARNING: Use --enable-native-access=%s to avoid a warning for native methods declared in this module
WARNING: Restricted methods will be blocked in a future release unless native access is enabled
%n""", cls, mtd, mod, modflag);
} else {
VM.initialErr().printf("""
WARNING: A restricted method in %s has been called
WARNING: %s has been called by %s in %s
WARNING: Use --enable-native-access=%s to avoid a warning for callers in this module
WARNING: Restricted methods will be blocked in a future release unless native access is enabled
%n""", cls, mtd, caller, mod, modflag);
}
}
}
}
/**
* Enable code in all unnamed modules to access restricted methods.
*/
static void addEnableNativeAccessToAllUnnamed() {
EnableNativeAccess.trySetEnableNativeAccess(ALL_UNNAMED_MODULE);
}
/**
* This class exists to avoid using Unsafe during early initialization of Module.
*/
private static final class EnableFinalMutation {
private static final Unsafe UNSAFE = Unsafe.getUnsafe();
private static final long ENABLE_FINAL_MUTATION_OFFSET =
UNSAFE.objectFieldOffset(Module.class, "enableFinalMutation");
private static boolean isEnableFinalMutation(Module module) {
return UNSAFE.getBooleanVolatile(module, ENABLE_FINAL_MUTATION_OFFSET);
}
private static boolean tryEnableFinalMutation(Module module) {
return UNSAFE.compareAndSetBoolean(module, ENABLE_FINAL_MUTATION_OFFSET, false, true);
}
}
/**
* Enable code in all unnamed modules to mutate final instance fields.
*/
static void addEnableFinalMutationToAllUnnamed() {
EnableFinalMutation.tryEnableFinalMutation(ALL_UNNAMED_MODULE);
}
/**
* Enable code in this named module to mutate final instance fields.
*/
boolean tryEnableFinalMutation() {
Module m = isNamed() ? this : ALL_UNNAMED_MODULE;
return EnableFinalMutation.tryEnableFinalMutation(m);
}
/**
* Return true if code in this module is allowed to mutate final instance fields.
*/
boolean isFinalMutationEnabled() {
Module m = isNamed() ? this : ALL_UNNAMED_MODULE;
return EnableFinalMutation.isEnableFinalMutation(m);
}
// --
// special Module to mean "all unnamed modules"
private static final Module ALL_UNNAMED_MODULE;
private static final Set<Module> ALL_UNNAMED_MODULE_SET;
// special Module to mean "everyone"
private static final Module EVERYONE_MODULE;
private static final Set<Module> EVERYONE_SET;
@AOTSafeClassInitializer
private static class ArchivedData {
private static ArchivedData archivedData;
private final Module allUnnamedModule;
private final Set<Module> allUnnamedModules;
private final Module everyoneModule;
private final Set<Module> everyoneSet;
private ArchivedData() {
this.allUnnamedModule = ALL_UNNAMED_MODULE;
this.allUnnamedModules = ALL_UNNAMED_MODULE_SET;
this.everyoneModule = EVERYONE_MODULE;
this.everyoneSet = EVERYONE_SET;
}
static void archive() {
archivedData = new ArchivedData();
}
static ArchivedData get() {
return archivedData;
}
static {
CDS.initializeFromArchive(ArchivedData.class);
}
}
static {
ArchivedData archivedData = ArchivedData.get();
if (archivedData != null) {
ALL_UNNAMED_MODULE = archivedData.allUnnamedModule;
ALL_UNNAMED_MODULE_SET = archivedData.allUnnamedModules;
EVERYONE_MODULE = archivedData.everyoneModule;
EVERYONE_SET = archivedData.everyoneSet;
} else {
ALL_UNNAMED_MODULE = new Module(null);
ALL_UNNAMED_MODULE_SET = Set.of(ALL_UNNAMED_MODULE);
EVERYONE_MODULE = new Module(null);
EVERYONE_SET = Set.of(EVERYONE_MODULE);
ArchivedData.archive();
}
}
/**
* The holder of data structures to support readability, exports, and
* service use added at runtime with the reflective APIs.
*/
private static class ReflectionData {
/**
* A module (1st key) reads another module (2nd key)
*/
static final WeakPairMap<Module, Module, Boolean> reads =
new WeakPairMap<>();
/**
* A module (1st key) exports or opens a package to another module
* (2nd key). The map value is a map of package name to a boolean
* that indicates if the package is opened.
*/
static final WeakPairMap<Module, Module, Map<String, Boolean>> exports =
new WeakPairMap<>();
/**
* A module (1st key) uses a service (2nd key)
*/
static final WeakPairMap<Module, Class<?>, Boolean> uses =
new WeakPairMap<>();
/**
* Return true if any of the maps are not empty.
*/
static boolean hasData() {
return !reads.values().isEmpty()
|| !exports.values().isEmpty()
|| !uses.values().isEmpty();
}
}
/**
* Returns true if ReflectionData has any readability, exports/opens or service
* uses that were added reflectively.
*/
static boolean hasReflectionData() {
return ReflectionData.hasData();
}
// -- readability --
// the modules that this module reads
private volatile Set<Module> reads;
/**
* Indicates if this module reads the given module. This method returns
* {@code true} if invoked to test if this module reads itself. It also
* returns {@code true} if invoked on an unnamed module (as unnamed
* modules read all modules).
*
* @param other
* The other module
*
* @return {@code true} if this module reads {@code other}
*
* @see #addReads(Module)
*/
public boolean canRead(Module other) {
Objects.requireNonNull(other);
// an unnamed module reads all modules
if (!this.isNamed())
return true;
// all modules read themselves
if (other == this)
return true;
// check if this module reads other
Set<Module> reads = this.reads;
if (reads != null) {
if (reads.contains(other))
return true;
if (!other.isNamed() && reads.contains(ALL_UNNAMED_MODULE))
return true;
}
// check if this module reads the other module reflectively
if (ReflectionData.reads.containsKeyPair(this, other))
return true;
// if other is an unnamed module then check if this module reads
// all unnamed modules
if (!other.isNamed()
&& ReflectionData.reads.containsKeyPair(this, ALL_UNNAMED_MODULE))
return true;
return false;
}
/**
* If the caller's module is this module then update this module to read
* the given module.
*
* This method is a no-op if {@code other} is this module (all modules read
* themselves), this module is an unnamed module (as unnamed modules read
* all modules), or this module already reads {@code other}.
*
* @implNote <em>Read edges</em> added by this method are <em>weak</em> and
* do not prevent {@code other} from being GC'ed when this module is
* strongly reachable.
*
* @param other
* The other module
*
* @return this module
*
* @throws IllegalCallerException
* If this is a named module and the caller's module is not this
* module
*
* @see #canRead
*/
@CallerSensitive
public Module addReads(Module other) {
Objects.requireNonNull(other);
if (this.isNamed()) {
Module caller = getCallerModule(Reflection.getCallerClass());
if (caller != this) {
throw new IllegalCallerException(caller + " != " + this);
}
implAddReads(other, true);
}
return this;
}
/**
* Updates this module to read another module.
*
* @apiNote Used by the --add-reads command line option.
*/
void implAddReads(Module other) {
implAddReads(other, true);
}
/**
* Updates this module to read all unnamed modules.
*
* @apiNote Used by the --add-reads command line option.
*/
void implAddReadsAllUnnamed() {
implAddReads(Module.ALL_UNNAMED_MODULE, true);
}
/**
* Updates this module to read another module without notifying the VM.
*
* @apiNote This method is for VM white-box testing.
*/
void implAddReadsNoSync(Module other) {
implAddReads(other, false);
}
/**
* Makes the given {@code Module} readable to this module.
*
* If {@code syncVM} is {@code true} then the VM is notified.
*/
private void implAddReads(Module other, boolean syncVM) {
Objects.requireNonNull(other);
if (!canRead(other)) {
// update VM first, just in case it fails
if (syncVM) {
if (other == ALL_UNNAMED_MODULE) {
addReads0(this, null);
} else {
addReads0(this, other);
}
}
if (VM.isModuleSystemInited()) {
// add reflective read
ReflectionData.reads.putIfAbsent(this, other, Boolean.TRUE);
} else {
// --add-reads
Set<Module> reads = this.reads;
if (reads == null) {
this.reads = Set.of(other);
} else {
Set<Module> newReads = new HashSet<>(reads);
newReads.add(other);
this.reads = newReads;
}
}
}
}
// -- exported and open packages --
// the packages are open to other modules, can be null
// if the value contains EVERYONE_MODULE then the package is open to all
private volatile Map<String, Set<Module>> openPackages;
// the packages that are exported, can be null
// if the value contains EVERYONE_MODULE then the package is exported to all
private volatile Map<String, Set<Module>> exportedPackages;
/**
* Returns {@code true} if this module exports the given package to at
* least the given module.
*
* <p> This method returns {@code true} if invoked to test if a package in
* this module is exported to itself. It always returns {@code true} when
* invoked on an unnamed module. A package that is {@link #isOpen open} to
* the given module is considered exported to that module at run-time and
* so this method returns {@code true} if the package is open to the given
* module. </p>
*
* <p> This method does not check if the given module reads this module. </p>
*
* @param pn
* The package name
* @param other
* The other module
*
* @return {@code true} if this module exports the package to at least the
* given module
*
* @see ModuleDescriptor#exports()
* @see #addExports(String,Module)
*/
public boolean isExported(String pn, Module other) {
Objects.requireNonNull(pn);
Objects.requireNonNull(other);
return implIsExportedOrOpen(pn, other, /*open*/false);
}
/**
* Returns {@code true} if this module has <em>opened</em> a package to at
* least the given module.
*
* <p> This method returns {@code true} if invoked to test if a package in
* this module is open to itself. It returns {@code true} when invoked on an
* {@link ModuleDescriptor#isOpen open} module with a package in the module.
* It always returns {@code true} when invoked on an unnamed module. </p>
*
* <p> This method does not check if the given module reads this module. </p>
*
* @apiNote A package {@code p} opened to module {@code M} allows code in
* {@code M} do {@linkplain java.lang.reflect.AccessibleObject#setAccessible(boolean)
* deep reflection} on all types in the package.
* Further, if {@code M} reads this module, it can obtain a
* {@link java.lang.invoke.MethodHandles.Lookup Lookup} object that is allowed to
* {@link java.lang.invoke.MethodHandles.Lookup#defineClass(byte[]) define classes}
* in package {@code p}.
*
* @param pn
* The package name
* @param other
* The other module
*
* @return {@code true} if this module has <em>opened</em> the package
* to at least the given module
*
* @see ModuleDescriptor#opens()
* @see #addOpens(String,Module)
* @see java.lang.reflect.AccessibleObject#setAccessible(boolean)
* @see java.lang.invoke.MethodHandles#privateLookupIn
*/
public boolean isOpen(String pn, Module other) {
Objects.requireNonNull(pn);
Objects.requireNonNull(other);
return implIsExportedOrOpen(pn, other, /*open*/true);
}
/**
* Returns {@code true} if this module exports the given package
* unconditionally.
*
* <p> This method always returns {@code true} when invoked on an unnamed
* module. A package that is {@link #isOpen(String) opened} unconditionally
* is considered exported unconditionally at run-time and so this method
* returns {@code true} if the package is opened unconditionally. </p>
*
* <p> This method does not check if the given module reads this module. </p>
*
* @param pn
* The package name
*
* @return {@code true} if this module exports the package unconditionally
*
* @see ModuleDescriptor#exports()
*/
public boolean isExported(String pn) {
Objects.requireNonNull(pn);
return implIsExportedOrOpen(pn, EVERYONE_MODULE, /*open*/false);
}
/**
* Returns {@code true} if this module has <em>opened</em> a package
* unconditionally.
*
* <p> This method always returns {@code true} when invoked on an unnamed
* module. Additionally, it always returns {@code true} when invoked on an
* {@link ModuleDescriptor#isOpen open} module with a package in the
* module. </p>
*
* <p> This method does not check if the given module reads this module. </p>
*
* @apiNote A package {@code p} opened to module {@code M} allows code in
* {@code M} do {@linkplain java.lang.reflect.AccessibleObject#setAccessible(boolean)
* deep reflection} on all types in the package.
* Further, if {@code M} reads this module, it can obtain a
* {@link java.lang.invoke.MethodHandles.Lookup Lookup} object that is allowed to
* {@link java.lang.invoke.MethodHandles.Lookup#defineClass(byte[]) define classes}
* in package {@code p}.
*
* @param pn
* The package name
*
* @return {@code true} if this module has <em>opened</em> the package
* unconditionally
*
* @see ModuleDescriptor#opens()
* @see java.lang.reflect.AccessibleObject#setAccessible(boolean)
* @see java.lang.invoke.MethodHandles#privateLookupIn
*/
public boolean isOpen(String pn) {
Objects.requireNonNull(pn);
return implIsExportedOrOpen(pn, EVERYONE_MODULE, /*open*/true);
}
/**
* Returns {@code true} if this module exports or opens the given package
* to the given module. If the other module is {@code EVERYONE_MODULE} then
* this method tests if the package is exported or opened unconditionally.
*/
private boolean implIsExportedOrOpen(String pn, Module other, boolean open) {
// all packages in unnamed modules are open
if (!isNamed())
return true;
// all packages are exported/open to self
if (other == this && descriptor.packages().contains(pn))
return true;
// all packages in open and automatic modules are open
if (descriptor.isOpen() || descriptor.isAutomatic())
return descriptor.packages().contains(pn);
// exported/opened via module declaration/descriptor or CLI options
if (isExplicitlyExportedOrOpened(pn, other, open))
return true;
// exported via addExports/addOpens
if (isReflectivelyExportedOrOpened(pn, other, open))
return true;
// not exported or open to other
return false;
}
/**
* Returns {@code true} if this module statically exports a package to the given module.
* If the package is exported to the given module via {@code addExports} then this method
* returns {@code false}.
*/
boolean isStaticallyExported(String pn, Module other) {
return isStaticallyExportedOrOpened(pn, other, false);
}
/**
* Returns {@code true} if this module statically opens a package to the given module.
* If the package is opened to the given module via {@code addOpens} then this method
* returns {@code false}.
*/
boolean isStaticallyOpened(String pn, Module other) {
return isStaticallyExportedOrOpened(pn, other, true);
}
/**
* Returns {@code true} if this module exports or opens a package to the
* given module via its module declaration or CLI options.
*/
private boolean isStaticallyExportedOrOpened(String pn, Module other, boolean open) {
// all packages in unnamed modules are exported and open
if (!isNamed())
return true;
// all packages are exported/open to self
if (other == this && descriptor.packages().contains(pn))
return true;
// all packages in open and automatic modules are exported/open
if (descriptor.isOpen() || descriptor.isAutomatic())
return descriptor.packages().contains(pn);
// exported/opened via module descriptor
if (isExplicitlyExportedOrOpened(pn, other, open))
return true;
return false;
}
/**
* Returns {@code true} if this module exports or opens a package to the
* given module via its module declaration or CLI options.
*/
private boolean isExplicitlyExportedOrOpened(String pn, Module other, boolean open) {
// test if package is open to everyone or <other>
Map<String, Set<Module>> openPackages = this.openPackages;
if (openPackages != null && allows(openPackages.get(pn), other)) {
return true;
}
if (!open) {
// test package is exported to everyone or <other>
Map<String, Set<Module>> exportedPackages = this.exportedPackages;
if (exportedPackages != null && allows(exportedPackages.get(pn), other)) {
return true;
}
}
return false;
}
/**
* Returns {@code true} if targets is non-null and contains EVERYONE_MODULE
* or the given module. Also returns true if the given module is an unnamed
* module and targets contains ALL_UNNAMED_MODULE.
*/
private boolean allows(Set<Module> targets, Module module) {
if (targets != null) {
if (targets.contains(EVERYONE_MODULE))
return true;
if (module != EVERYONE_MODULE) {
if (targets.contains(module))
return true;
if (!module.isNamed() && targets.contains(ALL_UNNAMED_MODULE))
return true;
}
}
return false;
}
/**
* Returns {@code true} if this module reflectively exports or opens the
* given package to the given module.
*/
private boolean isReflectivelyExportedOrOpened(String pn, Module other, boolean open) {
// exported or open to all modules
Map<String, Boolean> exports = ReflectionData.exports.get(this, EVERYONE_MODULE);
if (exports != null) {
Boolean b = exports.get(pn);
if (b != null) {
boolean isOpen = b.booleanValue();
if (!open || isOpen) return true;
}
}
if (other != EVERYONE_MODULE) {
// exported or open to other
exports = ReflectionData.exports.get(this, other);
if (exports != null) {
Boolean b = exports.get(pn);
if (b != null) {
boolean isOpen = b.booleanValue();
if (!open || isOpen) return true;
}
}
// other is an unnamed module && exported or open to all unnamed
if (!other.isNamed()) {
exports = ReflectionData.exports.get(this, ALL_UNNAMED_MODULE);
if (exports != null) {
Boolean b = exports.get(pn);
if (b != null) {
boolean isOpen = b.booleanValue();
if (!open || isOpen) return true;
}
}
}
}
return false;
}
/**
* Returns {@code true} if this module reflectively exports the
* given package to the given module.
*/
boolean isReflectivelyExported(String pn, Module other) {
return isReflectivelyExportedOrOpened(pn, other, false);
}
/**
* Returns {@code true} if this module reflectively opens the
* given package to the given module.
*/
boolean isReflectivelyOpened(String pn, Module other) {
return isReflectivelyExportedOrOpened(pn, other, true);
}
/**
* If the caller's module is this module then update this module to export
* the given package to the given module.
*
* <p> Exporting a package with this method does not allow the given module to
* {@linkplain Field#set(Object, Object) reflectively set} or {@linkplain
* java.lang.invoke.MethodHandles.Lookup#unreflectSetter(Field) obtain a method
* handle with write access} to a public final field declared in a public class
* in the package.
*
* <p> This method has no effect if the package is already exported (or
* <em>open</em>) to the given module. </p>
*
* @apiNote As specified in section {@jvms 5.4.3} of the <cite>The Java
* Virtual Machine Specification </cite>, if an attempt to resolve a
* symbolic reference fails because of a linkage error, then subsequent
* attempts to resolve the reference always fail with the same error that
* was thrown as a result of the initial resolution attempt.
*
* @param pn
* The package name
* @param other
* The module
*
* @return this module
*
* @throws IllegalArgumentException
* If {@code pn} is {@code null}, or this is a named module and the
* package {@code pn} is not a package in this module
* @throws IllegalCallerException
* If this is a named module and the caller's module is not this
* module
*
* @jvms 5.4.3 Resolution
* @see #isExported(String,Module)
*/
@CallerSensitive
public Module addExports(String pn, Module other) {
if (pn == null)
throw new IllegalArgumentException("package is null");
Objects.requireNonNull(other);
if (isNamed()) {
Module caller = getCallerModule(Reflection.getCallerClass());
if (caller != this) {
throw new IllegalCallerException(caller + " != " + this);
}
implAddExports(pn, other);
}
return this;
}
/**
* If this module has <em>opened</em> the given package to at least the caller
* module, then update this module to also open the package to the given module.
*
* <p> Opening a package with this method allows all types in the package,
* and all their members, not just public types and their public members,
* to be reflected on by the given module when using APIs that either support
* private access or provide a way to bypass or suppress Java language
* access control checks.