Skip to content

Commit 40e4171

Browse files
author
Daniel D. Daugherty
committed
8264800: cleanup Threads_lock comments in JVM/TI function headers
Reviewed-by: coleenp, rehn, dholmes, sspitsyn
1 parent b17b11e commit 40e4171

File tree

3 files changed

+39
-91
lines changed

3 files changed

+39
-91
lines changed

‎src/hotspot/share/prims/jvmtiEnv.cpp

Lines changed: 35 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -140,8 +140,7 @@ JvmtiEnv::Deallocate(unsigned char* mem) {
140140
return deallocate(mem);
141141
} /* end Deallocate */
142142

143-
// Threads_lock NOT held, java_thread not protected by lock
144-
// java_thread - pre-checked
143+
// java_thread - protected by ThreadsListHandle and pre-checked
145144
// data - NULL is a valid value, must be checked
146145
jvmtiError
147146
JvmtiEnv::SetThreadLocalStorage(JavaThread* java_thread, const void* data) {
@@ -162,8 +161,7 @@ JvmtiEnv::SetThreadLocalStorage(JavaThread* java_thread, const void* data) {
162161
} /* end SetThreadLocalStorage */
163162

164163

165-
// Threads_lock NOT held
166-
// thread - NOT pre-checked
164+
// thread - NOT protected by ThreadsListHandle and NOT pre-checked
167165
// data_ptr - pre-checked for NULL
168166
jvmtiError
169167
JvmtiEnv::GetThreadLocalStorage(jthread thread, void** data_ptr) {
@@ -839,8 +837,7 @@ JvmtiEnv::GetJLocationFormat(jvmtiJlocationFormat* format_ptr) {
839837
// Thread functions
840838
//
841839

842-
// Threads_lock NOT held
843-
// thread - NOT pre-checked
840+
// thread - NOT protected by ThreadsListHandle and NOT pre-checked
844841
// thread_state_ptr - pre-checked for NULL
845842
jvmtiError
846843
JvmtiEnv::GetThreadState(jthread thread, jint* thread_state_ptr) {
@@ -936,8 +933,7 @@ JvmtiEnv::GetAllThreads(jint* threads_count_ptr, jthread** threads_ptr) {
936933
} /* end GetAllThreads */
937934

938935

939-
// Threads_lock NOT held, java_thread not protected by lock
940-
// java_thread - pre-checked
936+
// java_thread - protected by ThreadsListHandle and pre-checked
941937
jvmtiError
942938
JvmtiEnv::SuspendThread(JavaThread* java_thread) {
943939
// don't allow hidden thread suspend request.
@@ -1018,8 +1014,7 @@ JvmtiEnv::SuspendThreadList(jint request_count, const jthread* request_list, jvm
10181014
} /* end SuspendThreadList */
10191015

10201016

1021-
// Threads_lock NOT held, java_thread not protected by lock
1022-
// java_thread - pre-checked
1017+
// java_thread - protected by ThreadsListHandle and pre-checked
10231018
jvmtiError
10241019
JvmtiEnv::ResumeThread(JavaThread* java_thread) {
10251020
// don't allow hidden thread resume request.
@@ -1071,8 +1066,7 @@ JvmtiEnv::ResumeThreadList(jint request_count, const jthread* request_list, jvmt
10711066
} /* end ResumeThreadList */
10721067

10731068

1074-
// Threads_lock NOT held, java_thread not protected by lock
1075-
// java_thread - pre-checked
1069+
// java_thread - protected by ThreadsListHandle and pre-checked
10761070
jvmtiError
10771071
JvmtiEnv::StopThread(JavaThread* java_thread, jobject exception) {
10781072
oop e = JNIHandles::resolve_external_guard(exception);
@@ -1085,8 +1079,7 @@ JvmtiEnv::StopThread(JavaThread* java_thread, jobject exception) {
10851079
} /* end StopThread */
10861080

10871081

1088-
// Threads_lock NOT held
1089-
// thread - NOT pre-checked
1082+
// thread - NOT protected by ThreadsListHandle and NOT pre-checked
10901083
jvmtiError
10911084
JvmtiEnv::InterruptThread(jthread thread) {
10921085
JavaThread* current_thread = JavaThread::current();
@@ -1107,8 +1100,7 @@ JvmtiEnv::InterruptThread(jthread thread) {
11071100
} /* end InterruptThread */
11081101

11091102

1110-
// Threads_lock NOT held
1111-
// thread - NOT pre-checked
1103+
// thread - NOT protected by ThreadsListHandle and NOT pre-checked
11121104
// info_ptr - pre-checked for NULL
11131105
jvmtiError
11141106
JvmtiEnv::GetThreadInfo(jthread thread, jvmtiThreadInfo* info_ptr) {
@@ -1180,8 +1172,7 @@ JvmtiEnv::GetThreadInfo(jthread thread, jvmtiThreadInfo* info_ptr) {
11801172
} /* end GetThreadInfo */
11811173

11821174

1183-
// Threads_lock NOT held, java_thread not protected by lock
1184-
// java_thread - pre-checked
1175+
// java_thread - protected by ThreadsListHandle and pre-checked
11851176
// owned_monitor_count_ptr - pre-checked for NULL
11861177
// owned_monitors_ptr - pre-checked for NULL
11871178
jvmtiError
@@ -1230,8 +1221,7 @@ JvmtiEnv::GetOwnedMonitorInfo(JavaThread* java_thread, jint* owned_monitor_count
12301221
} /* end GetOwnedMonitorInfo */
12311222

12321223

1233-
// Threads_lock NOT held, java_thread not protected by lock
1234-
// java_thread - pre-checked
1224+
// java_thread - protected by ThreadsListHandle and pre-checked
12351225
// monitor_info_count_ptr - pre-checked for NULL
12361226
// monitor_info_ptr - pre-checked for NULL
12371227
jvmtiError
@@ -1284,8 +1274,7 @@ JvmtiEnv::GetOwnedMonitorStackDepthInfo(JavaThread* java_thread, jint* monitor_i
12841274
} /* end GetOwnedMonitorStackDepthInfo */
12851275

12861276

1287-
// Threads_lock NOT held, java_thread not protected by lock
1288-
// java_thread - pre-checked
1277+
// java_thread - protected by ThreadsListHandle and pre-checked
12891278
// monitor_ptr - pre-checked for NULL
12901279
jvmtiError
12911280
JvmtiEnv::GetCurrentContendedMonitor(JavaThread* java_thread, jobject* monitor_ptr) {
@@ -1306,8 +1295,7 @@ JvmtiEnv::GetCurrentContendedMonitor(JavaThread* java_thread, jobject* monitor_p
13061295
} /* end GetCurrentContendedMonitor */
13071296

13081297

1309-
// Threads_lock NOT held
1310-
// thread - NOT pre-checked
1298+
// thread - NOT protected by ThreadsListHandle and NOT pre-checked
13111299
// proc - pre-checked for NULL
13121300
// arg - NULL is a valid value, must be checked
13131301
jvmtiError
@@ -1521,8 +1509,7 @@ JvmtiEnv::GetThreadGroupChildren(jthreadGroup group, jint* thread_count_ptr, jth
15211509
// Stack Frame functions
15221510
//
15231511

1524-
// Threads_lock NOT held, java_thread not protected by lock
1525-
// java_thread - pre-checked
1512+
// java_thread - protected by ThreadsListHandle and pre-checked
15261513
// max_frame_count - pre-checked to be greater than or equal to 0
15271514
// frame_buffer - pre-checked for NULL
15281515
// count_ptr - pre-checked for NULL
@@ -1600,8 +1587,7 @@ JvmtiEnv::GetThreadListStackTraces(jint thread_count, const jthread* thread_list
16001587
} /* end GetThreadListStackTraces */
16011588

16021589

1603-
// Threads_lock NOT held, java_thread not protected by lock
1604-
// java_thread - pre-checked
1590+
// java_thread - protected by ThreadsListHandle and pre-checked
16051591
// count_ptr - pre-checked for NULL
16061592
jvmtiError
16071593
JvmtiEnv::GetFrameCount(JavaThread* java_thread, jint* count_ptr) {
@@ -1627,8 +1613,7 @@ JvmtiEnv::GetFrameCount(JavaThread* java_thread, jint* count_ptr) {
16271613
} /* end GetFrameCount */
16281614

16291615

1630-
// Threads_lock NOT held, java_thread not protected by lock
1631-
// java_thread - pre-checked
1616+
// java_thread - protected by ThreadsListHandle and pre-checked
16321617
jvmtiError
16331618
JvmtiEnv::PopFrame(JavaThread* java_thread) {
16341619
// retrieve or create the state
@@ -1656,9 +1641,7 @@ JvmtiEnv::PopFrame(JavaThread* java_thread) {
16561641
} /* end PopFrame */
16571642

16581643

1659-
// Threads_lock NOT held, java_thread not protected by lock
1660-
// java_thread - pre-checked
1661-
// java_thread - unchecked
1644+
// java_thread - protected by ThreadsListHandle and pre-checked
16621645
// depth - pre-checked as non-negative
16631646
// method_ptr - pre-checked for NULL
16641647
// location_ptr - pre-checked for NULL
@@ -1680,9 +1663,7 @@ JvmtiEnv::GetFrameLocation(JavaThread* java_thread, jint depth, jmethodID* metho
16801663
} /* end GetFrameLocation */
16811664

16821665

1683-
// Threads_lock NOT held, java_thread not protected by lock
1684-
// java_thread - pre-checked
1685-
// java_thread - unchecked
1666+
// java_thread - protected by ThreadsListHandle and pre-checked
16861667
// depth - pre-checked as non-negative
16871668
jvmtiError
16881669
JvmtiEnv::NotifyFramePop(JavaThread* java_thread, jint depth) {
@@ -1706,8 +1687,7 @@ JvmtiEnv::NotifyFramePop(JavaThread* java_thread, jint depth) {
17061687
// Force Early Return functions
17071688
//
17081689

1709-
// Threads_lock NOT held, java_thread not protected by lock
1710-
// java_thread - pre-checked
1690+
// java_thread - protected by ThreadsListHandle and pre-checked
17111691
jvmtiError
17121692
JvmtiEnv::ForceEarlyReturnObject(JavaThread* java_thread, jobject value) {
17131693
jvalue val;
@@ -1716,8 +1696,7 @@ JvmtiEnv::ForceEarlyReturnObject(JavaThread* java_thread, jobject value) {
17161696
} /* end ForceEarlyReturnObject */
17171697

17181698

1719-
// Threads_lock NOT held, java_thread not protected by lock
1720-
// java_thread - pre-checked
1699+
// java_thread - protected by ThreadsListHandle and pre-checked
17211700
jvmtiError
17221701
JvmtiEnv::ForceEarlyReturnInt(JavaThread* java_thread, jint value) {
17231702
jvalue val;
@@ -1726,8 +1705,7 @@ JvmtiEnv::ForceEarlyReturnInt(JavaThread* java_thread, jint value) {
17261705
} /* end ForceEarlyReturnInt */
17271706

17281707

1729-
// Threads_lock NOT held, java_thread not protected by lock
1730-
// java_thread - pre-checked
1708+
// java_thread - protected by ThreadsListHandle and pre-checked
17311709
jvmtiError
17321710
JvmtiEnv::ForceEarlyReturnLong(JavaThread* java_thread, jlong value) {
17331711
jvalue val;
@@ -1736,8 +1714,7 @@ JvmtiEnv::ForceEarlyReturnLong(JavaThread* java_thread, jlong value) {
17361714
} /* end ForceEarlyReturnLong */
17371715

17381716

1739-
// Threads_lock NOT held, java_thread not protected by lock
1740-
// java_thread - pre-checked
1717+
// java_thread - protected by ThreadsListHandle and pre-checked
17411718
jvmtiError
17421719
JvmtiEnv::ForceEarlyReturnFloat(JavaThread* java_thread, jfloat value) {
17431720
jvalue val;
@@ -1746,8 +1723,7 @@ JvmtiEnv::ForceEarlyReturnFloat(JavaThread* java_thread, jfloat value) {
17461723
} /* end ForceEarlyReturnFloat */
17471724

17481725

1749-
// Threads_lock NOT held, java_thread not protected by lock
1750-
// java_thread - pre-checked
1726+
// java_thread - protected by ThreadsListHandle and pre-checked
17511727
jvmtiError
17521728
JvmtiEnv::ForceEarlyReturnDouble(JavaThread* java_thread, jdouble value) {
17531729
jvalue val;
@@ -1756,8 +1732,7 @@ JvmtiEnv::ForceEarlyReturnDouble(JavaThread* java_thread, jdouble value) {
17561732
} /* end ForceEarlyReturnDouble */
17571733

17581734

1759-
// Threads_lock NOT held, java_thread not protected by lock
1760-
// java_thread - pre-checked
1735+
// java_thread - protected by ThreadsListHandle and pre-checked
17611736
jvmtiError
17621737
JvmtiEnv::ForceEarlyReturnVoid(JavaThread* java_thread) {
17631738
jvalue val;
@@ -1935,9 +1910,7 @@ JvmtiEnv::IterateOverInstancesOfClass(oop k_mirror, jvmtiHeapObjectFilter object
19351910
// Local Variable functions
19361911
//
19371912

1938-
// Threads_lock NOT held, java_thread not protected by lock
1939-
// java_thread - pre-checked
1940-
// java_thread - unchecked
1913+
// java_thread - protected by ThreadsListHandle and pre-checked
19411914
// depth - pre-checked as non-negative
19421915
// value_ptr - pre-checked for NULL
19431916
jvmtiError
@@ -1958,9 +1931,7 @@ JvmtiEnv::GetLocalObject(JavaThread* java_thread, jint depth, jint slot, jobject
19581931
}
19591932
} /* end GetLocalObject */
19601933

1961-
// Threads_lock NOT held, java_thread not protected by lock
1962-
// java_thread - pre-checked
1963-
// java_thread - unchecked
1934+
// java_thread - protected by ThreadsListHandle and pre-checked
19641935
// depth - pre-checked as non-negative
19651936
// value - pre-checked for NULL
19661937
jvmtiError
@@ -1982,9 +1953,7 @@ JvmtiEnv::GetLocalInstance(JavaThread* java_thread, jint depth, jobject* value_p
19821953
} /* end GetLocalInstance */
19831954

19841955

1985-
// Threads_lock NOT held, java_thread not protected by lock
1986-
// java_thread - pre-checked
1987-
// java_thread - unchecked
1956+
// java_thread - protected by ThreadsListHandle and pre-checked
19881957
// depth - pre-checked as non-negative
19891958
// value_ptr - pre-checked for NULL
19901959
jvmtiError
@@ -2000,9 +1969,7 @@ JvmtiEnv::GetLocalInt(JavaThread* java_thread, jint depth, jint slot, jint* valu
20001969
} /* end GetLocalInt */
20011970

20021971

2003-
// Threads_lock NOT held, java_thread not protected by lock
2004-
// java_thread - pre-checked
2005-
// java_thread - unchecked
1972+
// java_thread - protected by ThreadsListHandle and pre-checked
20061973
// depth - pre-checked as non-negative
20071974
// value_ptr - pre-checked for NULL
20081975
jvmtiError
@@ -2018,9 +1985,7 @@ JvmtiEnv::GetLocalLong(JavaThread* java_thread, jint depth, jint slot, jlong* va
20181985
} /* end GetLocalLong */
20191986

20201987

2021-
// Threads_lock NOT held, java_thread not protected by lock
2022-
// java_thread - pre-checked
2023-
// java_thread - unchecked
1988+
// java_thread - protected by ThreadsListHandle and pre-checked
20241989
// depth - pre-checked as non-negative
20251990
// value_ptr - pre-checked for NULL
20261991
jvmtiError
@@ -2036,9 +2001,7 @@ JvmtiEnv::GetLocalFloat(JavaThread* java_thread, jint depth, jint slot, jfloat*
20362001
} /* end GetLocalFloat */
20372002

20382003

2039-
// Threads_lock NOT held, java_thread not protected by lock
2040-
// java_thread - pre-checked
2041-
// java_thread - unchecked
2004+
// java_thread - protected by ThreadsListHandle and pre-checked
20422005
// depth - pre-checked as non-negative
20432006
// value_ptr - pre-checked for NULL
20442007
jvmtiError
@@ -2054,9 +2017,7 @@ JvmtiEnv::GetLocalDouble(JavaThread* java_thread, jint depth, jint slot, jdouble
20542017
} /* end GetLocalDouble */
20552018

20562019

2057-
// Threads_lock NOT held, java_thread not protected by lock
2058-
// java_thread - pre-checked
2059-
// java_thread - unchecked
2020+
// java_thread - protected by ThreadsListHandle and pre-checked
20602021
// depth - pre-checked as non-negative
20612022
jvmtiError
20622023
JvmtiEnv::SetLocalObject(JavaThread* java_thread, jint depth, jint slot, jobject value) {
@@ -2071,9 +2032,7 @@ JvmtiEnv::SetLocalObject(JavaThread* java_thread, jint depth, jint slot, jobject
20712032
} /* end SetLocalObject */
20722033

20732034

2074-
// Threads_lock NOT held, java_thread not protected by lock
2075-
// java_thread - pre-checked
2076-
// java_thread - unchecked
2035+
// java_thread - protected by ThreadsListHandle and pre-checked
20772036
// depth - pre-checked as non-negative
20782037
jvmtiError
20792038
JvmtiEnv::SetLocalInt(JavaThread* java_thread, jint depth, jint slot, jint value) {
@@ -2088,9 +2047,7 @@ JvmtiEnv::SetLocalInt(JavaThread* java_thread, jint depth, jint slot, jint value
20882047
} /* end SetLocalInt */
20892048

20902049

2091-
// Threads_lock NOT held, java_thread not protected by lock
2092-
// java_thread - pre-checked
2093-
// java_thread - unchecked
2050+
// java_thread - protected by ThreadsListHandle and pre-checked
20942051
// depth - pre-checked as non-negative
20952052
jvmtiError
20962053
JvmtiEnv::SetLocalLong(JavaThread* java_thread, jint depth, jint slot, jlong value) {
@@ -2105,9 +2062,7 @@ JvmtiEnv::SetLocalLong(JavaThread* java_thread, jint depth, jint slot, jlong val
21052062
} /* end SetLocalLong */
21062063

21072064

2108-
// Threads_lock NOT held, java_thread not protected by lock
2109-
// java_thread - pre-checked
2110-
// java_thread - unchecked
2065+
// java_thread - protected by ThreadsListHandle and pre-checked
21112066
// depth - pre-checked as non-negative
21122067
jvmtiError
21132068
JvmtiEnv::SetLocalFloat(JavaThread* java_thread, jint depth, jint slot, jfloat value) {
@@ -2122,9 +2077,7 @@ JvmtiEnv::SetLocalFloat(JavaThread* java_thread, jint depth, jint slot, jfloat v
21222077
} /* end SetLocalFloat */
21232078

21242079

2125-
// Threads_lock NOT held, java_thread not protected by lock
2126-
// java_thread - pre-checked
2127-
// java_thread - unchecked
2080+
// java_thread - protected by ThreadsListHandle and pre-checked
21282081
// depth - pre-checked as non-negative
21292082
jvmtiError
21302083
JvmtiEnv::SetLocalDouble(JavaThread* java_thread, jint depth, jint slot, jdouble value) {
@@ -3369,8 +3322,7 @@ JvmtiEnv::GetThreadCpuTimerInfo(jvmtiTimerInfo* info_ptr) {
33693322
} /* end GetThreadCpuTimerInfo */
33703323

33713324

3372-
// Threads_lock NOT held, java_thread not protected by lock
3373-
// java_thread - pre-checked
3325+
// java_thread - protected by ThreadsListHandle and pre-checked
33743326
// nanos_ptr - pre-checked for NULL
33753327
jvmtiError
33763328
JvmtiEnv::GetThreadCpuTime(JavaThread* java_thread, jlong* nanos_ptr) {

‎src/hotspot/share/prims/jvmtiEnv.xsl

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?xml version="1.0"?>
22
<!--
3-
Copyright (c) 2002, 2020, Oracle and/or its affiliates. All rights reserved.
3+
Copyright (c) 2002, 2021, Oracle and/or its affiliates. All rights reserved.
44
DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
55
66
This code is free software; you can redistribute it and/or modify it
@@ -110,15 +110,13 @@ JvmtiEnv::</xsl:text>
110110
<xsl:choose>
111111
<xsl:when test="count(@impl)=0 or not(contains(@impl,'noconvert'))">
112112
<xsl:text>
113-
// Threads_lock NOT held, java_thread not protected by lock
114-
// java_thread - pre-checked</xsl:text>
113+
// java_thread - protected by ThreadsListHandle and pre-checked</xsl:text>
115114
</xsl:when>
116115
<xsl:otherwise>
117116
<xsl:text>
118-
// Threads_lock NOT held
119117
// </xsl:text>
120118
<xsl:value-of select="$name"/>
121-
<xsl:text> - NOT pre-checked</xsl:text>
119+
<xsl:text> - NOT protected by ThreadsListHandle and NOT pre-checked</xsl:text>
122120
</xsl:otherwise>
123121
</xsl:choose>
124122
</xsl:template>
@@ -132,7 +130,6 @@ JvmtiEnv::</xsl:text>
132130
<xsl:template match="jframeID" mode="advice">
133131
<xsl:param name="name"/>
134132
<xsl:text>
135-
// java_thread - unchecked
136133
// depth - pre-checked as non-negative</xsl:text>
137134
</xsl:template>
138135

0 commit comments

Comments
 (0)