Google Git
Sign in
apache / hbase-site / 6d7a7b43843a31b2a56803feaa0fcdaac6adb39a / . / devapidocs / src-html / org / apache / hadoop / hbase / master / TableStateManager.html
blob: 6f02f1ee07c28062cd5a0f84438430ed8f6fa64d [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a>
<span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a>
<span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a>
<span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a>
<span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a>
<span class="sourceLineNo">017</span> */<a name="line.17"></a>
<span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.master;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import edu.umd.cs.findbugs.annotations.NonNull;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import edu.umd.cs.findbugs.annotations.Nullable;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.io.IOException;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.Set;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.concurrent.ConcurrentHashMap;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.concurrent.ConcurrentMap;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.concurrent.locks.ReadWriteLock;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.CatalogFamilyFormat;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.ClientMetaTableAccessor;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.MetaTableAccessor;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.TableName;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.TableNotFoundException;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.client.Result;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.client.TableState;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.exceptions.IllegalArgumentIOException;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.util.IdReadWriteLock;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.util.IdReadWriteLockWithObjectPool;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.slf4j.Logger;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import org.slf4j.LoggerFactory;<a name="line.39"></a>
<span class="sourceLineNo">040</span><a name="line.40"></a>
<span class="sourceLineNo">041</span>import org.apache.hbase.thirdparty.com.google.common.collect.Sets;<a name="line.41"></a>
<span class="sourceLineNo">042</span><a name="line.42"></a>
<span class="sourceLineNo">043</span>/**<a name="line.43"></a>
<span class="sourceLineNo">044</span> * This is a helper class used to manage table states. This class uses hbase:meta as its store for<a name="line.44"></a>
<span class="sourceLineNo">045</span> * table state so hbase:meta must be online before accessing its methods.<a name="line.45"></a>
<span class="sourceLineNo">046</span> */<a name="line.46"></a>
<span class="sourceLineNo">047</span>@InterfaceAudience.Private<a name="line.47"></a>
<span class="sourceLineNo">048</span>public class TableStateManager {<a name="line.48"></a>
<span class="sourceLineNo">049</span><a name="line.49"></a>
<span class="sourceLineNo">050</span> private static final Logger LOG = LoggerFactory.getLogger(TableStateManager.class);<a name="line.50"></a>
<span class="sourceLineNo">051</span><a name="line.51"></a>
<span class="sourceLineNo">052</span> private final IdReadWriteLock&lt;TableName&gt; tnLock = new IdReadWriteLockWithObjectPool&lt;&gt;();<a name="line.52"></a>
<span class="sourceLineNo">053</span> private final MasterServices master;<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span> private final ConcurrentMap&lt;TableName, TableState.State&gt; tableName2State =<a name="line.55"></a>
<span class="sourceLineNo">056</span> new ConcurrentHashMap&lt;&gt;();<a name="line.56"></a>
<span class="sourceLineNo">057</span><a name="line.57"></a>
<span class="sourceLineNo">058</span> TableStateManager(MasterServices master) {<a name="line.58"></a>
<span class="sourceLineNo">059</span> this.master = master;<a name="line.59"></a>
<span class="sourceLineNo">060</span> }<a name="line.60"></a>
<span class="sourceLineNo">061</span><a name="line.61"></a>
<span class="sourceLineNo">062</span> /**<a name="line.62"></a>
<span class="sourceLineNo">063</span> * Set table state to provided. Caller should lock table on write.<a name="line.63"></a>
<span class="sourceLineNo">064</span> * @param tableName table to change state for<a name="line.64"></a>
<span class="sourceLineNo">065</span> * @param newState new state<a name="line.65"></a>
<span class="sourceLineNo">066</span> */<a name="line.66"></a>
<span class="sourceLineNo">067</span> public void setTableState(TableName tableName, TableState.State newState) throws IOException {<a name="line.67"></a>
<span class="sourceLineNo">068</span> ReadWriteLock lock = tnLock.getLock(tableName);<a name="line.68"></a>
<span class="sourceLineNo">069</span> lock.writeLock().lock();<a name="line.69"></a>
<span class="sourceLineNo">070</span> try {<a name="line.70"></a>
<span class="sourceLineNo">071</span> updateMetaState(tableName, newState);<a name="line.71"></a>
<span class="sourceLineNo">072</span> } finally {<a name="line.72"></a>
<span class="sourceLineNo">073</span> lock.writeLock().unlock();<a name="line.73"></a>
<span class="sourceLineNo">074</span> }<a name="line.74"></a>
<span class="sourceLineNo">075</span> }<a name="line.75"></a>
<span class="sourceLineNo">076</span><a name="line.76"></a>
<span class="sourceLineNo">077</span> public boolean isTableState(TableName tableName, TableState.State... states) {<a name="line.77"></a>
<span class="sourceLineNo">078</span> try {<a name="line.78"></a>
<span class="sourceLineNo">079</span> TableState tableState = getTableState(tableName);<a name="line.79"></a>
<span class="sourceLineNo">080</span> return tableState.isInStates(states);<a name="line.80"></a>
<span class="sourceLineNo">081</span> } catch (IOException e) {<a name="line.81"></a>
<span class="sourceLineNo">082</span> LOG.error("Unable to get table " + tableName + " state", e);<a name="line.82"></a>
<span class="sourceLineNo">083</span> // XXX: is it safe to just return false here?<a name="line.83"></a>
<span class="sourceLineNo">084</span> return false;<a name="line.84"></a>
<span class="sourceLineNo">085</span> }<a name="line.85"></a>
<span class="sourceLineNo">086</span> }<a name="line.86"></a>
<span class="sourceLineNo">087</span><a name="line.87"></a>
<span class="sourceLineNo">088</span> public void setDeletedTable(TableName tableName) throws IOException {<a name="line.88"></a>
<span class="sourceLineNo">089</span> if (tableName.equals(TableName.META_TABLE_NAME)) {<a name="line.89"></a>
<span class="sourceLineNo">090</span> // Can't delete the hbase:meta table.<a name="line.90"></a>
<span class="sourceLineNo">091</span> return;<a name="line.91"></a>
<span class="sourceLineNo">092</span> }<a name="line.92"></a>
<span class="sourceLineNo">093</span> ReadWriteLock lock = tnLock.getLock(tableName);<a name="line.93"></a>
<span class="sourceLineNo">094</span> lock.writeLock().lock();<a name="line.94"></a>
<span class="sourceLineNo">095</span> try {<a name="line.95"></a>
<span class="sourceLineNo">096</span> MetaTableAccessor.deleteTableState(master.getConnection(), tableName);<a name="line.96"></a>
<span class="sourceLineNo">097</span> } finally {<a name="line.97"></a>
<span class="sourceLineNo">098</span> tableName2State.remove(tableName);<a name="line.98"></a>
<span class="sourceLineNo">099</span> lock.writeLock().unlock();<a name="line.99"></a>
<span class="sourceLineNo">100</span> }<a name="line.100"></a>
<span class="sourceLineNo">101</span> }<a name="line.101"></a>
<span class="sourceLineNo">102</span><a name="line.102"></a>
<span class="sourceLineNo">103</span> public boolean isTablePresent(TableName tableName) throws IOException {<a name="line.103"></a>
<span class="sourceLineNo">104</span> ReadWriteLock lock = tnLock.getLock(tableName);<a name="line.104"></a>
<span class="sourceLineNo">105</span> lock.readLock().lock();<a name="line.105"></a>
<span class="sourceLineNo">106</span> try {<a name="line.106"></a>
<span class="sourceLineNo">107</span> return readMetaState(tableName) != null;<a name="line.107"></a>
<span class="sourceLineNo">108</span> } finally {<a name="line.108"></a>
<span class="sourceLineNo">109</span> lock.readLock().unlock();<a name="line.109"></a>
<span class="sourceLineNo">110</span> }<a name="line.110"></a>
<span class="sourceLineNo">111</span> }<a name="line.111"></a>
<span class="sourceLineNo">112</span><a name="line.112"></a>
<span class="sourceLineNo">113</span> /**<a name="line.113"></a>
<span class="sourceLineNo">114</span> * Return all tables in given states.<a name="line.114"></a>
<span class="sourceLineNo">115</span> * @param states filter by states<a name="line.115"></a>
<span class="sourceLineNo">116</span> * @return tables in given states<a name="line.116"></a>
<span class="sourceLineNo">117</span> */<a name="line.117"></a>
<span class="sourceLineNo">118</span> Set&lt;TableName&gt; getTablesInStates(TableState.State... states) throws IOException {<a name="line.118"></a>
<span class="sourceLineNo">119</span> // Only be called in region normalizer, will not use cache.<a name="line.119"></a>
<span class="sourceLineNo">120</span> final Set&lt;TableName&gt; rv = Sets.newHashSet();<a name="line.120"></a>
<span class="sourceLineNo">121</span> MetaTableAccessor.fullScanTables(master.getConnection(), new ClientMetaTableAccessor.Visitor() {<a name="line.121"></a>
<span class="sourceLineNo">122</span> @Override<a name="line.122"></a>
<span class="sourceLineNo">123</span> public boolean visit(Result r) throws IOException {<a name="line.123"></a>
<span class="sourceLineNo">124</span> TableState tableState = CatalogFamilyFormat.getTableState(r);<a name="line.124"></a>
<span class="sourceLineNo">125</span> if (tableState != null &amp;&amp; tableState.inStates(states)) {<a name="line.125"></a>
<span class="sourceLineNo">126</span> rv.add(tableState.getTableName());<a name="line.126"></a>
<span class="sourceLineNo">127</span> }<a name="line.127"></a>
<span class="sourceLineNo">128</span> return true;<a name="line.128"></a>
<span class="sourceLineNo">129</span> }<a name="line.129"></a>
<span class="sourceLineNo">130</span> });<a name="line.130"></a>
<span class="sourceLineNo">131</span> return rv;<a name="line.131"></a>
<span class="sourceLineNo">132</span> }<a name="line.132"></a>
<span class="sourceLineNo">133</span><a name="line.133"></a>
<span class="sourceLineNo">134</span> @NonNull<a name="line.134"></a>
<span class="sourceLineNo">135</span> public TableState getTableState(TableName tableName) throws IOException {<a name="line.135"></a>
<span class="sourceLineNo">136</span> ReadWriteLock lock = tnLock.getLock(tableName);<a name="line.136"></a>
<span class="sourceLineNo">137</span> lock.readLock().lock();<a name="line.137"></a>
<span class="sourceLineNo">138</span> try {<a name="line.138"></a>
<span class="sourceLineNo">139</span> TableState currentState = readMetaState(tableName);<a name="line.139"></a>
<span class="sourceLineNo">140</span> if (currentState == null) {<a name="line.140"></a>
<span class="sourceLineNo">141</span> throw new TableNotFoundException("No state found for " + tableName);<a name="line.141"></a>
<span class="sourceLineNo">142</span> }<a name="line.142"></a>
<span class="sourceLineNo">143</span> return currentState;<a name="line.143"></a>
<span class="sourceLineNo">144</span> } finally {<a name="line.144"></a>
<span class="sourceLineNo">145</span> lock.readLock().unlock();<a name="line.145"></a>
<span class="sourceLineNo">146</span> }<a name="line.146"></a>
<span class="sourceLineNo">147</span> }<a name="line.147"></a>
<span class="sourceLineNo">148</span><a name="line.148"></a>
<span class="sourceLineNo">149</span> private void updateMetaState(TableName tableName, TableState.State newState) throws IOException {<a name="line.149"></a>
<span class="sourceLineNo">150</span> if (tableName.equals(TableName.META_TABLE_NAME)) {<a name="line.150"></a>
<span class="sourceLineNo">151</span> if (TableState.State.DISABLING.equals(newState) ||<a name="line.151"></a>
<span class="sourceLineNo">152</span> TableState.State.DISABLED.equals(newState)) {<a name="line.152"></a>
<span class="sourceLineNo">153</span> throw new IllegalArgumentIOException("Cannot disable meta table; " + newState);<a name="line.153"></a>
<span class="sourceLineNo">154</span> }<a name="line.154"></a>
<span class="sourceLineNo">155</span> // Otherwise, just return; no need to set ENABLED on meta -- it is always ENABLED.<a name="line.155"></a>
<span class="sourceLineNo">156</span> return;<a name="line.156"></a>
<span class="sourceLineNo">157</span> }<a name="line.157"></a>
<span class="sourceLineNo">158</span> boolean succ = false;<a name="line.158"></a>
<span class="sourceLineNo">159</span> try {<a name="line.159"></a>
<span class="sourceLineNo">160</span> MetaTableAccessor.updateTableState(master.getConnection(), tableName, newState);<a name="line.160"></a>
<span class="sourceLineNo">161</span> tableName2State.put(tableName, newState);<a name="line.161"></a>
<span class="sourceLineNo">162</span> succ = true;<a name="line.162"></a>
<span class="sourceLineNo">163</span> } finally {<a name="line.163"></a>
<span class="sourceLineNo">164</span> if (!succ) {<a name="line.164"></a>
<span class="sourceLineNo">165</span> this.tableName2State.remove(tableName);<a name="line.165"></a>
<span class="sourceLineNo">166</span> }<a name="line.166"></a>
<span class="sourceLineNo">167</span> }<a name="line.167"></a>
<span class="sourceLineNo">168</span> }<a name="line.168"></a>
<span class="sourceLineNo">169</span><a name="line.169"></a>
<span class="sourceLineNo">170</span> @Nullable<a name="line.170"></a>
<span class="sourceLineNo">171</span> private TableState readMetaState(TableName tableName) throws IOException {<a name="line.171"></a>
<span class="sourceLineNo">172</span> TableState.State state = tableName2State.get(tableName);<a name="line.172"></a>
<span class="sourceLineNo">173</span> if (state != null) {<a name="line.173"></a>
<span class="sourceLineNo">174</span> return new TableState(tableName, state);<a name="line.174"></a>
<span class="sourceLineNo">175</span> }<a name="line.175"></a>
<span class="sourceLineNo">176</span> TableState tableState = MetaTableAccessor.getTableState(master.getConnection(), tableName);<a name="line.176"></a>
<span class="sourceLineNo">177</span> if (tableState != null) {<a name="line.177"></a>
<span class="sourceLineNo">178</span> tableName2State.putIfAbsent(tableName, tableState.getState());<a name="line.178"></a>
<span class="sourceLineNo">179</span> }<a name="line.179"></a>
<span class="sourceLineNo">180</span> return tableState;<a name="line.180"></a>
<span class="sourceLineNo">181</span> }<a name="line.181"></a>
<span class="sourceLineNo">182</span>}<a name="line.182"></a>
</pre>
</div>
</body>
</html>