| <!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.procedure, class: TableProcedureWaitingQueue"> |
| <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.procedure;</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.util.ArrayDeque;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.util.Optional;</span> |
| <span class="source-line-no">022</span><span id="line-22">import java.util.Queue;</span> |
| <span class="source-line-no">023</span><span id="line-23">import java.util.function.Function;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.procedure2.Procedure;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">026</span><span id="line-26"></span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.hbase.thirdparty.com.google.common.base.Preconditions;</span> |
| <span class="source-line-no">028</span><span id="line-28"></span> |
| <span class="source-line-no">029</span><span id="line-29">/**</span> |
| <span class="source-line-no">030</span><span id="line-30"> * To prevent multiple Create/Modify/Disable/Enable table procedures run at the same time, we will</span> |
| <span class="source-line-no">031</span><span id="line-31"> * keep table procedure in this queue first before actually enqueuing it to</span> |
| <span class="source-line-no">032</span><span id="line-32"> * MasterProcedureScheduler's tableQueue. See HBASE-28683 for more details</span> |
| <span class="source-line-no">033</span><span id="line-33"> */</span> |
| <span class="source-line-no">034</span><span id="line-34">@InterfaceAudience.Private</span> |
| <span class="source-line-no">035</span><span id="line-35">class TableProcedureWaitingQueue {</span> |
| <span class="source-line-no">036</span><span id="line-36"></span> |
| <span class="source-line-no">037</span><span id="line-37"> private final Function<Long, Procedure<?>> procedureRetriever;</span> |
| <span class="source-line-no">038</span><span id="line-38"></span> |
| <span class="source-line-no">039</span><span id="line-39"> // whether there is already a table procedure enqueued in ProcedureScheduler.</span> |
| <span class="source-line-no">040</span><span id="line-40"> private Procedure<?> enqueuedProc;</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 final Queue<Procedure<?>> queue = new ArrayDeque<>();</span> |
| <span class="source-line-no">043</span><span id="line-43"></span> |
| <span class="source-line-no">044</span><span id="line-44"> TableProcedureWaitingQueue(Function<Long, Procedure<?>> procedureRetriever) {</span> |
| <span class="source-line-no">045</span><span id="line-45"> this.procedureRetriever = procedureRetriever;</span> |
| <span class="source-line-no">046</span><span id="line-46"> }</span> |
| <span class="source-line-no">047</span><span id="line-47"></span> |
| <span class="source-line-no">048</span><span id="line-48"> private boolean isSubProcedure(Procedure<?> proc) {</span> |
| <span class="source-line-no">049</span><span id="line-49"> while (proc.hasParent()) {</span> |
| <span class="source-line-no">050</span><span id="line-50"> if (proc.getParentProcId() == enqueuedProc.getProcId()) {</span> |
| <span class="source-line-no">051</span><span id="line-51"> return true;</span> |
| <span class="source-line-no">052</span><span id="line-52"> }</span> |
| <span class="source-line-no">053</span><span id="line-53"> proc = Preconditions.checkNotNull(procedureRetriever.apply(proc.getParentProcId()),</span> |
| <span class="source-line-no">054</span><span id="line-54"> "can not find parent procedure pid=%s", proc.getParentProcId());</span> |
| <span class="source-line-no">055</span><span id="line-55"> }</span> |
| <span class="source-line-no">056</span><span id="line-56"> return false;</span> |
| <span class="source-line-no">057</span><span id="line-57"> }</span> |
| <span class="source-line-no">058</span><span id="line-58"></span> |
| <span class="source-line-no">059</span><span id="line-59"> /**</span> |
| <span class="source-line-no">060</span><span id="line-60"> * Return whether we can enqueue this procedure to ProcedureScheduler.</span> |
| <span class="source-line-no">061</span><span id="line-61"> * <p></span> |
| <span class="source-line-no">062</span><span id="line-62"> * If returns {@code true}, you should enqueue this procedure, otherwise you just need to do</span> |
| <span class="source-line-no">063</span><span id="line-63"> * nothing, as we will queue it in the waitingQueue, and you will finally get it again by calling</span> |
| <span class="source-line-no">064</span><span id="line-64"> * {@link #procedureCompleted(Procedure)} method in the future.</span> |
| <span class="source-line-no">065</span><span id="line-65"> */</span> |
| <span class="source-line-no">066</span><span id="line-66"> boolean procedureSubmitted(Procedure<?> proc) {</span> |
| <span class="source-line-no">067</span><span id="line-67"> if (enqueuedProc == null) {</span> |
| <span class="source-line-no">068</span><span id="line-68"> // no procedure enqueued yet, record it and return</span> |
| <span class="source-line-no">069</span><span id="line-69"> enqueuedProc = proc;</span> |
| <span class="source-line-no">070</span><span id="line-70"> return true;</span> |
| <span class="source-line-no">071</span><span id="line-71"> }</span> |
| <span class="source-line-no">072</span><span id="line-72"> if (proc == enqueuedProc) {</span> |
| <span class="source-line-no">073</span><span id="line-73"> // the same procedure is enqueued again, this usually because the procedure comes back from</span> |
| <span class="source-line-no">074</span><span id="line-74"> // WAITING state, such as all child procedures are finished</span> |
| <span class="source-line-no">075</span><span id="line-75"> return true;</span> |
| <span class="source-line-no">076</span><span id="line-76"> }</span> |
| <span class="source-line-no">077</span><span id="line-77"> // check whether this is a sub procedure of the enqueued procedure</span> |
| <span class="source-line-no">078</span><span id="line-78"> if (isSubProcedure(proc)) {</span> |
| <span class="source-line-no">079</span><span id="line-79"> return true;</span> |
| <span class="source-line-no">080</span><span id="line-80"> }</span> |
| <span class="source-line-no">081</span><span id="line-81"> queue.add(proc);</span> |
| <span class="source-line-no">082</span><span id="line-82"> return false;</span> |
| <span class="source-line-no">083</span><span id="line-83"> }</span> |
| <span class="source-line-no">084</span><span id="line-84"></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 the next procedure which can be enqueued to ProcedureScheduler.</span> |
| <span class="source-line-no">087</span><span id="line-87"> */</span> |
| <span class="source-line-no">088</span><span id="line-88"> Optional<Procedure<?>> procedureCompleted(Procedure<?> proc) {</span> |
| <span class="source-line-no">089</span><span id="line-89"> Preconditions.checkState(enqueuedProc != null, "enqueued procedure should not be null");</span> |
| <span class="source-line-no">090</span><span id="line-90"> if (enqueuedProc == proc) {</span> |
| <span class="source-line-no">091</span><span id="line-91"> if (!queue.isEmpty()) {</span> |
| <span class="source-line-no">092</span><span id="line-92"> enqueuedProc = queue.poll();</span> |
| <span class="source-line-no">093</span><span id="line-93"> return Optional.of(enqueuedProc);</span> |
| <span class="source-line-no">094</span><span id="line-94"> } else {</span> |
| <span class="source-line-no">095</span><span id="line-95"> enqueuedProc = null;</span> |
| <span class="source-line-no">096</span><span id="line-96"> return Optional.empty();</span> |
| <span class="source-line-no">097</span><span id="line-97"> }</span> |
| <span class="source-line-no">098</span><span id="line-98"> } else {</span> |
| <span class="source-line-no">099</span><span id="line-99"> Preconditions.checkState(isSubProcedure(proc),</span> |
| <span class="source-line-no">100</span><span id="line-100"> "procedure %s is not a sub procedure of enqueued procedure %s", proc, enqueuedProc);</span> |
| <span class="source-line-no">101</span><span id="line-101"> return Optional.empty();</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"></span> |
| <span class="source-line-no">105</span><span id="line-105"> boolean isEmpty() {</span> |
| <span class="source-line-no">106</span><span id="line-106"> return enqueuedProc == null;</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"> int waitingSize() {</span> |
| <span class="source-line-no">110</span><span id="line-110"> return queue.size();</span> |
| <span class="source-line-no">111</span><span id="line-111"> }</span> |
| <span class="source-line-no">112</span><span id="line-112"></span> |
| <span class="source-line-no">113</span><span id="line-113"> @Override</span> |
| <span class="source-line-no">114</span><span id="line-114"> public String toString() {</span> |
| <span class="source-line-no">115</span><span id="line-115"> return "TableProcedureWaitingQueue [enqueuedProc=" + enqueuedProc + ", queue=" + queue + "]";</span> |
| <span class="source-line-no">116</span><span id="line-116"> }</span> |
| <span class="source-line-no">117</span><span id="line-117">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
