blob: fab122d853c0c6d46aecfdc2c5e9960a84e16d1c [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.regionserver, class: RSSnapshotVerifier">
<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.regionserver;</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 java.io.IOException;</span>
<span class="source-line-no">021</span><span id="line-21">import java.util.Map;</span>
<span class="source-line-no">022</span><span id="line-22">import java.util.concurrent.ExecutionException;</span>
<span class="source-line-no">023</span><span id="line-23">import java.util.concurrent.TimeUnit;</span>
<span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.conf.Configuration;</span>
<span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.fs.FileSystem;</span>
<span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.fs.Path;</span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.client.RegionInfo;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.snapshot.CorruptedSnapshotException;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.snapshot.SnapshotDescriptionUtils;</span>
<span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.snapshot.SnapshotManifest;</span>
<span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.snapshot.SnapshotReferenceUtil;</span>
<span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.snapshot.SnapshotReferenceUtil.StoreFileVisitor;</span>
<span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.hbase.util.CommonFSUtils;</span>
<span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.hbase.util.Pair;</span>
<span class="source-line-no">035</span><span id="line-35">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">036</span><span id="line-36">import org.slf4j.Logger;</span>
<span class="source-line-no">037</span><span id="line-37">import org.slf4j.LoggerFactory;</span>
<span class="source-line-no">038</span><span id="line-38"></span>
<span class="source-line-no">039</span><span id="line-39">import org.apache.hbase.thirdparty.com.google.common.cache.CacheBuilder;</span>
<span class="source-line-no">040</span><span id="line-40">import org.apache.hbase.thirdparty.com.google.common.cache.CacheLoader;</span>
<span class="source-line-no">041</span><span id="line-41">import org.apache.hbase.thirdparty.com.google.common.cache.LoadingCache;</span>
<span class="source-line-no">042</span><span id="line-42"></span>
<span class="source-line-no">043</span><span id="line-43">import org.apache.hadoop.hbase.shaded.protobuf.ProtobufUtil;</span>
<span class="source-line-no">044</span><span id="line-44">import org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription;</span>
<span class="source-line-no">045</span><span id="line-45">import org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotRegionManifest;</span>
<span class="source-line-no">046</span><span id="line-46">import org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotRegionManifest.StoreFile;</span>
<span class="source-line-no">047</span><span id="line-47"></span>
<span class="source-line-no">048</span><span id="line-48">/**</span>
<span class="source-line-no">049</span><span id="line-49"> * Used by {@link org.apache.hadoop.hbase.master.procedure.SnapshotVerifyProcedure} to verify if the</span>
<span class="source-line-no">050</span><span id="line-50"> * region info and store file info in RegionManifest are intact.</span>
<span class="source-line-no">051</span><span id="line-51"> */</span>
<span class="source-line-no">052</span><span id="line-52">@InterfaceAudience.Private</span>
<span class="source-line-no">053</span><span id="line-53">public class RSSnapshotVerifier {</span>
<span class="source-line-no">054</span><span id="line-54"> private static final Logger LOG = LoggerFactory.getLogger(RSSnapshotVerifier.class);</span>
<span class="source-line-no">055</span><span id="line-55"></span>
<span class="source-line-no">056</span><span id="line-56"> private final LoadingCache&lt;SnapshotDescription,</span>
<span class="source-line-no">057</span><span id="line-57"> Pair&lt;FileSystem, Map&lt;String, SnapshotRegionManifest&gt;&gt;&gt; SNAPSHOT_MANIFEST_CACHE;</span>
<span class="source-line-no">058</span><span id="line-58"> private final Configuration conf;</span>
<span class="source-line-no">059</span><span id="line-59"></span>
<span class="source-line-no">060</span><span id="line-60"> public RSSnapshotVerifier(Configuration conf) {</span>
<span class="source-line-no">061</span><span id="line-61"> this.conf = conf;</span>
<span class="source-line-no">062</span><span id="line-62"> long expiredTime = conf.getLong("hbase.snapshot-manifest.cache.expired.sec", 600);</span>
<span class="source-line-no">063</span><span id="line-63"> long maxSize = conf.getLong("hbase.snapshot-manifest.cache.max.size", 10);</span>
<span class="source-line-no">064</span><span id="line-64"> this.SNAPSHOT_MANIFEST_CACHE =</span>
<span class="source-line-no">065</span><span id="line-65"> CacheBuilder.newBuilder().expireAfterAccess(expiredTime, TimeUnit.SECONDS)</span>
<span class="source-line-no">066</span><span id="line-66"> .maximumSize(maxSize).build(new SnapshotManifestCacheLoader(conf));</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"> public void verifyRegion(SnapshotDescription snapshot, RegionInfo region) throws IOException {</span>
<span class="source-line-no">070</span><span id="line-70"> try {</span>
<span class="source-line-no">071</span><span id="line-71"> Pair&lt;FileSystem, Map&lt;String, SnapshotRegionManifest&gt;&gt; cache =</span>
<span class="source-line-no">072</span><span id="line-72"> SNAPSHOT_MANIFEST_CACHE.get(snapshot);</span>
<span class="source-line-no">073</span><span id="line-73"> Map&lt;String, SnapshotRegionManifest&gt; rmMap = cache.getSecond();</span>
<span class="source-line-no">074</span><span id="line-74"> if (rmMap == null) {</span>
<span class="source-line-no">075</span><span id="line-75"> throw new CorruptedSnapshotException(snapshot.getName() + "looks empty");</span>
<span class="source-line-no">076</span><span id="line-76"> }</span>
<span class="source-line-no">077</span><span id="line-77"> SnapshotRegionManifest regionManifest = rmMap.get(region.getEncodedName());</span>
<span class="source-line-no">078</span><span id="line-78"> if (regionManifest == null) {</span>
<span class="source-line-no">079</span><span id="line-79"> LOG.warn("No snapshot region directory found for {}", region.getRegionNameAsString());</span>
<span class="source-line-no">080</span><span id="line-80"> return;</span>
<span class="source-line-no">081</span><span id="line-81"> }</span>
<span class="source-line-no">082</span><span id="line-82"> // verify region info</span>
<span class="source-line-no">083</span><span id="line-83"> RegionInfo manifestRegionInfo = ProtobufUtil.toRegionInfo(regionManifest.getRegionInfo());</span>
<span class="source-line-no">084</span><span id="line-84"> if (RegionInfo.COMPARATOR.compare(region, manifestRegionInfo) != 0) {</span>
<span class="source-line-no">085</span><span id="line-85"> String msg =</span>
<span class="source-line-no">086</span><span id="line-86"> "Manifest region info " + manifestRegionInfo + "doesn't match expected region:" + region;</span>
<span class="source-line-no">087</span><span id="line-87"> throw new CorruptedSnapshotException(msg, ProtobufUtil.createSnapshotDesc(snapshot));</span>
<span class="source-line-no">088</span><span id="line-88"> }</span>
<span class="source-line-no">089</span><span id="line-89"> // verify store file</span>
<span class="source-line-no">090</span><span id="line-90"> SnapshotReferenceUtil.visitRegionStoreFiles(regionManifest, new StoreFileVisitor() {</span>
<span class="source-line-no">091</span><span id="line-91"> @Override</span>
<span class="source-line-no">092</span><span id="line-92"> public void storeFile(RegionInfo region, String familyName, StoreFile storeFile)</span>
<span class="source-line-no">093</span><span id="line-93"> throws IOException {</span>
<span class="source-line-no">094</span><span id="line-94"> SnapshotReferenceUtil.verifyStoreFile(conf, cache.getFirst(), /* snapshotDir= */ null, // snapshotDir</span>
<span class="source-line-no">095</span><span id="line-95"> // is</span>
<span class="source-line-no">096</span><span id="line-96"> // never</span>
<span class="source-line-no">097</span><span id="line-97"> // used,</span>
<span class="source-line-no">098</span><span id="line-98"> // so</span>
<span class="source-line-no">099</span><span id="line-99"> // it's</span>
<span class="source-line-no">100</span><span id="line-100"> // ok</span>
<span class="source-line-no">101</span><span id="line-101"> // to</span>
<span class="source-line-no">102</span><span id="line-102"> // pass</span>
<span class="source-line-no">103</span><span id="line-103"> // null</span>
<span class="source-line-no">104</span><span id="line-104"> // here.</span>
<span class="source-line-no">105</span><span id="line-105"> // maybe</span>
<span class="source-line-no">106</span><span id="line-106"> // we</span>
<span class="source-line-no">107</span><span id="line-107"> // can</span>
<span class="source-line-no">108</span><span id="line-108"> // remove</span>
<span class="source-line-no">109</span><span id="line-109"> // this</span>
<span class="source-line-no">110</span><span id="line-110"> // parameter</span>
<span class="source-line-no">111</span><span id="line-111"> // later.</span>
<span class="source-line-no">112</span><span id="line-112"> snapshot, region, familyName, storeFile);</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"> } catch (ExecutionException e) {</span>
<span class="source-line-no">116</span><span id="line-116"> if (e.getCause() instanceof CorruptedSnapshotException) {</span>
<span class="source-line-no">117</span><span id="line-117"> throw new CorruptedSnapshotException(e.getCause().getMessage(),</span>
<span class="source-line-no">118</span><span id="line-118"> ProtobufUtil.createSnapshotDesc(snapshot));</span>
<span class="source-line-no">119</span><span id="line-119"> } else {</span>
<span class="source-line-no">120</span><span id="line-120"> LOG.error("Failed loading snapshot manifest for {} from filesystem", snapshot.getName(),</span>
<span class="source-line-no">121</span><span id="line-121"> e.getCause());</span>
<span class="source-line-no">122</span><span id="line-122"> throw new IOException(e.getCause());</span>
<span class="source-line-no">123</span><span id="line-123"> }</span>
<span class="source-line-no">124</span><span id="line-124"> }</span>
<span class="source-line-no">125</span><span id="line-125"> }</span>
<span class="source-line-no">126</span><span id="line-126"></span>
<span class="source-line-no">127</span><span id="line-127"> // to avoid loading snapshot manifest from filesystem for each region, try to cache it here</span>
<span class="source-line-no">128</span><span id="line-128"> private static final class SnapshotManifestCacheLoader extends</span>
<span class="source-line-no">129</span><span id="line-129"> CacheLoader&lt;SnapshotDescription, Pair&lt;FileSystem, Map&lt;String, SnapshotRegionManifest&gt;&gt;&gt; {</span>
<span class="source-line-no">130</span><span id="line-130"> private final Configuration conf;</span>
<span class="source-line-no">131</span><span id="line-131"></span>
<span class="source-line-no">132</span><span id="line-132"> private SnapshotManifestCacheLoader(Configuration conf) {</span>
<span class="source-line-no">133</span><span id="line-133"> this.conf = conf;</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"> @Override</span>
<span class="source-line-no">137</span><span id="line-137"> public Pair&lt;FileSystem, Map&lt;String, SnapshotRegionManifest&gt;&gt; load(SnapshotDescription snapshot)</span>
<span class="source-line-no">138</span><span id="line-138"> throws Exception {</span>
<span class="source-line-no">139</span><span id="line-139"> Path rootDir = CommonFSUtils.getRootDir(conf);</span>
<span class="source-line-no">140</span><span id="line-140"> Path workingDir = SnapshotDescriptionUtils.getWorkingSnapshotDir(snapshot, rootDir, conf);</span>
<span class="source-line-no">141</span><span id="line-141"> FileSystem rootFs = CommonFSUtils.getRootDirFileSystem(conf);</span>
<span class="source-line-no">142</span><span id="line-142"> FileSystem workingDirFS = workingDir.getFileSystem(conf);</span>
<span class="source-line-no">143</span><span id="line-143"> SnapshotManifest manifest = SnapshotManifest.open(conf, workingDirFS, workingDir, snapshot);</span>
<span class="source-line-no">144</span><span id="line-144"> LOG.debug("loading snapshot manifest for {} from {}", snapshot.getName(), workingDir);</span>
<span class="source-line-no">145</span><span id="line-145"> return Pair.newPair(rootFs, manifest.getRegionManifestsMap());</span>
<span class="source-line-no">146</span><span id="line-146"> }</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>