| <!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.procedure2, class: CompletedProcedureCleaner"> |
| <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.procedure2;</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.io.UncheckedIOException;</span> |
| <span class="source-line-no">022</span><span id="line-22">import java.util.Iterator;</span> |
| <span class="source-line-no">023</span><span id="line-23">import java.util.Map;</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.hbase.procedure2.store.ProcedureStore;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.util.EnvironmentEdgeManager;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.util.IdLock;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.util.NonceKey;</span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">030</span><span id="line-30">import org.slf4j.Logger;</span> |
| <span class="source-line-no">031</span><span id="line-31">import org.slf4j.LoggerFactory;</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"> * Internal cleaner that removes the completed procedure results after a TTL.</span> |
| <span class="source-line-no">035</span><span id="line-35"> * <p/></span> |
| <span class="source-line-no">036</span><span id="line-36"> * NOTE: This is a special case handled in timeoutLoop().</span> |
| <span class="source-line-no">037</span><span id="line-37"> * <p/></span> |
| <span class="source-line-no">038</span><span id="line-38"> * Since the client code looks more or less like:</span> |
| <span class="source-line-no">039</span><span id="line-39"> *</span> |
| <span class="source-line-no">040</span><span id="line-40"> * <pre></span> |
| <span class="source-line-no">041</span><span id="line-41"> * procId = master.doOperation()</span> |
| <span class="source-line-no">042</span><span id="line-42"> * while (master.getProcResult(procId) == ProcInProgress);</span> |
| <span class="source-line-no">043</span><span id="line-43"> * </pre></span> |
| <span class="source-line-no">044</span><span id="line-44"> *</span> |
| <span class="source-line-no">045</span><span id="line-45"> * The master should not throw away the proc result as soon as the procedure is done but should wait</span> |
| <span class="source-line-no">046</span><span id="line-46"> * a result request from the client (see executor.removeResult(procId)) The client will call</span> |
| <span class="source-line-no">047</span><span id="line-47"> * something like master.isProcDone() or master.getProcResult() which will return the result/state</span> |
| <span class="source-line-no">048</span><span id="line-48"> * to the client, and it will mark the completed proc as ready to delete. note that the client may</span> |
| <span class="source-line-no">049</span><span id="line-49"> * not receive the response from the master (e.g. master failover) so, if we delay a bit the real</span> |
| <span class="source-line-no">050</span><span id="line-50"> * deletion of the proc result the client will be able to get the result the next try.</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">class CompletedProcedureCleaner<TEnvironment> extends ProcedureInMemoryChore<TEnvironment> {</span> |
| <span class="source-line-no">054</span><span id="line-54"> private static final Logger LOG = LoggerFactory.getLogger(CompletedProcedureCleaner.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"> static final String CLEANER_INTERVAL_CONF_KEY = "hbase.procedure.cleaner.interval";</span> |
| <span class="source-line-no">057</span><span id="line-57"> private static final int DEFAULT_CLEANER_INTERVAL = 30 * 1000; // 30sec</span> |
| <span class="source-line-no">058</span><span id="line-58"></span> |
| <span class="source-line-no">059</span><span id="line-59"> private static final String BATCH_SIZE_CONF_KEY = "hbase.procedure.cleaner.evict.batch.size";</span> |
| <span class="source-line-no">060</span><span id="line-60"> private static final int DEFAULT_BATCH_SIZE = 32;</span> |
| <span class="source-line-no">061</span><span id="line-61"></span> |
| <span class="source-line-no">062</span><span id="line-62"> private final Map<Long, CompletedProcedureRetainer<TEnvironment>> completed;</span> |
| <span class="source-line-no">063</span><span id="line-63"> private final Map<NonceKey, Long> nonceKeysToProcIdsMap;</span> |
| <span class="source-line-no">064</span><span id="line-64"> private final ProcedureStore store;</span> |
| <span class="source-line-no">065</span><span id="line-65"> private final IdLock procExecutionLock;</span> |
| <span class="source-line-no">066</span><span id="line-66"> private Configuration 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"> public CompletedProcedureCleaner(Configuration conf, ProcedureStore store,</span> |
| <span class="source-line-no">069</span><span id="line-69"> IdLock procExecutionLock, Map<Long, CompletedProcedureRetainer<TEnvironment>> completedMap,</span> |
| <span class="source-line-no">070</span><span id="line-70"> Map<NonceKey, Long> nonceKeysToProcIdsMap) {</span> |
| <span class="source-line-no">071</span><span id="line-71"> // set the timeout interval that triggers the periodic-procedure</span> |
| <span class="source-line-no">072</span><span id="line-72"> super(conf.getInt(CLEANER_INTERVAL_CONF_KEY, DEFAULT_CLEANER_INTERVAL));</span> |
| <span class="source-line-no">073</span><span id="line-73"> this.completed = completedMap;</span> |
| <span class="source-line-no">074</span><span id="line-74"> this.nonceKeysToProcIdsMap = nonceKeysToProcIdsMap;</span> |
| <span class="source-line-no">075</span><span id="line-75"> this.store = store;</span> |
| <span class="source-line-no">076</span><span id="line-76"> this.procExecutionLock = procExecutionLock;</span> |
| <span class="source-line-no">077</span><span id="line-77"> this.conf = conf;</span> |
| <span class="source-line-no">078</span><span id="line-78"> }</span> |
| <span class="source-line-no">079</span><span id="line-79"></span> |
| <span class="source-line-no">080</span><span id="line-80"> @Override</span> |
| <span class="source-line-no">081</span><span id="line-81"> protected void periodicExecute(final TEnvironment env) {</span> |
| <span class="source-line-no">082</span><span id="line-82"> if (completed.isEmpty()) {</span> |
| <span class="source-line-no">083</span><span id="line-83"> if (LOG.isTraceEnabled()) {</span> |
| <span class="source-line-no">084</span><span id="line-84"> LOG.trace("No completed procedures to cleanup.");</span> |
| <span class="source-line-no">085</span><span id="line-85"> }</span> |
| <span class="source-line-no">086</span><span id="line-86"> return;</span> |
| <span class="source-line-no">087</span><span id="line-87"> }</span> |
| <span class="source-line-no">088</span><span id="line-88"></span> |
| <span class="source-line-no">089</span><span id="line-89"> final long evictTtl =</span> |
| <span class="source-line-no">090</span><span id="line-90"> conf.getInt(ProcedureExecutor.EVICT_TTL_CONF_KEY, ProcedureExecutor.DEFAULT_EVICT_TTL);</span> |
| <span class="source-line-no">091</span><span id="line-91"> final long evictAckTtl = conf.getInt(ProcedureExecutor.EVICT_ACKED_TTL_CONF_KEY,</span> |
| <span class="source-line-no">092</span><span id="line-92"> ProcedureExecutor.DEFAULT_ACKED_EVICT_TTL);</span> |
| <span class="source-line-no">093</span><span id="line-93"> final int batchSize = conf.getInt(BATCH_SIZE_CONF_KEY, DEFAULT_BATCH_SIZE);</span> |
| <span class="source-line-no">094</span><span id="line-94"></span> |
| <span class="source-line-no">095</span><span id="line-95"> final long[] batchIds = new long[batchSize];</span> |
| <span class="source-line-no">096</span><span id="line-96"> int batchCount = 0;</span> |
| <span class="source-line-no">097</span><span id="line-97"></span> |
| <span class="source-line-no">098</span><span id="line-98"> final long now = EnvironmentEdgeManager.currentTime();</span> |
| <span class="source-line-no">099</span><span id="line-99"> final Iterator<Map.Entry<Long, CompletedProcedureRetainer<TEnvironment>>> it =</span> |
| <span class="source-line-no">100</span><span id="line-100"> completed.entrySet().iterator();</span> |
| <span class="source-line-no">101</span><span id="line-101"> while (it.hasNext() && store.isRunning()) {</span> |
| <span class="source-line-no">102</span><span id="line-102"> final Map.Entry<Long, CompletedProcedureRetainer<TEnvironment>> entry = it.next();</span> |
| <span class="source-line-no">103</span><span id="line-103"> final CompletedProcedureRetainer<TEnvironment> retainer = entry.getValue();</span> |
| <span class="source-line-no">104</span><span id="line-104"> final Procedure<?> proc = retainer.getProcedure();</span> |
| <span class="source-line-no">105</span><span id="line-105"> IdLock.Entry lockEntry;</span> |
| <span class="source-line-no">106</span><span id="line-106"> try {</span> |
| <span class="source-line-no">107</span><span id="line-107"> lockEntry = procExecutionLock.getLockEntry(proc.getProcId());</span> |
| <span class="source-line-no">108</span><span id="line-108"> } catch (IOException e) {</span> |
| <span class="source-line-no">109</span><span id="line-109"> // can only happen if interrupted, so not a big deal to propagate it</span> |
| <span class="source-line-no">110</span><span id="line-110"> throw new UncheckedIOException(e);</span> |
| <span class="source-line-no">111</span><span id="line-111"> }</span> |
| <span class="source-line-no">112</span><span id="line-112"> try {</span> |
| <span class="source-line-no">113</span><span id="line-113"> // TODO: Select TTL based on Procedure type</span> |
| <span class="source-line-no">114</span><span id="line-114"> if (retainer.isExpired(now, evictTtl, evictAckTtl)) {</span> |
| <span class="source-line-no">115</span><span id="line-115"> // Failed procedures aren't persisted in WAL.</span> |
| <span class="source-line-no">116</span><span id="line-116"> if (!(proc instanceof FailedProcedure)) {</span> |
| <span class="source-line-no">117</span><span id="line-117"> batchIds[batchCount++] = entry.getKey();</span> |
| <span class="source-line-no">118</span><span id="line-118"> if (batchCount == batchIds.length) {</span> |
| <span class="source-line-no">119</span><span id="line-119"> store.delete(batchIds, 0, batchCount);</span> |
| <span class="source-line-no">120</span><span id="line-120"> batchCount = 0;</span> |
| <span class="source-line-no">121</span><span id="line-121"> }</span> |
| <span class="source-line-no">122</span><span id="line-122"> }</span> |
| <span class="source-line-no">123</span><span id="line-123"> final NonceKey nonceKey = proc.getNonceKey();</span> |
| <span class="source-line-no">124</span><span id="line-124"> if (nonceKey != null) {</span> |
| <span class="source-line-no">125</span><span id="line-125"> nonceKeysToProcIdsMap.remove(nonceKey);</span> |
| <span class="source-line-no">126</span><span id="line-126"> }</span> |
| <span class="source-line-no">127</span><span id="line-127"> it.remove();</span> |
| <span class="source-line-no">128</span><span id="line-128"> LOG.trace("Evict completed {}", proc);</span> |
| <span class="source-line-no">129</span><span id="line-129"> }</span> |
| <span class="source-line-no">130</span><span id="line-130"> } finally {</span> |
| <span class="source-line-no">131</span><span id="line-131"> procExecutionLock.releaseLockEntry(lockEntry);</span> |
| <span class="source-line-no">132</span><span id="line-132"> }</span> |
| <span class="source-line-no">133</span><span id="line-133"> }</span> |
| <span class="source-line-no">134</span><span id="line-134"> if (batchCount > 0) {</span> |
| <span class="source-line-no">135</span><span id="line-135"> store.delete(batchIds, 0, batchCount);</span> |
| <span class="source-line-no">136</span><span id="line-136"> }</span> |
| <span class="source-line-no">137</span><span id="line-137"> // let the store do some cleanup works, i.e, delete the place marker for preserving the max</span> |
| <span class="source-line-no">138</span><span id="line-138"> // procedure id.</span> |
| <span class="source-line-no">139</span><span id="line-139"> store.cleanup();</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> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
