| <!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> *<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * or more contributor license agreements. See the NOTICE file<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * distributed with this work for additional information<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * regarding copyright ownership. The ASF licenses this file<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * to you under the Apache License, Version 2.0 (the<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * "License"); you may not use this file except in compliance<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> * with the License. You may obtain a copy of the License at<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> *<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> *<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * Unless required by applicable law or agreed to in writing, software<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * See the License for the specific language governing permissions and<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> * limitations under the License.<a name="line.17"></a> |
| <span class="sourceLineNo">018</span> */<a name="line.18"></a> |
| <span class="sourceLineNo">019</span>package org.apache.hadoop.hbase.master;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import edu.umd.cs.findbugs.annotations.NonNull;<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.List;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.util.Map;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.hadoop.conf.Configurable;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.hadoop.conf.Configuration;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.ClusterMetrics;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.ServerName;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.Stoppable;<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.client.RegionInfo;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.conf.ConfigurationObserver;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span><a name="line.34"></a> |
| <span class="sourceLineNo">035</span>/**<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * Makes decisions about the placement and movement of Regions across<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * RegionServers.<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> *<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * <p>Cluster-wide load balancing will occur only when there are no regions in<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * transition and according to a fixed period of a time using {@link #balanceCluster(Map)}.<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> *<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * <p>On cluster startup, bulk assignment can be used to determine<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * locations for all Regions in a cluster.<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> *<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * <p>This class produces plans for the<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * {@link org.apache.hadoop.hbase.master.assignment.AssignmentManager}<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * to execute.<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> */<a name="line.48"></a> |
| <span class="sourceLineNo">049</span>@InterfaceAudience.Private<a name="line.49"></a> |
| <span class="sourceLineNo">050</span>public interface LoadBalancer extends Configurable, Stoppable, ConfigurationObserver {<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> /**<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * Master can carry regions as of hbase-2.0.0.<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * By default, it carries no tables.<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * TODO: Add any | system as flags to indicate what it can do.<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> *<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * @deprecated since 2.4.0, will be removed in 3.0.0.<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * @see <a href="https://issues.apache.org/jira/browse/HBASE-15549">HBASE-15549</a><a name="line.57"></a> |
| <span class="sourceLineNo">058</span> */<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> @Deprecated<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> String TABLES_ON_MASTER = "hbase.balancer.tablesOnMaster";<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> * Master carries system tables.<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> *<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * @deprecated since 2.4.0, will be removed in 3.0.0.<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * @see <a href="https://issues.apache.org/jira/browse/HBASE-15549">HBASE-15549</a><a name="line.66"></a> |
| <span class="sourceLineNo">067</span> */<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> @Deprecated<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> String SYSTEM_TABLES_ON_MASTER = "hbase.balancer.tablesOnMaster.systemTablesOnly";<a name="line.69"></a> |
| <span class="sourceLineNo">070</span><a name="line.70"></a> |
| <span class="sourceLineNo">071</span> // Used to signal to the caller that the region(s) cannot be assigned<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> // We deliberately use 'localhost' so the operation will fail fast<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> ServerName BOGUS_SERVER_NAME = ServerName.valueOf("localhost,1,1");<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> * Config for pluggable load balancers.<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * @deprecated since 3.0.0, will be removed in 4.0.0. In the new implementation, as the base load<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * balancer will always be the rs group based one, you should just use<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * {@link org.apache.hadoop.hbase.HConstants#HBASE_MASTER_LOADBALANCER_CLASS} to<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * config the per group load balancer.<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> */<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> @Deprecated<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> String HBASE_RSGROUP_LOADBALANCER_CLASS = "hbase.rsgroup.grouploadbalancer.class";<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> /**<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * Set the current cluster status. This allows a LoadBalancer to map host name to a server<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> */<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> void setClusterMetrics(ClusterMetrics st);<a name="line.87"></a> |
| <span class="sourceLineNo">088</span><a name="line.88"></a> |
| <span class="sourceLineNo">089</span><a name="line.89"></a> |
| <span class="sourceLineNo">090</span> /**<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * Set the master service.<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> */<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> void setMasterServices(MasterServices masterServices);<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> * Perform the major balance operation for cluster, will invoke {@link #balanceTable} to do actual<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * balance. Normally not need override this method, except<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * {@link org.apache.hadoop.hbase.master.balancer.SimpleLoadBalancer} and<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * {@link org.apache.hadoop.hbase.rsgroup.RSGroupBasedLoadBalancer}<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * @param loadOfAllTable region load of servers for all table<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * @return a list of regions to be moved, including source and destination, or null if cluster is<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * already balanced<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> */<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> List<RegionPlan> balanceCluster(Map<TableName,<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> Map<ServerName, List<RegionInfo>>> loadOfAllTable) throws IOException;<a name="line.105"></a> |
| <span class="sourceLineNo">106</span><a name="line.106"></a> |
| <span class="sourceLineNo">107</span> /**<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * Perform the major balance operation for table, all class implement of {@link LoadBalancer}<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> * should override this method<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * @param tableName the table to be balanced<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * @param loadOfOneTable region load of servers for the specific one table<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * @return List of plans<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> */<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> List<RegionPlan> balanceTable(TableName tableName,<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> Map<ServerName, List<RegionInfo>> loadOfOneTable);<a name="line.115"></a> |
| <span class="sourceLineNo">116</span><a name="line.116"></a> |
| <span class="sourceLineNo">117</span> /**<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> * Perform a Round Robin assignment of regions.<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> * @return Map of servername to regioninfos<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> */<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> @NonNull<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> Map<ServerName, List<RegionInfo>> roundRobinAssignment(List<RegionInfo> regions,<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> List<ServerName> servers) throws IOException;<a name="line.123"></a> |
| <span class="sourceLineNo">124</span><a name="line.124"></a> |
| <span class="sourceLineNo">125</span> /**<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> * Assign regions to the previously hosting region server<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> * @return List of plans<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> */<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> @NonNull<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> Map<ServerName, List<RegionInfo>> retainAssignment(Map<RegionInfo, ServerName> regions,<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> List<ServerName> servers) throws IOException;<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> * Get a random region server from the list<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> * @param regionInfo Region for which this selection is being done.<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> */<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> ServerName randomAssignment(RegionInfo regionInfo, List<ServerName> servers) throws IOException;<a name="line.137"></a> |
| <span class="sourceLineNo">138</span><a name="line.138"></a> |
| <span class="sourceLineNo">139</span> /**<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> * Initialize the load balancer. Must be called after setters.<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> */<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> void initialize() throws IOException;<a name="line.142"></a> |
| <span class="sourceLineNo">143</span><a name="line.143"></a> |
| <span class="sourceLineNo">144</span> /**<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> * Marks the region as online at balancer.<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> */<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> void regionOnline(RegionInfo regionInfo, ServerName sn);<a name="line.147"></a> |
| <span class="sourceLineNo">148</span><a name="line.148"></a> |
| <span class="sourceLineNo">149</span> /**<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> * Marks the region as offline at balancer.<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> */<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> void regionOffline(RegionInfo regionInfo);<a name="line.152"></a> |
| <span class="sourceLineNo">153</span><a name="line.153"></a> |
| <span class="sourceLineNo">154</span> /**<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> * Notification that config has changed<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> */<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> @Override<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> void onConfigurationChange(Configuration conf);<a name="line.158"></a> |
| <span class="sourceLineNo">159</span><a name="line.159"></a> |
| <span class="sourceLineNo">160</span> /**<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> * If balancer needs to do initialization after Master has started up, lets do that here.<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> */<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> void postMasterStartupInitialize();<a name="line.163"></a> |
| <span class="sourceLineNo">164</span><a name="line.164"></a> |
| <span class="sourceLineNo">165</span> /*Updates balancer status tag reported to JMX*/<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> void updateBalancerStatus(boolean status);<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> * @return true if Master carries regions<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> * @deprecated since 2.4.0, will be removed in 3.0.0.<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> * @see <a href="https://issues.apache.org/jira/browse/HBASE-15549">HBASE-15549</a><a name="line.171"></a> |
| <span class="sourceLineNo">172</span> */<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> @Deprecated<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> static boolean isTablesOnMaster(Configuration conf) {<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> return conf.getBoolean(TABLES_ON_MASTER, false);<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> }<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> * @deprecated since 2.4.0, will be removed in 3.0.0.<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> * @see <a href="https://issues.apache.org/jira/browse/HBASE-15549">HBASE-15549</a><a name="line.180"></a> |
| <span class="sourceLineNo">181</span> */<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> @Deprecated<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> static boolean isSystemTablesOnlyOnMaster(Configuration conf) {<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> return conf.getBoolean(SYSTEM_TABLES_ON_MASTER, false);<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> }<a name="line.185"></a> |
| <span class="sourceLineNo">186</span><a name="line.186"></a> |
| <span class="sourceLineNo">187</span> /**<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> * @deprecated since 2.4.0, will be removed in 3.0.0.<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> * @see <a href="https://issues.apache.org/jira/browse/HBASE-15549">HBASE-15549</a><a name="line.189"></a> |
| <span class="sourceLineNo">190</span> */<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> @Deprecated<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> static boolean isMasterCanHostUserRegions(Configuration conf) {<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> return isTablesOnMaster(conf) && !isSystemTablesOnlyOnMaster(conf);<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> }<a name="line.194"></a> |
| <span class="sourceLineNo">195</span>}<a name="line.195"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
