| <!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: AsyncRegionLocatorHelper"> |
| <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.exceptions.ClientExceptionsUtil.findException;</span> |
| <span class="source-line-no">021</span><span id="line-21">import static org.apache.hadoop.hbase.exceptions.ClientExceptionsUtil.isMetaClearingException;</span> |
| <span class="source-line-no">022</span><span id="line-22"></span> |
| <span class="source-line-no">023</span><span id="line-23">import java.util.Arrays;</span> |
| <span class="source-line-no">024</span><span id="line-24">import java.util.function.Consumer;</span> |
| <span class="source-line-no">025</span><span id="line-25">import java.util.function.Function;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.commons.lang3.ObjectUtils;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.HRegionLocation;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.RegionLocations;</span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.exceptions.RegionMovedException;</span> |
| <span class="source-line-no">030</span><span id="line-30">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">031</span><span id="line-31">import org.slf4j.Logger;</span> |
| <span class="source-line-no">032</span><span id="line-32">import org.slf4j.LoggerFactory;</span> |
| <span class="source-line-no">033</span><span id="line-33"></span> |
| <span class="source-line-no">034</span><span id="line-34">/**</span> |
| <span class="source-line-no">035</span><span id="line-35"> * Helper class for asynchronous region locator.</span> |
| <span class="source-line-no">036</span><span id="line-36"> */</span> |
| <span class="source-line-no">037</span><span id="line-37">@InterfaceAudience.Private</span> |
| <span class="source-line-no">038</span><span id="line-38">final class AsyncRegionLocatorHelper {</span> |
| <span class="source-line-no">039</span><span id="line-39"></span> |
| <span class="source-line-no">040</span><span id="line-40"> private static final Logger LOG = LoggerFactory.getLogger(AsyncRegionLocatorHelper.class);</span> |
| <span class="source-line-no">041</span><span id="line-41"></span> |
| <span class="source-line-no">042</span><span id="line-42"> private AsyncRegionLocatorHelper() {</span> |
| <span class="source-line-no">043</span><span id="line-43"> }</span> |
| <span class="source-line-no">044</span><span id="line-44"></span> |
| <span class="source-line-no">045</span><span id="line-45"> static boolean canUpdateOnError(HRegionLocation loc, HRegionLocation oldLoc) {</span> |
| <span class="source-line-no">046</span><span id="line-46"> // Do not need to update if no such location, or the location is newer, or the location is not</span> |
| <span class="source-line-no">047</span><span id="line-47"> // the same with us</span> |
| <span class="source-line-no">048</span><span id="line-48"> if (loc == null || loc.getServerName() == null) {</span> |
| <span class="source-line-no">049</span><span id="line-49"> return false;</span> |
| <span class="source-line-no">050</span><span id="line-50"> }</span> |
| <span class="source-line-no">051</span><span id="line-51"> if (oldLoc == null || oldLoc.getServerName() == null) {</span> |
| <span class="source-line-no">052</span><span id="line-52"> return false;</span> |
| <span class="source-line-no">053</span><span id="line-53"> }</span> |
| <span class="source-line-no">054</span><span id="line-54"> return oldLoc.getSeqNum() <= loc.getSeqNum()</span> |
| <span class="source-line-no">055</span><span id="line-55"> && oldLoc.getServerName().equals(loc.getServerName());</span> |
| <span class="source-line-no">056</span><span id="line-56"> }</span> |
| <span class="source-line-no">057</span><span id="line-57"></span> |
| <span class="source-line-no">058</span><span id="line-58"> static void updateCachedLocationOnError(HRegionLocation loc, Throwable exception,</span> |
| <span class="source-line-no">059</span><span id="line-59"> Function<HRegionLocation, HRegionLocation> cachedLocationSupplier,</span> |
| <span class="source-line-no">060</span><span id="line-60"> Consumer<HRegionLocation> addToCache, Consumer<HRegionLocation> removeFromCache,</span> |
| <span class="source-line-no">061</span><span id="line-61"> MetricsConnection metrics) {</span> |
| <span class="source-line-no">062</span><span id="line-62"> HRegionLocation oldLoc = cachedLocationSupplier.apply(loc);</span> |
| <span class="source-line-no">063</span><span id="line-63"> if (LOG.isDebugEnabled()) {</span> |
| <span class="source-line-no">064</span><span id="line-64"> LOG.debug("Try updating {} , the old value is {}, error={}", loc, oldLoc,</span> |
| <span class="source-line-no">065</span><span id="line-65"> exception != null ? exception.toString() : "none");</span> |
| <span class="source-line-no">066</span><span id="line-66"> }</span> |
| <span class="source-line-no">067</span><span id="line-67"> if (!canUpdateOnError(loc, oldLoc)) {</span> |
| <span class="source-line-no">068</span><span id="line-68"> return;</span> |
| <span class="source-line-no">069</span><span id="line-69"> }</span> |
| <span class="source-line-no">070</span><span id="line-70"> Throwable cause = findException(exception);</span> |
| <span class="source-line-no">071</span><span id="line-71"> if (LOG.isDebugEnabled()) {</span> |
| <span class="source-line-no">072</span><span id="line-72"> LOG.debug("The actual exception when updating {} is {}", loc,</span> |
| <span class="source-line-no">073</span><span id="line-73"> cause != null ? cause.toString() : "none");</span> |
| <span class="source-line-no">074</span><span id="line-74"> }</span> |
| <span class="source-line-no">075</span><span id="line-75"> if (cause == null || !isMetaClearingException(cause)) {</span> |
| <span class="source-line-no">076</span><span id="line-76"> LOG.debug("Will not update {} because the exception is null or not the one we care about",</span> |
| <span class="source-line-no">077</span><span id="line-77"> loc);</span> |
| <span class="source-line-no">078</span><span id="line-78"> return;</span> |
| <span class="source-line-no">079</span><span id="line-79"> }</span> |
| <span class="source-line-no">080</span><span id="line-80"> if (cause instanceof RegionMovedException) {</span> |
| <span class="source-line-no">081</span><span id="line-81"> RegionMovedException rme = (RegionMovedException) cause;</span> |
| <span class="source-line-no">082</span><span id="line-82"> HRegionLocation newLoc =</span> |
| <span class="source-line-no">083</span><span id="line-83"> new HRegionLocation(loc.getRegion(), rme.getServerName(), rme.getLocationSeqNum());</span> |
| <span class="source-line-no">084</span><span id="line-84"> LOG.debug("Try updating {} with the new location {} constructed by {}", loc, newLoc,</span> |
| <span class="source-line-no">085</span><span id="line-85"> rme.toString());</span> |
| <span class="source-line-no">086</span><span id="line-86"> addToCache.accept(newLoc);</span> |
| <span class="source-line-no">087</span><span id="line-87"> } else {</span> |
| <span class="source-line-no">088</span><span id="line-88"> LOG.debug("Try removing {} from cache", loc);</span> |
| <span class="source-line-no">089</span><span id="line-89"> if (metrics != null) {</span> |
| <span class="source-line-no">090</span><span id="line-90"> metrics.incrCacheDroppingExceptions(exception);</span> |
| <span class="source-line-no">091</span><span id="line-91"> }</span> |
| <span class="source-line-no">092</span><span id="line-92"> removeFromCache.accept(loc);</span> |
| <span class="source-line-no">093</span><span id="line-93"> }</span> |
| <span class="source-line-no">094</span><span id="line-94"> }</span> |
| <span class="source-line-no">095</span><span id="line-95"></span> |
| <span class="source-line-no">096</span><span id="line-96"> static RegionLocations createRegionLocations(HRegionLocation loc) {</span> |
| <span class="source-line-no">097</span><span id="line-97"> int replicaId = loc.getRegion().getReplicaId();</span> |
| <span class="source-line-no">098</span><span id="line-98"> HRegionLocation[] locs = new HRegionLocation[replicaId + 1];</span> |
| <span class="source-line-no">099</span><span id="line-99"> locs[replicaId] = loc;</span> |
| <span class="source-line-no">100</span><span id="line-100"> return new RegionLocations(locs);</span> |
| <span class="source-line-no">101</span><span id="line-101"> }</span> |
| <span class="source-line-no">102</span><span id="line-102"></span> |
| <span class="source-line-no">103</span><span id="line-103"> /**</span> |
| <span class="source-line-no">104</span><span id="line-104"> * Create a new {@link RegionLocations} based on the given {@code oldLocs}, and replace the</span> |
| <span class="source-line-no">105</span><span id="line-105"> * location for the given {@code replicaId} with the given {@code loc}.</span> |
| <span class="source-line-no">106</span><span id="line-106"> * <p/></span> |
| <span class="source-line-no">107</span><span id="line-107"> * All the {@link RegionLocations} in async locator related class are immutable because we want to</span> |
| <span class="source-line-no">108</span><span id="line-108"> * access them concurrently, so here we need to create a new one, instead of calling</span> |
| <span class="source-line-no">109</span><span id="line-109"> * {@link RegionLocations#updateLocation(HRegionLocation, boolean, boolean)}.</span> |
| <span class="source-line-no">110</span><span id="line-110"> */</span> |
| <span class="source-line-no">111</span><span id="line-111"> static RegionLocations replaceRegionLocation(RegionLocations oldLocs, HRegionLocation loc) {</span> |
| <span class="source-line-no">112</span><span id="line-112"> int replicaId = loc.getRegion().getReplicaId();</span> |
| <span class="source-line-no">113</span><span id="line-113"> HRegionLocation[] locs = oldLocs.getRegionLocations();</span> |
| <span class="source-line-no">114</span><span id="line-114"> locs = Arrays.copyOf(locs, Math.max(replicaId + 1, locs.length));</span> |
| <span class="source-line-no">115</span><span id="line-115"> locs[replicaId] = loc;</span> |
| <span class="source-line-no">116</span><span id="line-116"> return new RegionLocations(locs);</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"> /**</span> |
| <span class="source-line-no">120</span><span id="line-120"> * Create a new {@link RegionLocations} based on the given {@code oldLocs}, and remove the</span> |
| <span class="source-line-no">121</span><span id="line-121"> * location for the given {@code replicaId}.</span> |
| <span class="source-line-no">122</span><span id="line-122"> * <p/></span> |
| <span class="source-line-no">123</span><span id="line-123"> * All the {@link RegionLocations} in async locator related class are immutable because we want to</span> |
| <span class="source-line-no">124</span><span id="line-124"> * access them concurrently, so here we need to create a new one, instead of calling</span> |
| <span class="source-line-no">125</span><span id="line-125"> * {@link RegionLocations#remove(int)}.</span> |
| <span class="source-line-no">126</span><span id="line-126"> */</span> |
| <span class="source-line-no">127</span><span id="line-127"> static RegionLocations removeRegionLocation(RegionLocations oldLocs, int replicaId) {</span> |
| <span class="source-line-no">128</span><span id="line-128"> HRegionLocation[] locs = oldLocs.getRegionLocations();</span> |
| <span class="source-line-no">129</span><span id="line-129"> if (locs.length < replicaId + 1) {</span> |
| <span class="source-line-no">130</span><span id="line-130"> // Here we do not modify the oldLocs so it is safe to return it.</span> |
| <span class="source-line-no">131</span><span id="line-131"> return oldLocs;</span> |
| <span class="source-line-no">132</span><span id="line-132"> }</span> |
| <span class="source-line-no">133</span><span id="line-133"> locs = Arrays.copyOf(locs, locs.length);</span> |
| <span class="source-line-no">134</span><span id="line-134"> locs[replicaId] = null;</span> |
| <span class="source-line-no">135</span><span id="line-135"> if (ObjectUtils.firstNonNull(locs) != null) {</span> |
| <span class="source-line-no">136</span><span id="line-136"> return new RegionLocations(locs);</span> |
| <span class="source-line-no">137</span><span id="line-137"> } else {</span> |
| <span class="source-line-no">138</span><span id="line-138"> // if all the locations are null, just return null</span> |
| <span class="source-line-no">139</span><span id="line-139"> return null;</span> |
| <span class="source-line-no">140</span><span id="line-140"> }</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"> static boolean isGood(RegionLocations locs, int replicaId) {</span> |
| <span class="source-line-no">144</span><span id="line-144"> if (locs == null) {</span> |
| <span class="source-line-no">145</span><span id="line-145"> return false;</span> |
| <span class="source-line-no">146</span><span id="line-146"> }</span> |
| <span class="source-line-no">147</span><span id="line-147"> HRegionLocation loc = locs.getRegionLocation(replicaId);</span> |
| <span class="source-line-no">148</span><span id="line-148"> return loc != null && loc.getServerName() != null;</span> |
| <span class="source-line-no">149</span><span id="line-149"> }</span> |
| <span class="source-line-no">150</span><span id="line-150">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
