blob: 23741c8d93636ad0e24c6142a31f79b6eb8b908a [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Source code</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="source: package: org.apache.hadoop.hbase.client, class: AsyncMetaRegionLocator">
<meta name="generator" content="javadoc/SourceToHTMLConverter">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body class="source-page">
<main role="main">
<div class="source-container">
<pre><span class="source-line-no">001</span><span id="line-1">/*</span>
<span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span>
<span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span>
<span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span>
<span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span>
<span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span>
<span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span>
<span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span>
<span class="source-line-no">009</span><span id="line-9"> *</span>
<span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="source-line-no">011</span><span id="line-11"> *</span>
<span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span>
<span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
<span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span>
<span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span>
<span class="source-line-no">017</span><span id="line-17"> */</span>
<span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.client;</span>
<span class="source-line-no">019</span><span id="line-19"></span>
<span class="source-line-no">020</span><span id="line-20">import static org.apache.hadoop.hbase.client.AsyncRegionLocatorHelper.canUpdateOnError;</span>
<span class="source-line-no">021</span><span id="line-21">import static org.apache.hadoop.hbase.client.AsyncRegionLocatorHelper.createRegionLocations;</span>
<span class="source-line-no">022</span><span id="line-22">import static org.apache.hadoop.hbase.client.AsyncRegionLocatorHelper.isGood;</span>
<span class="source-line-no">023</span><span id="line-23">import static org.apache.hadoop.hbase.client.AsyncRegionLocatorHelper.removeRegionLocation;</span>
<span class="source-line-no">024</span><span id="line-24">import static org.apache.hadoop.hbase.client.AsyncRegionLocatorHelper.replaceRegionLocation;</span>
<span class="source-line-no">025</span><span id="line-25"></span>
<span class="source-line-no">026</span><span id="line-26">import java.util.concurrent.CompletableFuture;</span>
<span class="source-line-no">027</span><span id="line-27">import java.util.concurrent.atomic.AtomicReference;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.HRegionLocation;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.RegionLocations;</span>
<span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.ServerName;</span>
<span class="source-line-no">031</span><span id="line-31">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">032</span><span id="line-32"></span>
<span class="source-line-no">033</span><span id="line-33">/**</span>
<span class="source-line-no">034</span><span id="line-34"> * The asynchronous locator for meta region.</span>
<span class="source-line-no">035</span><span id="line-35"> */</span>
<span class="source-line-no">036</span><span id="line-36">@InterfaceAudience.Private</span>
<span class="source-line-no">037</span><span id="line-37">class AsyncMetaRegionLocator {</span>
<span class="source-line-no">038</span><span id="line-38"></span>
<span class="source-line-no">039</span><span id="line-39"> private final ConnectionRegistry registry;</span>
<span class="source-line-no">040</span><span id="line-40"></span>
<span class="source-line-no">041</span><span id="line-41"> private final AtomicReference&lt;RegionLocations&gt; metaRegionLocations = new AtomicReference&lt;&gt;();</span>
<span class="source-line-no">042</span><span id="line-42"></span>
<span class="source-line-no">043</span><span id="line-43"> private final AtomicReference&lt;CompletableFuture&lt;RegionLocations&gt;&gt; metaRelocateFuture =</span>
<span class="source-line-no">044</span><span id="line-44"> new AtomicReference&lt;&gt;();</span>
<span class="source-line-no">045</span><span id="line-45"></span>
<span class="source-line-no">046</span><span id="line-46"> AsyncMetaRegionLocator(ConnectionRegistry registry) {</span>
<span class="source-line-no">047</span><span id="line-47"> this.registry = registry;</span>
<span class="source-line-no">048</span><span id="line-48"> }</span>
<span class="source-line-no">049</span><span id="line-49"></span>
<span class="source-line-no">050</span><span id="line-50"> /**</span>
<span class="source-line-no">051</span><span id="line-51"> * Get the region locations for meta region. If the location for the given replica is not</span>
<span class="source-line-no">052</span><span id="line-52"> * available in the cached locations, then fetch from the HBase cluster.</span>
<span class="source-line-no">053</span><span id="line-53"> * &lt;p/&gt;</span>
<span class="source-line-no">054</span><span id="line-54"> * The &lt;code&gt;replicaId&lt;/code&gt; parameter is important. If the region replication config for meta</span>
<span class="source-line-no">055</span><span id="line-55"> * region is changed, then the cached region locations may not have the locations for new</span>
<span class="source-line-no">056</span><span id="line-56"> * replicas. If we do not check the location for the given replica, we will always return the</span>
<span class="source-line-no">057</span><span id="line-57"> * cached region locations and cause an infinite loop.</span>
<span class="source-line-no">058</span><span id="line-58"> */</span>
<span class="source-line-no">059</span><span id="line-59"> CompletableFuture&lt;RegionLocations&gt; getRegionLocations(int replicaId, boolean reload) {</span>
<span class="source-line-no">060</span><span id="line-60"> return ConnectionUtils.getOrFetch(metaRegionLocations, metaRelocateFuture, reload,</span>
<span class="source-line-no">061</span><span id="line-61"> registry::getMetaRegionLocations, locs -&gt; isGood(locs, replicaId), "meta region location");</span>
<span class="source-line-no">062</span><span id="line-62"> }</span>
<span class="source-line-no">063</span><span id="line-63"></span>
<span class="source-line-no">064</span><span id="line-64"> private HRegionLocation getCacheLocation(HRegionLocation loc) {</span>
<span class="source-line-no">065</span><span id="line-65"> RegionLocations locs = metaRegionLocations.get();</span>
<span class="source-line-no">066</span><span id="line-66"> return locs != null ? locs.getRegionLocation(loc.getRegion().getReplicaId()) : null;</span>
<span class="source-line-no">067</span><span id="line-67"> }</span>
<span class="source-line-no">068</span><span id="line-68"></span>
<span class="source-line-no">069</span><span id="line-69"> private void addLocationToCache(HRegionLocation loc) {</span>
<span class="source-line-no">070</span><span id="line-70"> for (;;) {</span>
<span class="source-line-no">071</span><span id="line-71"> int replicaId = loc.getRegion().getReplicaId();</span>
<span class="source-line-no">072</span><span id="line-72"> RegionLocations oldLocs = metaRegionLocations.get();</span>
<span class="source-line-no">073</span><span id="line-73"> if (oldLocs == null) {</span>
<span class="source-line-no">074</span><span id="line-74"> RegionLocations newLocs = createRegionLocations(loc);</span>
<span class="source-line-no">075</span><span id="line-75"> if (metaRegionLocations.compareAndSet(null, newLocs)) {</span>
<span class="source-line-no">076</span><span id="line-76"> return;</span>
<span class="source-line-no">077</span><span id="line-77"> }</span>
<span class="source-line-no">078</span><span id="line-78"> }</span>
<span class="source-line-no">079</span><span id="line-79"> HRegionLocation oldLoc = oldLocs.getRegionLocation(replicaId);</span>
<span class="source-line-no">080</span><span id="line-80"> if (</span>
<span class="source-line-no">081</span><span id="line-81"> oldLoc != null &amp;&amp; (oldLoc.getSeqNum() &gt; loc.getSeqNum()</span>
<span class="source-line-no">082</span><span id="line-82"> || oldLoc.getServerName().equals(loc.getServerName()))</span>
<span class="source-line-no">083</span><span id="line-83"> ) {</span>
<span class="source-line-no">084</span><span id="line-84"> return;</span>
<span class="source-line-no">085</span><span id="line-85"> }</span>
<span class="source-line-no">086</span><span id="line-86"> RegionLocations newLocs = replaceRegionLocation(oldLocs, loc);</span>
<span class="source-line-no">087</span><span id="line-87"> if (metaRegionLocations.compareAndSet(oldLocs, newLocs)) {</span>
<span class="source-line-no">088</span><span id="line-88"> return;</span>
<span class="source-line-no">089</span><span id="line-89"> }</span>
<span class="source-line-no">090</span><span id="line-90"> }</span>
<span class="source-line-no">091</span><span id="line-91"> }</span>
<span class="source-line-no">092</span><span id="line-92"></span>
<span class="source-line-no">093</span><span id="line-93"> private void removeLocationFromCache(HRegionLocation loc) {</span>
<span class="source-line-no">094</span><span id="line-94"> for (;;) {</span>
<span class="source-line-no">095</span><span id="line-95"> RegionLocations oldLocs = metaRegionLocations.get();</span>
<span class="source-line-no">096</span><span id="line-96"> if (oldLocs == null) {</span>
<span class="source-line-no">097</span><span id="line-97"> return;</span>
<span class="source-line-no">098</span><span id="line-98"> }</span>
<span class="source-line-no">099</span><span id="line-99"> HRegionLocation oldLoc = oldLocs.getRegionLocation(loc.getRegion().getReplicaId());</span>
<span class="source-line-no">100</span><span id="line-100"> if (!canUpdateOnError(loc, oldLoc)) {</span>
<span class="source-line-no">101</span><span id="line-101"> return;</span>
<span class="source-line-no">102</span><span id="line-102"> }</span>
<span class="source-line-no">103</span><span id="line-103"> RegionLocations newLocs = removeRegionLocation(oldLocs, loc.getRegion().getReplicaId());</span>
<span class="source-line-no">104</span><span id="line-104"> if (metaRegionLocations.compareAndSet(oldLocs, newLocs)) {</span>
<span class="source-line-no">105</span><span id="line-105"> return;</span>
<span class="source-line-no">106</span><span id="line-106"> }</span>
<span class="source-line-no">107</span><span id="line-107"> }</span>
<span class="source-line-no">108</span><span id="line-108"> }</span>
<span class="source-line-no">109</span><span id="line-109"></span>
<span class="source-line-no">110</span><span id="line-110"> void updateCachedLocationOnError(HRegionLocation loc, Throwable exception) {</span>
<span class="source-line-no">111</span><span id="line-111"> AsyncRegionLocatorHelper.updateCachedLocationOnError(loc, exception, this::getCacheLocation,</span>
<span class="source-line-no">112</span><span id="line-112"> this::addLocationToCache, this::removeLocationFromCache, null);</span>
<span class="source-line-no">113</span><span id="line-113"> }</span>
<span class="source-line-no">114</span><span id="line-114"></span>
<span class="source-line-no">115</span><span id="line-115"> void clearCache() {</span>
<span class="source-line-no">116</span><span id="line-116"> metaRegionLocations.set(null);</span>
<span class="source-line-no">117</span><span id="line-117"> }</span>
<span class="source-line-no">118</span><span id="line-118"></span>
<span class="source-line-no">119</span><span id="line-119"> void clearCache(ServerName serverName) {</span>
<span class="source-line-no">120</span><span id="line-120"> for (;;) {</span>
<span class="source-line-no">121</span><span id="line-121"> RegionLocations locs = metaRegionLocations.get();</span>
<span class="source-line-no">122</span><span id="line-122"> if (locs == null) {</span>
<span class="source-line-no">123</span><span id="line-123"> return;</span>
<span class="source-line-no">124</span><span id="line-124"> }</span>
<span class="source-line-no">125</span><span id="line-125"> RegionLocations newLocs = locs.removeByServer(serverName);</span>
<span class="source-line-no">126</span><span id="line-126"> if (locs == newLocs) {</span>
<span class="source-line-no">127</span><span id="line-127"> return;</span>
<span class="source-line-no">128</span><span id="line-128"> }</span>
<span class="source-line-no">129</span><span id="line-129"> if (newLocs.isEmpty()) {</span>
<span class="source-line-no">130</span><span id="line-130"> newLocs = null;</span>
<span class="source-line-no">131</span><span id="line-131"> }</span>
<span class="source-line-no">132</span><span id="line-132"> if (metaRegionLocations.compareAndSet(locs, newLocs)) {</span>
<span class="source-line-no">133</span><span id="line-133"> return;</span>
<span class="source-line-no">134</span><span id="line-134"> }</span>
<span class="source-line-no">135</span><span id="line-135"> }</span>
<span class="source-line-no">136</span><span id="line-136"> }</span>
<span class="source-line-no">137</span><span id="line-137"></span>
<span class="source-line-no">138</span><span id="line-138"> // only used for testing whether we have cached the location for a region.</span>
<span class="source-line-no">139</span><span id="line-139"> RegionLocations getRegionLocationInCache() {</span>
<span class="source-line-no">140</span><span id="line-140"> return metaRegionLocations.get();</span>
<span class="source-line-no">141</span><span id="line-141"> }</span>
<span class="source-line-no">142</span><span id="line-142"></span>
<span class="source-line-no">143</span><span id="line-143"> // only used for testing whether we have cached the location for a table.</span>
<span class="source-line-no">144</span><span id="line-144"> int getNumberOfCachedRegionLocations() {</span>
<span class="source-line-no">145</span><span id="line-145"> RegionLocations locs = metaRegionLocations.get();</span>
<span class="source-line-no">146</span><span id="line-146"> return locs != null ? locs.numNonNullElements() : 0;</span>
<span class="source-line-no">147</span><span id="line-147"> }</span>
<span class="source-line-no">148</span><span id="line-148">}</span>
</pre>
</div>
</main>
</body>
</html>