blob: c51d150961369f3d0f102f2dc694c264e1fc8f50 [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.master, class: SplitWALManager">
<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.master;</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.HConstants.DEFAULT_HBASE_SPLIT_WAL_MAX_SPLITTER;</span>
<span class="source-line-no">021</span><span id="line-21">import static org.apache.hadoop.hbase.HConstants.HBASE_SPLIT_WAL_MAX_SPLITTER;</span>
<span class="source-line-no">022</span><span id="line-22">import static org.apache.hadoop.hbase.master.MasterWalManager.META_FILTER;</span>
<span class="source-line-no">023</span><span id="line-23">import static org.apache.hadoop.hbase.master.MasterWalManager.NON_META_FILTER;</span>
<span class="source-line-no">024</span><span id="line-24"></span>
<span class="source-line-no">025</span><span id="line-25">import java.io.IOException;</span>
<span class="source-line-no">026</span><span id="line-26">import java.util.Arrays;</span>
<span class="source-line-no">027</span><span id="line-27">import java.util.Collections;</span>
<span class="source-line-no">028</span><span id="line-28">import java.util.List;</span>
<span class="source-line-no">029</span><span id="line-29">import java.util.Optional;</span>
<span class="source-line-no">030</span><span id="line-30">import java.util.stream.Collectors;</span>
<span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.conf.Configuration;</span>
<span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.fs.FileStatus;</span>
<span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.fs.FileSystem;</span>
<span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.fs.Path;</span>
<span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.fs.PathIsNotEmptyDirectoryException;</span>
<span class="source-line-no">036</span><span id="line-36">import org.apache.hadoop.hbase.HConstants;</span>
<span class="source-line-no">037</span><span id="line-37">import org.apache.hadoop.hbase.ServerName;</span>
<span class="source-line-no">038</span><span id="line-38">import org.apache.hadoop.hbase.master.procedure.MasterProcedureScheduler;</span>
<span class="source-line-no">039</span><span id="line-39">import org.apache.hadoop.hbase.master.procedure.SplitWALProcedure;</span>
<span class="source-line-no">040</span><span id="line-40">import org.apache.hadoop.hbase.procedure2.Procedure;</span>
<span class="source-line-no">041</span><span id="line-41">import org.apache.hadoop.hbase.procedure2.ProcedureEvent;</span>
<span class="source-line-no">042</span><span id="line-42">import org.apache.hadoop.hbase.procedure2.ProcedureSuspendedException;</span>
<span class="source-line-no">043</span><span id="line-43">import org.apache.hadoop.hbase.util.CommonFSUtils;</span>
<span class="source-line-no">044</span><span id="line-44">import org.apache.hadoop.hbase.wal.AbstractFSWALProvider;</span>
<span class="source-line-no">045</span><span id="line-45">import org.apache.hadoop.hbase.wal.WALSplitUtil;</span>
<span class="source-line-no">046</span><span id="line-46">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">047</span><span id="line-47">import org.slf4j.Logger;</span>
<span class="source-line-no">048</span><span id="line-48">import org.slf4j.LoggerFactory;</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"> * Create {@link SplitWALProcedure} for each WAL which need to split. Manage the workers for each</span>
<span class="source-line-no">052</span><span id="line-52"> * {@link SplitWALProcedure}. Total number of workers is (number of online servers) *</span>
<span class="source-line-no">053</span><span id="line-53"> * (HBASE_SPLIT_WAL_MAX_SPLITTER). Helps assign and release workers for split tasks. Provide helper</span>
<span class="source-line-no">054</span><span id="line-54"> * method to delete split WAL file and directory. The user can get the SplitWALProcedures via</span>
<span class="source-line-no">055</span><span id="line-55"> * splitWALs(crashedServer, splitMeta) can get the files that need to split via</span>
<span class="source-line-no">056</span><span id="line-56"> * getWALsToSplit(crashedServer, splitMeta) can delete the splitting WAL and directory via</span>
<span class="source-line-no">057</span><span id="line-57"> * deleteSplitWAL(wal) and deleteSplitWAL(crashedServer) can check if splitting WALs of a crashed</span>
<span class="source-line-no">058</span><span id="line-58"> * server is success via isSplitWALFinished(walPath) can acquire and release a worker for splitting</span>
<span class="source-line-no">059</span><span id="line-59"> * WAL via acquireSplitWALWorker(procedure) and releaseSplitWALWorker(worker, scheduler) This class</span>
<span class="source-line-no">060</span><span id="line-60"> * is to replace the zk-based WAL splitting related code, {@link MasterWalManager},</span>
<span class="source-line-no">061</span><span id="line-61"> * {@link SplitLogManager}, {@link org.apache.hadoop.hbase.zookeeper.ZKSplitLog} and</span>
<span class="source-line-no">062</span><span id="line-62"> * {@link org.apache.hadoop.hbase.coordination.ZKSplitLogManagerCoordination} can be removed after</span>
<span class="source-line-no">063</span><span id="line-63"> * we switch to procedure-based WAL splitting.</span>
<span class="source-line-no">064</span><span id="line-64"> * @see SplitLogManager for the original distributed split WAL manager.</span>
<span class="source-line-no">065</span><span id="line-65"> */</span>
<span class="source-line-no">066</span><span id="line-66">@InterfaceAudience.Private</span>
<span class="source-line-no">067</span><span id="line-67">public class SplitWALManager {</span>
<span class="source-line-no">068</span><span id="line-68"> private static final Logger LOG = LoggerFactory.getLogger(SplitWALManager.class);</span>
<span class="source-line-no">069</span><span id="line-69"></span>
<span class="source-line-no">070</span><span id="line-70"> private final MasterServices master;</span>
<span class="source-line-no">071</span><span id="line-71"> private final WorkerAssigner splitWorkerAssigner;</span>
<span class="source-line-no">072</span><span id="line-72"> private final Path rootDir;</span>
<span class="source-line-no">073</span><span id="line-73"> private final FileSystem fs;</span>
<span class="source-line-no">074</span><span id="line-74"> private final Configuration conf;</span>
<span class="source-line-no">075</span><span id="line-75"> private final Path walArchiveDir;</span>
<span class="source-line-no">076</span><span id="line-76"></span>
<span class="source-line-no">077</span><span id="line-77"> public SplitWALManager(MasterServices master) throws IOException {</span>
<span class="source-line-no">078</span><span id="line-78"> this.master = master;</span>
<span class="source-line-no">079</span><span id="line-79"> this.conf = master.getConfiguration();</span>
<span class="source-line-no">080</span><span id="line-80"> this.splitWorkerAssigner = new WorkerAssigner(this.master,</span>
<span class="source-line-no">081</span><span id="line-81"> conf.getInt(HBASE_SPLIT_WAL_MAX_SPLITTER, DEFAULT_HBASE_SPLIT_WAL_MAX_SPLITTER),</span>
<span class="source-line-no">082</span><span id="line-82"> new ProcedureEvent&lt;&gt;("split-WAL-worker-assigning"));</span>
<span class="source-line-no">083</span><span id="line-83"> this.rootDir = master.getMasterFileSystem().getWALRootDir();</span>
<span class="source-line-no">084</span><span id="line-84"> this.fs = master.getMasterFileSystem().getWALFileSystem();</span>
<span class="source-line-no">085</span><span id="line-85"> this.walArchiveDir = new Path(this.rootDir, HConstants.HREGION_OLDLOGDIR_NAME);</span>
<span class="source-line-no">086</span><span id="line-86"> }</span>
<span class="source-line-no">087</span><span id="line-87"></span>
<span class="source-line-no">088</span><span id="line-88"> public List&lt;Procedure&gt; splitWALs(ServerName crashedServer, boolean splitMeta) throws IOException {</span>
<span class="source-line-no">089</span><span id="line-89"> try {</span>
<span class="source-line-no">090</span><span id="line-90"> // 1. list all splitting files</span>
<span class="source-line-no">091</span><span id="line-91"> List&lt;FileStatus&gt; splittingFiles = getWALsToSplit(crashedServer, splitMeta);</span>
<span class="source-line-no">092</span><span id="line-92"> // 2. create corresponding procedures</span>
<span class="source-line-no">093</span><span id="line-93"> return createSplitWALProcedures(splittingFiles, crashedServer);</span>
<span class="source-line-no">094</span><span id="line-94"> } catch (IOException e) {</span>
<span class="source-line-no">095</span><span id="line-95"> LOG.error("Failed to create procedures for splitting WALs of {}", crashedServer, e);</span>
<span class="source-line-no">096</span><span id="line-96"> throw e;</span>
<span class="source-line-no">097</span><span id="line-97"> }</span>
<span class="source-line-no">098</span><span id="line-98"> }</span>
<span class="source-line-no">099</span><span id="line-99"></span>
<span class="source-line-no">100</span><span id="line-100"> public List&lt;FileStatus&gt; getWALsToSplit(ServerName serverName, boolean splitMeta)</span>
<span class="source-line-no">101</span><span id="line-101"> throws IOException {</span>
<span class="source-line-no">102</span><span id="line-102"> List&lt;Path&gt; logDirs = master.getMasterWalManager().getLogDirs(Collections.singleton(serverName));</span>
<span class="source-line-no">103</span><span id="line-103"> List&lt;FileStatus&gt; fileStatuses =</span>
<span class="source-line-no">104</span><span id="line-104"> SplitLogManager.getFileList(this.conf, logDirs, splitMeta ? META_FILTER : NON_META_FILTER);</span>
<span class="source-line-no">105</span><span id="line-105"> LOG.info("{} WAL count={}, meta={}", serverName, fileStatuses.size(), splitMeta);</span>
<span class="source-line-no">106</span><span id="line-106"> return fileStatuses;</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"> private Path getWALSplitDir(ServerName serverName) {</span>
<span class="source-line-no">110</span><span id="line-110"> Path logDir =</span>
<span class="source-line-no">111</span><span id="line-111"> new Path(this.rootDir, AbstractFSWALProvider.getWALDirectoryName(serverName.toString()));</span>
<span class="source-line-no">112</span><span id="line-112"> return logDir.suffix(AbstractFSWALProvider.SPLITTING_EXT);</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"> /**</span>
<span class="source-line-no">116</span><span id="line-116"> * Archive processed WAL</span>
<span class="source-line-no">117</span><span id="line-117"> */</span>
<span class="source-line-no">118</span><span id="line-118"> public void archive(String wal) throws IOException {</span>
<span class="source-line-no">119</span><span id="line-119"> WALSplitUtil.moveWAL(this.fs, new Path(wal), this.walArchiveDir);</span>
<span class="source-line-no">120</span><span id="line-120"> }</span>
<span class="source-line-no">121</span><span id="line-121"></span>
<span class="source-line-no">122</span><span id="line-122"> public void deleteWALDir(ServerName serverName) throws IOException {</span>
<span class="source-line-no">123</span><span id="line-123"> Path splitDir = getWALSplitDir(serverName);</span>
<span class="source-line-no">124</span><span id="line-124"> try {</span>
<span class="source-line-no">125</span><span id="line-125"> if (!fs.delete(splitDir, false)) {</span>
<span class="source-line-no">126</span><span id="line-126"> LOG.warn("Failed delete {}, contains {}", splitDir, fs.listFiles(splitDir, true));</span>
<span class="source-line-no">127</span><span id="line-127"> }</span>
<span class="source-line-no">128</span><span id="line-128"> } catch (PathIsNotEmptyDirectoryException e) {</span>
<span class="source-line-no">129</span><span id="line-129"> FileStatus[] files = CommonFSUtils.listStatus(fs, splitDir);</span>
<span class="source-line-no">130</span><span id="line-130"> LOG.warn("PathIsNotEmptyDirectoryException {}",</span>
<span class="source-line-no">131</span><span id="line-131"> Arrays.stream(files).map(f -&gt; f.getPath()).collect(Collectors.toList()));</span>
<span class="source-line-no">132</span><span id="line-132"> throw e;</span>
<span class="source-line-no">133</span><span id="line-133"> }</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"> public boolean isSplitWALFinished(String walPath) throws IOException {</span>
<span class="source-line-no">137</span><span id="line-137"> return !fs.exists(new Path(rootDir, walPath));</span>
<span class="source-line-no">138</span><span id="line-138"> }</span>
<span class="source-line-no">139</span><span id="line-139"></span>
<span class="source-line-no">140</span><span id="line-140"> List&lt;Procedure&gt; createSplitWALProcedures(List&lt;FileStatus&gt; splittingWALs,</span>
<span class="source-line-no">141</span><span id="line-141"> ServerName crashedServer) {</span>
<span class="source-line-no">142</span><span id="line-142"> return splittingWALs.stream()</span>
<span class="source-line-no">143</span><span id="line-143"> .map(wal -&gt; new SplitWALProcedure(wal.getPath().toString(), crashedServer))</span>
<span class="source-line-no">144</span><span id="line-144"> .collect(Collectors.toList());</span>
<span class="source-line-no">145</span><span id="line-145"> }</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"> * Acquire a split WAL worker</span>
<span class="source-line-no">149</span><span id="line-149"> * @param procedure split WAL task</span>
<span class="source-line-no">150</span><span id="line-150"> * @return an available region server which could execute this task</span>
<span class="source-line-no">151</span><span id="line-151"> * @throws ProcedureSuspendedException if there is no available worker, it will throw this</span>
<span class="source-line-no">152</span><span id="line-152"> * exception to WAIT the procedure.</span>
<span class="source-line-no">153</span><span id="line-153"> */</span>
<span class="source-line-no">154</span><span id="line-154"> public ServerName acquireSplitWALWorker(Procedure&lt;?&gt; procedure)</span>
<span class="source-line-no">155</span><span id="line-155"> throws ProcedureSuspendedException {</span>
<span class="source-line-no">156</span><span id="line-156"> Optional&lt;ServerName&gt; worker = splitWorkerAssigner.acquire();</span>
<span class="source-line-no">157</span><span id="line-157"> if (worker.isPresent()) {</span>
<span class="source-line-no">158</span><span id="line-158"> LOG.debug("Acquired split WAL worker={}", worker.get());</span>
<span class="source-line-no">159</span><span id="line-159"> return worker.get();</span>
<span class="source-line-no">160</span><span id="line-160"> }</span>
<span class="source-line-no">161</span><span id="line-161"> splitWorkerAssigner.suspend(procedure);</span>
<span class="source-line-no">162</span><span id="line-162"> throw new ProcedureSuspendedException();</span>
<span class="source-line-no">163</span><span id="line-163"> }</span>
<span class="source-line-no">164</span><span id="line-164"></span>
<span class="source-line-no">165</span><span id="line-165"> /**</span>
<span class="source-line-no">166</span><span id="line-166"> * After the worker finished the split WAL task, it will release the worker, and wake up all the</span>
<span class="source-line-no">167</span><span id="line-167"> * suspend procedures in the ProcedureEvent</span>
<span class="source-line-no">168</span><span id="line-168"> * @param worker worker which is about to release</span>
<span class="source-line-no">169</span><span id="line-169"> * @param scheduler scheduler which is to wake up the procedure event</span>
<span class="source-line-no">170</span><span id="line-170"> */</span>
<span class="source-line-no">171</span><span id="line-171"> public void releaseSplitWALWorker(ServerName worker, MasterProcedureScheduler scheduler) {</span>
<span class="source-line-no">172</span><span id="line-172"> LOG.debug("Release split WAL worker={}", worker);</span>
<span class="source-line-no">173</span><span id="line-173"> splitWorkerAssigner.release(worker);</span>
<span class="source-line-no">174</span><span id="line-174"> splitWorkerAssigner.wake(scheduler);</span>
<span class="source-line-no">175</span><span id="line-175"> }</span>
<span class="source-line-no">176</span><span id="line-176"></span>
<span class="source-line-no">177</span><span id="line-177"> /**</span>
<span class="source-line-no">178</span><span id="line-178"> * When master restart, there will be a new splitWorkerAssigner. But if there are splitting WAL</span>
<span class="source-line-no">179</span><span id="line-179"> * tasks running on the region server side, they will not be count by the new splitWorkerAssigner.</span>
<span class="source-line-no">180</span><span id="line-180"> * Thus we should add the workers of running tasks to the assigner when we load the procedures</span>
<span class="source-line-no">181</span><span id="line-181"> * from MasterProcWALs.</span>
<span class="source-line-no">182</span><span id="line-182"> * @param worker region server which is executing a split WAL task</span>
<span class="source-line-no">183</span><span id="line-183"> */</span>
<span class="source-line-no">184</span><span id="line-184"> public void addUsedSplitWALWorker(ServerName worker) {</span>
<span class="source-line-no">185</span><span id="line-185"> splitWorkerAssigner.addUsedWorker(worker);</span>
<span class="source-line-no">186</span><span id="line-186"> }</span>
<span class="source-line-no">187</span><span id="line-187">}</span>
</pre>
</div>
</main>
</body>
</html>