blob: a08184bd16b16f3a7ec9e20e6eeb1238594e9385 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a>
<span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a>
<span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a>
<span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a>
<span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a>
<span class="sourceLineNo">017</span> */<a name="line.17"></a>
<span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.regionserver;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.util.concurrent.CompletableFuture;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.util.concurrent.TimeUnit;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.function.Supplier;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.stream.Stream;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.HBaseClassTestRule;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.client.RegionInfo;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.client.RegionInfoBuilder;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.testclassification.LargeTests;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.testclassification.RegionServerTests;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.junit.ClassRule;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.junit.Test;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.junit.experimental.categories.Category;<a name="line.31"></a>
<span class="sourceLineNo">032</span><a name="line.32"></a>
<span class="sourceLineNo">033</span>/**<a name="line.33"></a>
<span class="sourceLineNo">034</span> * Test for the tangled mess that is static initialization of our our {@link RegionInfo} and<a name="line.34"></a>
<span class="sourceLineNo">035</span> * {@link RegionInfoBuilder}, as reported on HBASE-24896. The condition being tested can only be<a name="line.35"></a>
<span class="sourceLineNo">036</span> * reproduced the first time a JVM loads the classes under test. Thus, this test is marked as a<a name="line.36"></a>
<span class="sourceLineNo">037</span> * {@link LargeTests} because, under their current configuration, tests in that category are run<a name="line.37"></a>
<span class="sourceLineNo">038</span> * in their own JVM instances.<a name="line.38"></a>
<span class="sourceLineNo">039</span> */<a name="line.39"></a>
<span class="sourceLineNo">040</span>@SuppressWarnings("deprecation")<a name="line.40"></a>
<span class="sourceLineNo">041</span>@Category({ RegionServerTests.class, LargeTests.class})<a name="line.41"></a>
<span class="sourceLineNo">042</span>public class TestRegionInfoStaticInitialization {<a name="line.42"></a>
<span class="sourceLineNo">043</span> @ClassRule<a name="line.43"></a>
<span class="sourceLineNo">044</span> public static final HBaseClassTestRule CLASS_RULE =<a name="line.44"></a>
<span class="sourceLineNo">045</span> HBaseClassTestRule.forClass(TestRegionInfoStaticInitialization.class);<a name="line.45"></a>
<span class="sourceLineNo">046</span><a name="line.46"></a>
<span class="sourceLineNo">047</span> @Test<a name="line.47"></a>
<span class="sourceLineNo">048</span> public void testParallelStaticInitialization() throws Exception {<a name="line.48"></a>
<span class="sourceLineNo">049</span> // The JVM loads symbols lazily. These suppliers reference two symbols that, before this patch,<a name="line.49"></a>
<span class="sourceLineNo">050</span> // are mutually dependent and expose a deadlock in the loading of symbols from RegionInfo and<a name="line.50"></a>
<span class="sourceLineNo">051</span> // RegionInfoBuilder.<a name="line.51"></a>
<span class="sourceLineNo">052</span> final Supplier&lt;RegionInfo&gt; retrieveUNDEFINED = () -&gt; RegionInfo.UNDEFINED;<a name="line.52"></a>
<span class="sourceLineNo">053</span> final Supplier&lt;RegionInfo&gt; retrieveMetaRegionInfo =<a name="line.53"></a>
<span class="sourceLineNo">054</span> () -&gt; RegionInfoBuilder.FIRST_META_REGIONINFO;<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span> // The test runs multiple threads that reference these mutually dependent symbols. In order to<a name="line.56"></a>
<span class="sourceLineNo">057</span> // express this bug, these threads need to access these symbols at roughly the same time, so<a name="line.57"></a>
<span class="sourceLineNo">058</span> // that the classloader is asked to materialize these symbols concurrently. These Suppliers are<a name="line.58"></a>
<span class="sourceLineNo">059</span> // run on threads that have already been allocated, managed by the system's ForkJoin pool.<a name="line.59"></a>
<span class="sourceLineNo">060</span> final CompletableFuture&lt;?&gt;[] futures = Stream.of(<a name="line.60"></a>
<span class="sourceLineNo">061</span> retrieveUNDEFINED, retrieveMetaRegionInfo, retrieveUNDEFINED, retrieveMetaRegionInfo)<a name="line.61"></a>
<span class="sourceLineNo">062</span> .map(CompletableFuture::supplyAsync)<a name="line.62"></a>
<span class="sourceLineNo">063</span> .toArray(CompletableFuture&lt;?&gt;[]::new);<a name="line.63"></a>
<span class="sourceLineNo">064</span><a name="line.64"></a>
<span class="sourceLineNo">065</span> // Loading classes should be relatively fast. 5 seconds is an arbitrary choice of timeout. It<a name="line.65"></a>
<span class="sourceLineNo">066</span> // was chosen under the assumption that loading these symbols should complete much faster than<a name="line.66"></a>
<span class="sourceLineNo">067</span> // this window.<a name="line.67"></a>
<span class="sourceLineNo">068</span> CompletableFuture.allOf(futures).get(5, TimeUnit.SECONDS);<a name="line.68"></a>
<span class="sourceLineNo">069</span> }<a name="line.69"></a>
<span class="sourceLineNo">070</span>}<a name="line.70"></a>
</pre>
</div>
</body>
</html>