| <!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.util;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.io.IOException;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import org.apache.hadoop.conf.Configuration;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.hadoop.fs.FileSystem;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.hadoop.fs.Path;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.TableName;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.client.Admin;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.client.RegionInfo;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.client.RegionReplicaUtil;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.io.HFileLink;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.io.Reference;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.regionserver.HRegion;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.regionserver.StoreFileInfo;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span><a name="line.33"></a> |
| <span class="sourceLineNo">034</span>/**<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * Similar to {@link RegionReplicaUtil} but for the server side<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> */<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>@InterfaceAudience.Private<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>public class ServerRegionReplicaUtil extends RegionReplicaUtil {<a name="line.38"></a> |
| <span class="sourceLineNo">039</span><a name="line.39"></a> |
| <span class="sourceLineNo">040</span> /**<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * Whether asynchronous WAL replication to the secondary region replicas is enabled or not. If<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * this is enabled, a replication peer named "region_replica_replication" will be created which<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * will tail the logs and replicate the mutatations to region replicas for tables that have region<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * replication &gt; 1. If this is enabled once, disabling this replication also requires disabling<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * the replication peer using shell or {@link Admin} java class. Replication to secondary region<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * replicas works over standard inter-cluster replication.ยท<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> */<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> public static final String REGION_REPLICA_REPLICATION_CONF_KEY =<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> "hbase.region.replica.replication.enabled";<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> private static final boolean DEFAULT_REGION_REPLICA_REPLICATION = false;<a name="line.50"></a> |
| <span class="sourceLineNo">051</span><a name="line.51"></a> |
| <span class="sourceLineNo">052</span> /**<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * @deprecated Since 3.0.0, leave here only for implementing compatibility code.<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> */<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> @Deprecated<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> public static final String REGION_REPLICA_REPLICATION_PEER = "region_replica_replication";<a name="line.56"></a> |
| <span class="sourceLineNo">057</span><a name="line.57"></a> |
| <span class="sourceLineNo">058</span> /**<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * Same as for {@link #REGION_REPLICA_REPLICATION_CONF_KEY} but for catalog replication.<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> */<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> public static final String REGION_REPLICA_REPLICATION_CATALOG_CONF_KEY =<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> "hbase.region.replica.replication.catalog.enabled";<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> private static final boolean DEFAULT_REGION_REPLICA_REPLICATION_CATALOG = false;<a name="line.63"></a> |
| <span class="sourceLineNo">064</span><a name="line.64"></a> |
| <span class="sourceLineNo">065</span> /**<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * Enables or disables refreshing store files of secondary region replicas when the memory is<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * above the global memstore lower limit. Refreshing the store files means that we will do a file<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * list of the primary regions store files, and pick up new files. Also depending on the store<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * files, we can drop some memstore contents which will free up memory.<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> */<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> public static final String REGION_REPLICA_STORE_FILE_REFRESH =<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> "hbase.region.replica.storefile.refresh";<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> private static final boolean DEFAULT_REGION_REPLICA_STORE_FILE_REFRESH = true;<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> * The multiplier to use when we want to refresh a secondary region instead of flushing a primary<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * region. Default value assumes that for doing the file refresh, the biggest secondary should be<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * 4 times bigger than the biggest primary.<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> */<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> public static final String REGION_REPLICA_STORE_FILE_REFRESH_MEMSTORE_MULTIPLIER =<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> "hbase.region.replica.storefile.refresh.memstore.multiplier";<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> private static final double DEFAULT_REGION_REPLICA_STORE_FILE_REFRESH_MEMSTORE_MULTIPLIER = 4;<a name="line.82"></a> |
| <span class="sourceLineNo">083</span><a name="line.83"></a> |
| <span class="sourceLineNo">084</span> /**<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * Returns the regionInfo object to use for interacting with the file system.<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * @return An RegionInfo object to interact with the filesystem<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> */<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> public static RegionInfo getRegionInfoForFs(RegionInfo regionInfo) {<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> if (regionInfo == null) {<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> return null;<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> }<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> return RegionReplicaUtil.getRegionInfoForDefaultReplica(regionInfo);<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> }<a name="line.93"></a> |
| <span class="sourceLineNo">094</span><a name="line.94"></a> |
| <span class="sourceLineNo">095</span> /**<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> * Returns whether this region replica can accept writes.<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * @param region the HRegion object<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * @return whether the replica is read only<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> */<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> public static boolean isReadOnly(HRegion region) {<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> return region.getTableDescriptor().isReadOnly() || !isDefaultReplica(region.getRegionInfo());<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> }<a name="line.102"></a> |
| <span class="sourceLineNo">103</span><a name="line.103"></a> |
| <span class="sourceLineNo">104</span> /**<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> * Returns whether to replay the recovered edits to flush the results. Currently secondary region<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * replicas do not replay the edits, since it would cause flushes which might affect the primary<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * region. Primary regions even opened in read only mode should replay the edits.<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * @param region the HRegion object<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> * @return whether recovered edits should be replayed.<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> */<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> public static boolean shouldReplayRecoveredEdits(HRegion region) {<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> return isDefaultReplica(region.getRegionInfo());<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> }<a name="line.113"></a> |
| <span class="sourceLineNo">114</span><a name="line.114"></a> |
| <span class="sourceLineNo">115</span> /**<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> * Returns a StoreFileInfo from the given FileStatus. Secondary replicas refer to the files of the<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> * primary region, so an HFileLink is used to construct the StoreFileInfo. This way ensures that<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> * the secondary will be able to continue reading the store files even if they are moved to<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> * archive after compaction<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> */<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> public static StoreFileInfo getStoreFileInfo(Configuration conf, FileSystem fs,<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> RegionInfo regionInfo, RegionInfo regionInfoForFs, String familyName, Path path)<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> throws IOException {<a name="line.123"></a> |
| <span class="sourceLineNo">124</span><a name="line.124"></a> |
| <span class="sourceLineNo">125</span> // if this is a primary region, just return the StoreFileInfo constructed from path<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> if (RegionInfo.COMPARATOR.compare(regionInfo, regionInfoForFs) == 0) {<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> return new StoreFileInfo(conf, fs, path, true);<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> }<a name="line.128"></a> |
| <span class="sourceLineNo">129</span><a name="line.129"></a> |
| <span class="sourceLineNo">130</span> // else create a store file link. The link file does not exists on filesystem though.<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> if (HFileLink.isHFileLink(path) || StoreFileInfo.isHFile(path)) {<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> HFileLink link = HFileLink.build(conf, regionInfoForFs.getTable(),<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> regionInfoForFs.getEncodedName(), familyName, path.getName());<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> return new StoreFileInfo(conf, fs, link.getFileStatus(fs), link);<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> } else if (StoreFileInfo.isReference(path)) {<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> Reference reference = Reference.read(fs, path);<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> Path referencePath = StoreFileInfo.getReferredToFile(path);<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> if (HFileLink.isHFileLink(referencePath)) {<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> // HFileLink Reference<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> HFileLink link = HFileLink.buildFromHFileLinkPattern(conf, referencePath);<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> return new StoreFileInfo(conf, fs, link.getFileStatus(fs), reference, link);<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> } else {<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> // Reference<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> HFileLink link = HFileLink.build(conf, regionInfoForFs.getTable(),<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> regionInfoForFs.getEncodedName(), familyName, path.getName());<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> return new StoreFileInfo(conf, fs, link.getFileStatus(fs), reference);<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> }<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> } else {<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> throw new IOException("path=" + path + " doesn't look like a valid StoreFile");<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> }<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> }<a name="line.151"></a> |
| <span class="sourceLineNo">152</span><a name="line.152"></a> |
| <span class="sourceLineNo">153</span> /**<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> * @return True if Region Read Replica is enabled for <code>tn</code> (whether hbase:meta or<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> * user-space tables).<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> */<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> public static boolean isRegionReplicaReplicationEnabled(Configuration conf, TableName tn) {<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> return isMetaRegionReplicaReplicationEnabled(conf, tn)<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> || isRegionReplicaReplicationEnabled(conf);<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> }<a name="line.160"></a> |
| <span class="sourceLineNo">161</span><a name="line.161"></a> |
| <span class="sourceLineNo">162</span> /** Returns True if Region Read Replica is enabled for user-space tables. */<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> private static boolean isRegionReplicaReplicationEnabled(Configuration conf) {<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> return conf.getBoolean(REGION_REPLICA_REPLICATION_CONF_KEY, DEFAULT_REGION_REPLICA_REPLICATION);<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> }<a name="line.165"></a> |
| <span class="sourceLineNo">166</span><a name="line.166"></a> |
| <span class="sourceLineNo">167</span> /** Returns True if hbase:meta Region Read Replica is enabled. */<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> public static boolean isMetaRegionReplicaReplicationEnabled(Configuration conf, TableName tn) {<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> return TableName.isMetaTableName(tn) && conf.getBoolean(<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> REGION_REPLICA_REPLICATION_CATALOG_CONF_KEY, DEFAULT_REGION_REPLICA_REPLICATION_CATALOG);<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> }<a name="line.171"></a> |
| <span class="sourceLineNo">172</span><a name="line.172"></a> |
| <span class="sourceLineNo">173</span> /** Returns True if wait for primary to flush is enabled for user-space tables. */<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> public static boolean isRegionReplicaWaitForPrimaryFlushEnabled(Configuration conf) {<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> return conf.getBoolean(REGION_REPLICA_WAIT_FOR_PRIMARY_FLUSH_CONF_KEY,<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> DEFAULT_REGION_REPLICA_WAIT_FOR_PRIMARY_FLUSH);<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> }<a name="line.177"></a> |
| <span class="sourceLineNo">178</span><a name="line.178"></a> |
| <span class="sourceLineNo">179</span> /** Returns True if we are to refresh user-space hfiles in Region Read Replicas. */<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> public static boolean isRegionReplicaStoreFileRefreshEnabled(Configuration conf) {<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> return conf.getBoolean(REGION_REPLICA_STORE_FILE_REFRESH,<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> DEFAULT_REGION_REPLICA_STORE_FILE_REFRESH);<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> }<a name="line.183"></a> |
| <span class="sourceLineNo">184</span><a name="line.184"></a> |
| <span class="sourceLineNo">185</span> public static double getRegionReplicaStoreFileRefreshMultiplier(Configuration conf) {<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> return conf.getDouble(REGION_REPLICA_STORE_FILE_REFRESH_MEMSTORE_MULTIPLIER,<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> DEFAULT_REGION_REPLICA_STORE_FILE_REFRESH_MEMSTORE_MULTIPLIER);<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> }<a name="line.188"></a> |
| <span class="sourceLineNo">189</span><a name="line.189"></a> |
| <span class="sourceLineNo">190</span>}<a name="line.190"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
