Skip to content

Commit 1a21f77

Browse files
mrserbmrserb
committedMar 19, 2021
8263482: Make access to the ICC color profiles data multithread-friendly
Reviewed-by: azvegint
·
JEP-429-branchpoint
1 parent d185655 commit 1a21f77

File tree

5 files changed

+129
-160
lines changed

5 files changed

+129
-160
lines changed
 

‎src/java.desktop/share/classes/java/awt/color/ICC_Profile.java

+46-33
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,19 @@ public class ICC_Profile implements Serializable {
9191
@Serial
9292
private static final long serialVersionUID = -3938515861990936766L;
9393

94+
/**
95+
* The implementation specific CMM profile, {@code null} if this
96+
* {@code ICC_Profile} is not activated by the {@link #cmmProfile()} method.
97+
* This field must not be used directly and only via {@link #cmmProfile()}.
98+
*/
9499
private transient volatile Profile cmmProfile;
100+
101+
/**
102+
* Stores some information about {@code ICC_Profile} without causing a
103+
* deferred profile to be loaded. Note that we can defer the loading of
104+
* standard profiles only. If this field is null, then {@link #cmmProfile}
105+
* should be used to access profile information.
106+
*/
95107
private transient volatile ProfileDeferralInfo deferralInfo;
96108

97109
/**
@@ -917,32 +929,37 @@ static byte[] getProfileDataFromStream(InputStream s) throws IOException {
917929
}
918930

919931
/**
920-
* Activates the deferred standard profiles. Implementation of this method
921-
* mimics the old behaviour when the CMMException and IOException were
922-
* wrapped by the ProfileDataException, and the ProfileDataException itself
923-
* was ignored during activation.
932+
* Activates and returns the deferred standard profiles. Implementation of
933+
* this method mimics the old behaviour when the {@code CMMException} and
934+
* {@code IOException} were wrapped by the {@code ProfileDataException}, and
935+
* the {@code ProfileDataException} itself was ignored during activation.
936+
*
937+
* @return the implementation specific CMM profile, or {@code null}
924938
*/
925-
private void activate() {
926-
if (cmmProfile == null) {
927-
synchronized (this) {
928-
if (cmmProfile != null) {
929-
return;
930-
}
931-
var is = getStandardProfileInputStream(deferralInfo.filename);
932-
if (is == null) {
933-
return;
934-
}
935-
try (is) {
936-
byte[] data = getProfileDataFromStream(is);
937-
if (data != null) {
938-
cmmProfile = CMSManager.getModule().loadProfile(data);
939-
// from now we cannot use the deferred value, drop it
940-
deferralInfo = null;
941-
}
942-
} catch (CMMException | IOException ignore) {
939+
private Profile cmmProfile() {
940+
Profile p = cmmProfile;
941+
if (p != null) {
942+
return p; // one volatile read on common path
943+
}
944+
synchronized (this) {
945+
if (cmmProfile != null) {
946+
return cmmProfile;
947+
}
948+
var is = getStandardProfileInputStream(deferralInfo.filename);
949+
if (is == null) {
950+
return null;
951+
}
952+
try (is) {
953+
byte[] data = getProfileDataFromStream(is);
954+
if (data != null) {
955+
p = cmmProfile = CMSManager.getModule().loadProfile(data);
956+
// from now we cannot use the deferred value, drop it
957+
deferralInfo = null;
943958
}
959+
} catch (CMMException | IOException ignore) {
944960
}
945961
}
962+
return p;
946963
}
947964

948965
/**
@@ -1006,8 +1023,7 @@ public int getColorSpaceType() {
10061023
if (info != null) {
10071024
return info.colorSpaceType;
10081025
}
1009-
activate();
1010-
return getColorSpaceType(cmmProfile);
1026+
return getColorSpaceType(cmmProfile());
10111027
}
10121028

10131029
private static int getColorSpaceType(Profile p) {
@@ -1030,8 +1046,7 @@ private static int getColorSpaceType(Profile p) {
10301046
* {@code ColorSpace} class
10311047
*/
10321048
public int getPCSType() {
1033-
activate();
1034-
byte[] theHeader = getData(cmmProfile, icSigHead);
1049+
byte[] theHeader = getData(icSigHead);
10351050
int thePCSSig = intFromBigEndian(theHeader, icHdrPcs);
10361051
return iccCStoJCS(thePCSSig);
10371052
}
@@ -1067,8 +1082,7 @@ public void write(OutputStream s) throws IOException {
10671082
* @see #setData(int, byte[])
10681083
*/
10691084
public byte[] getData() {
1070-
activate();
1071-
return CMSManager.getModule().getProfileData(cmmProfile);
1085+
return CMSManager.getModule().getProfileData(cmmProfile());
10721086
}
10731087

10741088
/**
@@ -1085,8 +1099,8 @@ public byte[] getData() {
10851099
* @see #setData(int, byte[])
10861100
*/
10871101
public byte[] getData(int tagSignature) {
1088-
activate();
1089-
return getData(cmmProfile, tagSignature);
1102+
byte[] t = getData(cmmProfile(), tagSignature);
1103+
return t != null ? t.clone() : null;
10901104
}
10911105

10921106
private static byte[] getData(Profile p, int tagSignature) {
@@ -1115,8 +1129,7 @@ private static byte[] getData(Profile p, int tagSignature) {
11151129
* @see #getData
11161130
*/
11171131
public void setData(int tagSignature, byte[] tagData) {
1118-
activate();
1119-
CMSManager.getModule().setTagData(cmmProfile, tagSignature, tagData);
1132+
CMSManager.getModule().setTagData(cmmProfile(), tagSignature, tagData);
11201133
}
11211134

11221135
/**
@@ -1170,7 +1183,7 @@ float[] getMediaWhitePoint() {
11701183
* Returns a float array of length 3 containing the X, Y, and Z components
11711184
* encoded in an XYZType tag.
11721185
*/
1173-
float[] getXYZTag(int tagSignature) {
1186+
final float[] getXYZTag(int tagSignature) {
11741187
byte[] theData = getData(tagSignature);
11751188
float[] theXYZNumber = new float[3]; /* array to return */
11761189

‎src/java.desktop/share/classes/sun/java2d/cmm/CMSManager.java

+7-2
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,14 @@
3333

3434
public final class CMSManager {
3535

36-
private static PCMM cmmImpl = null;
36+
private static volatile PCMM cmmImpl;
3737

38-
public static synchronized PCMM getModule() {
38+
public static PCMM getModule() {
39+
PCMM loc = cmmImpl;
40+
return loc != null ? loc : createModule();
41+
}
42+
43+
private static synchronized PCMM createModule() {
3944
if (cmmImpl != null) {
4045
return cmmImpl;
4146
}

‎src/java.desktop/share/classes/sun/java2d/cmm/lcms/LCMS.java

+22-47
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,8 @@
3131
import sun.java2d.cmm.ColorTransform;
3232
import sun.java2d.cmm.PCMM;
3333
import sun.java2d.cmm.Profile;
34-
import sun.java2d.cmm.lcms.LCMSProfile.TagData;
3534

36-
public class LCMS implements PCMM {
35+
final class LCMS implements PCMM {
3736

3837
/* methods invoked from ICC_Profile */
3938
@Override
@@ -48,54 +47,13 @@ public Profile loadProfile(byte[] data) {
4847
return null;
4948
}
5049

51-
private native long loadProfileNative(byte[] data, Object ref);
52-
53-
private LCMSProfile getLcmsProfile(Profile p) {
50+
private static LCMSProfile getLcmsProfile(Profile p) {
5451
if (p instanceof LCMSProfile) {
5552
return (LCMSProfile)p;
5653
}
5754
throw new CMMException("Invalid profile: " + p);
5855
}
5956

60-
@Override
61-
public byte[] getProfileData(final Profile p) {
62-
LCMSProfile lcmsProfile = getLcmsProfile(p);
63-
synchronized (lcmsProfile) {
64-
return getProfileDataNative(lcmsProfile.getLcmsPtr());
65-
}
66-
}
67-
68-
private native byte[] getProfileDataNative(long ptr);
69-
70-
static native byte[] getTagNative(long profileID, int signature);
71-
72-
@Override
73-
public byte[] getTagData(Profile p, int tagSignature) {
74-
final LCMSProfile lcmsProfile = getLcmsProfile(p);
75-
synchronized (lcmsProfile) {
76-
TagData t = lcmsProfile.getTag(tagSignature);
77-
return t != null ? t.getData() : null;
78-
}
79-
}
80-
81-
@Override
82-
public synchronized void setTagData(Profile p, int tagSignature, byte[] data) {
83-
final LCMSProfile profile = getLcmsProfile(p);
84-
85-
synchronized (profile) {
86-
profile.clearTagCache();
87-
88-
// Now we are going to update the profile with new tag data
89-
// In some cases, we may change the pointer to the native
90-
// profile.
91-
//
92-
// If we fail to write tag data for any reason, the old pointer
93-
// should be used.
94-
setTagDataNative(profile.getLcmsPtr(),
95-
tagSignature, data);
96-
}
97-
}
98-
9957
/**
10058
* Writes supplied data as a tag into the profile.
10159
* Destroys old profile, if new one was successfully
@@ -106,10 +64,27 @@ public synchronized void setTagData(Profile p, int tagSignature, byte[] data) {
10664
* Throws CMMException if operation fails, preserve old profile from
10765
* destruction.
10866
*/
109-
private native void setTagDataNative(long ptr, int tagSignature,
110-
byte[] data);
67+
static native void setTagDataNative(long ptr, int tagSignature, byte[] data);
68+
static native byte[] getProfileDataNative(long ptr);
69+
static native byte[] getTagNative(long profileID, int signature);
70+
private static native long loadProfileNative(byte[] data, Object ref);
71+
72+
@Override
73+
public byte[] getProfileData(Profile p) {
74+
return getLcmsProfile(p).getProfileData();
75+
}
76+
77+
@Override
78+
public byte[] getTagData(Profile p, int tagSignature) {
79+
return getLcmsProfile(p).getTag(tagSignature);
80+
}
81+
82+
@Override
83+
public synchronized void setTagData(Profile p, int tagSignature, byte[] data) {
84+
getLcmsProfile(p).setTag(tagSignature, data);
85+
}
11186

112-
public static synchronized native LCMSProfile getProfileID(ICC_Profile profile);
87+
static synchronized native LCMSProfile getProfileID(ICC_Profile profile);
11388

11489
/* Helper method used from LCMSColorTransfrom */
11590
static long createTransform(

‎src/java.desktop/share/classes/sun/java2d/cmm/lcms/LCMSProfile.java

+35-41
Original file line numberDiff line numberDiff line change
@@ -25,69 +25,63 @@
2525

2626
package sun.java2d.cmm.lcms;
2727

28-
import java.util.HashMap;
28+
import java.util.Map;
29+
import java.util.concurrent.ConcurrentHashMap;
30+
import java.util.concurrent.locks.StampedLock;
2931

3032
import sun.java2d.cmm.Profile;
3133

3234
final class LCMSProfile extends Profile {
33-
private final TagCache tagCache;
3435

3536
private final Object disposerReferent;
37+
private final Map<Integer, byte[]> tags = new ConcurrentHashMap<>();
38+
private final StampedLock lock = new StampedLock();
3639

3740
LCMSProfile(long ptr, Object ref) {
3841
super(ptr);
39-
4042
disposerReferent = ref;
41-
42-
tagCache = new TagCache(this);
4343
}
4444

4545
long getLcmsPtr() {
46-
return this.getNativePtr();
47-
}
48-
49-
TagData getTag(int sig) {
50-
return tagCache.getTag(sig);
46+
return getNativePtr();
5147
}
5248

53-
void clearTagCache() {
54-
tagCache.clear();
55-
}
56-
57-
private static final class TagCache {
58-
private final LCMSProfile profile;
59-
private final HashMap<Integer, TagData> tags = new HashMap<>();
60-
61-
private TagCache(LCMSProfile p) {
62-
profile = p;
49+
byte[] getProfileData() {
50+
long stamp = lock.readLock();
51+
try {
52+
return LCMS.getProfileDataNative(getNativePtr());
53+
} finally {
54+
lock.unlockRead(stamp);
6355
}
56+
}
6457

65-
private TagData getTag(int sig) {
66-
TagData t = tags.get(sig);
67-
if (t == null) {
68-
byte[] tagData = LCMS.getTagNative(profile.getNativePtr(), sig);
69-
if (tagData != null) {
70-
t = new TagData(tagData);
71-
tags.put(sig, t);
72-
}
73-
}
58+
byte[] getTag(int sig) {
59+
byte[] t = tags.get(sig);
60+
if (t != null) {
7461
return t;
7562
}
76-
77-
private void clear() {
78-
tags.clear();
63+
long stamp = lock.readLock();
64+
try {
65+
return tags.computeIfAbsent(sig, (key) -> {
66+
return LCMS.getTagNative(getNativePtr(), key);
67+
});
68+
} finally {
69+
lock.unlockRead(stamp);
7970
}
8071
}
8172

82-
static final class TagData {
83-
private final byte[] data;
84-
85-
TagData(byte[] data) {
86-
this.data = data;
87-
}
88-
89-
byte[] getData() {
90-
return data.clone();
73+
void setTag(int tagSignature, byte[] data) {
74+
long stamp = lock.writeLock();
75+
try {
76+
tags.clear();
77+
// Now we are going to update the profile with new tag data
78+
// In some cases, we may change the pointer to the native profile.
79+
//
80+
// If we fail to write tag data for any reason, the old pointer
81+
// should be used.
82+
LCMS.setTagDataNative(getNativePtr(), tagSignature, data);
83+
} finally {
84+
lock.unlockWrite(stamp);
9185
}
9286
}
9387
}

‎src/java.desktop/share/native/liblcms/LCMS.c

+19-37
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ void LCMS_freeTransform(JNIEnv *env, jlong ID)
128128
/*
129129
* Class: sun_java2d_cmm_lcms_LCMS
130130
* Method: createNativeTransform
131-
* Signature: ([JI)J
131+
* Signature: ([JIIZIZLjava/lang/Object;)J
132132
*/
133133
JNIEXPORT jlong JNICALL Java_sun_java2d_cmm_lcms_LCMS_createNativeTransform
134134
(JNIEnv *env, jclass cls, jlongArray profileIDs, jint renderType,
@@ -214,11 +214,11 @@ JNIEXPORT jlong JNICALL Java_sun_java2d_cmm_lcms_LCMS_createNativeTransform
214214

215215
/*
216216
* Class: sun_java2d_cmm_lcms_LCMS
217-
* Method: loadProfile
218-
* Signature: ([B,Lsun/java2d/cmm/lcms/LCMSProfile;)V
217+
* Method: loadProfileNative
218+
* Signature: ([BLjava/lang/Object;)J
219219
*/
220220
JNIEXPORT jlong JNICALL Java_sun_java2d_cmm_lcms_LCMS_loadProfileNative
221-
(JNIEnv *env, jobject obj, jbyteArray data, jobject disposerRef)
221+
(JNIEnv *env, jclass cls, jbyteArray data, jobject disposerRef)
222222
{
223223
jbyte* dataArray;
224224
jint dataSize;
@@ -278,10 +278,10 @@ JNIEXPORT jlong JNICALL Java_sun_java2d_cmm_lcms_LCMS_loadProfileNative
278278
/*
279279
* Class: sun_java2d_cmm_lcms_LCMS
280280
* Method: getProfileDataNative
281-
* Signature: (J[B)V
281+
* Signature: (J)[B
282282
*/
283283
JNIEXPORT jbyteArray JNICALL Java_sun_java2d_cmm_lcms_LCMS_getProfileDataNative
284-
(JNIEnv *env, jobject obj, jlong id)
284+
(JNIEnv *env, jclass cls, jlong id)
285285
{
286286
lcmsProfile_p sProf = (lcmsProfile_p)jlong_to_ptr(id);
287287
cmsUInt32Number pfSize = 0;
@@ -325,11 +325,11 @@ static cmsHPROFILE _writeCookedTag(cmsHPROFILE pfTarget, cmsTagSignature sig, jb
325325

326326
/*
327327
* Class: sun_java2d_cmm_lcms_LCMS
328-
* Method: getTagData
329-
* Signature: (JI[B)V
328+
* Method: getTagNative
329+
* Signature: (JI)[B
330330
*/
331331
JNIEXPORT jbyteArray JNICALL Java_sun_java2d_cmm_lcms_LCMS_getTagNative
332-
(JNIEnv *env, jobject obj, jlong id, jint tagSig)
332+
(JNIEnv *env, jclass cls, jlong id, jint tagSig)
333333
{
334334
lcmsProfile_p sProf = (lcmsProfile_p)jlong_to_ptr(id);
335335
TagSignature_t sig;
@@ -410,11 +410,11 @@ JNIEXPORT jbyteArray JNICALL Java_sun_java2d_cmm_lcms_LCMS_getTagNative
410410

411411
/*
412412
* Class: sun_java2d_cmm_lcms_LCMS
413-
* Method: setTagData
413+
* Method: setTagDataNative
414414
* Signature: (JI[B)V
415415
*/
416416
JNIEXPORT void JNICALL Java_sun_java2d_cmm_lcms_LCMS_setTagDataNative
417-
(JNIEnv *env, jobject obj, jlong id, jint tagSig, jbyteArray data)
417+
(JNIEnv *env, jclass cls, jlong id, jint tagSig, jbyteArray data)
418418
{
419419
lcmsProfile_p sProf = (lcmsProfile_p)jlong_to_ptr(id);
420420
cmsHPROFILE pfReplace = NULL;
@@ -510,7 +510,7 @@ void releaseILData (JNIEnv *env, void* pData, jint dataType,
510510
* Signature: (Lsun/java2d/cmm/lcms/LCMSTransform;Lsun/java2d/cmm/lcms/LCMSImageLayout;Lsun/java2d/cmm/lcms/LCMSImageLayout;)V
511511
*/
512512
JNIEXPORT void JNICALL Java_sun_java2d_cmm_lcms_LCMS_colorConvert
513-
(JNIEnv *env, jclass obj, jobject trans, jobject src, jobject dst)
513+
(JNIEnv *env, jclass cls, jobject trans, jobject src, jobject dst)
514514
{
515515
cmsHTRANSFORM sTrans = NULL;
516516
int srcDType, dstDType;
@@ -579,50 +579,32 @@ JNIEXPORT void JNICALL Java_sun_java2d_cmm_lcms_LCMS_colorConvert
579579
/*
580580
* Class: sun_java2d_cmm_lcms_LCMS
581581
* Method: getProfileID
582-
* Signature: (Ljava/awt/color/ICC_Profile;)Lsun/java2d/cmm/lcms/LCMSProfile
582+
* Signature: (Ljava/awt/color/ICC_Profile;)Lsun/java2d/cmm/lcms/LCMSProfile;
583583
*/
584584
JNIEXPORT jobject JNICALL Java_sun_java2d_cmm_lcms_LCMS_getProfileID
585585
(JNIEnv *env, jclass cls, jobject pf)
586586
{
587-
jclass clsLcmsProfile;
588-
jobject cmmProfile;
589-
jfieldID fid;
590-
591587
if (pf == NULL) {
592588
return NULL;
593589
}
594-
595590
jclass pcls = (*env)->GetObjectClass(env, pf);
596591
if (pcls == NULL) {
597592
return NULL;
598593
}
599-
jmethodID mid = (*env)->GetMethodID(env, pcls, "activate", "()V");
594+
jmethodID mid = (*env)->GetMethodID(env, pcls, "cmmProfile",
595+
"()Lsun/java2d/cmm/Profile;");
600596
if (mid == NULL) {
601597
return NULL;
602598
}
603-
(*env)->CallVoidMethod(env, pf, mid);
599+
jobject cmmProfile = (*env)->CallObjectMethod(env, pf, mid);
604600
if ((*env)->ExceptionOccurred(env)) {
605601
return NULL;
606602
}
607-
608-
fid = (*env)->GetFieldID(env, pcls, "cmmProfile",
609-
"Lsun/java2d/cmm/Profile;");
610-
if (fid == NULL) {
611-
return NULL;
612-
}
613-
614-
clsLcmsProfile = (*env)->FindClass(env,
615-
"sun/java2d/cmm/lcms/LCMSProfile");
616-
if (clsLcmsProfile == NULL) {
617-
return NULL;
618-
}
619-
620-
cmmProfile = (*env)->GetObjectField (env, pf, fid);
621-
622-
if (JNU_IsNull(env, cmmProfile)) {
603+
jclass lcmsPCls = (*env)->FindClass(env, "sun/java2d/cmm/lcms/LCMSProfile");
604+
if (lcmsPCls == NULL) {
623605
return NULL;
624606
}
625-
if ((*env)->IsInstanceOf(env, cmmProfile, clsLcmsProfile)) {
607+
if ((*env)->IsInstanceOf(env, cmmProfile, lcmsPCls)) {
626608
return cmmProfile;
627609
}
628610
return NULL;

0 commit comments

Comments
 (0)
Please sign in to comment.