blob: 886668092026b909e2b4dba9870cc01f63141c2b [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.backup.impl;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import static org.apache.hadoop.hbase.backup.BackupRestoreConstants.BACKUP_ATTEMPTS_PAUSE_MS_KEY;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import static org.apache.hadoop.hbase.backup.BackupRestoreConstants.BACKUP_MAX_ATTEMPTS_KEY;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import static org.apache.hadoop.hbase.backup.BackupRestoreConstants.DEFAULT_BACKUP_ATTEMPTS_PAUSE_MS;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import static org.apache.hadoop.hbase.backup.BackupRestoreConstants.DEFAULT_BACKUP_MAX_ATTEMPTS;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import static org.apache.hadoop.hbase.backup.BackupRestoreConstants.JOB_NAME_CONF_KEY;<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.io.IOException;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.util.ArrayList;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.util.HashMap;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.util.Map;<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.backup.BackupCopyJob;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.backup.BackupInfo;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.backup.BackupInfo.BackupPhase;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.backup.BackupInfo.BackupState;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.backup.BackupRequest;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.backup.BackupRestoreFactory;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.backup.BackupType;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.backup.master.LogRollMasterProcedureManager;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import org.apache.hadoop.hbase.backup.util.BackupUtils;<a name="line.39"></a>
<span class="sourceLineNo">040</span>import org.apache.hadoop.hbase.client.Admin;<a name="line.40"></a>
<span class="sourceLineNo">041</span>import org.apache.hadoop.hbase.client.Connection;<a name="line.41"></a>
<span class="sourceLineNo">042</span>import org.apache.hadoop.hbase.util.EnvironmentEdgeManager;<a name="line.42"></a>
<span class="sourceLineNo">043</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.43"></a>
<span class="sourceLineNo">044</span>import org.slf4j.Logger;<a name="line.44"></a>
<span class="sourceLineNo">045</span>import org.slf4j.LoggerFactory;<a name="line.45"></a>
<span class="sourceLineNo">046</span><a name="line.46"></a>
<span class="sourceLineNo">047</span>/**<a name="line.47"></a>
<span class="sourceLineNo">048</span> * Full table backup implementation<a name="line.48"></a>
<span class="sourceLineNo">049</span> */<a name="line.49"></a>
<span class="sourceLineNo">050</span>@InterfaceAudience.Private<a name="line.50"></a>
<span class="sourceLineNo">051</span>public class FullTableBackupClient extends TableBackupClient {<a name="line.51"></a>
<span class="sourceLineNo">052</span> private static final Logger LOG = LoggerFactory.getLogger(FullTableBackupClient.class);<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span> public FullTableBackupClient() {<a name="line.54"></a>
<span class="sourceLineNo">055</span> }<a name="line.55"></a>
<span class="sourceLineNo">056</span><a name="line.56"></a>
<span class="sourceLineNo">057</span> public FullTableBackupClient(final Connection conn, final String backupId, BackupRequest request)<a name="line.57"></a>
<span class="sourceLineNo">058</span> throws IOException {<a name="line.58"></a>
<span class="sourceLineNo">059</span> super(conn, backupId, request);<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> * Do snapshot copy.<a name="line.63"></a>
<span class="sourceLineNo">064</span> * @param backupInfo backup info<a name="line.64"></a>
<span class="sourceLineNo">065</span> * @throws Exception exception<a name="line.65"></a>
<span class="sourceLineNo">066</span> */<a name="line.66"></a>
<span class="sourceLineNo">067</span> protected void snapshotCopy(BackupInfo backupInfo) throws Exception {<a name="line.67"></a>
<span class="sourceLineNo">068</span> LOG.info("Snapshot copy is starting.");<a name="line.68"></a>
<span class="sourceLineNo">069</span><a name="line.69"></a>
<span class="sourceLineNo">070</span> // set overall backup phase: snapshot_copy<a name="line.70"></a>
<span class="sourceLineNo">071</span> backupInfo.setPhase(BackupPhase.SNAPSHOTCOPY);<a name="line.71"></a>
<span class="sourceLineNo">072</span><a name="line.72"></a>
<span class="sourceLineNo">073</span> // call ExportSnapshot to copy files based on hbase snapshot for backup<a name="line.73"></a>
<span class="sourceLineNo">074</span> // ExportSnapshot only support single snapshot export, need loop for multiple tables case<a name="line.74"></a>
<span class="sourceLineNo">075</span> BackupCopyJob copyService = BackupRestoreFactory.getBackupCopyJob(conf);<a name="line.75"></a>
<span class="sourceLineNo">076</span><a name="line.76"></a>
<span class="sourceLineNo">077</span> // number of snapshots matches number of tables<a name="line.77"></a>
<span class="sourceLineNo">078</span> float numOfSnapshots = backupInfo.getSnapshotNames().size();<a name="line.78"></a>
<span class="sourceLineNo">079</span><a name="line.79"></a>
<span class="sourceLineNo">080</span> LOG.debug("There are " + (int) numOfSnapshots + " snapshots to be copied.");<a name="line.80"></a>
<span class="sourceLineNo">081</span><a name="line.81"></a>
<span class="sourceLineNo">082</span> for (TableName table : backupInfo.getTables()) {<a name="line.82"></a>
<span class="sourceLineNo">083</span> // Currently we simply set the sub copy tasks by counting the table snapshot number, we can<a name="line.83"></a>
<span class="sourceLineNo">084</span> // calculate the real files' size for the percentage in the future.<a name="line.84"></a>
<span class="sourceLineNo">085</span> // backupCopier.setSubTaskPercntgInWholeTask(1f / numOfSnapshots);<a name="line.85"></a>
<span class="sourceLineNo">086</span> int res;<a name="line.86"></a>
<span class="sourceLineNo">087</span> ArrayList&lt;String&gt; argsList = new ArrayList&lt;&gt;();<a name="line.87"></a>
<span class="sourceLineNo">088</span> argsList.add("-snapshot");<a name="line.88"></a>
<span class="sourceLineNo">089</span> argsList.add(backupInfo.getSnapshotName(table));<a name="line.89"></a>
<span class="sourceLineNo">090</span> argsList.add("-copy-to");<a name="line.90"></a>
<span class="sourceLineNo">091</span> argsList.add(backupInfo.getTableBackupDir(table));<a name="line.91"></a>
<span class="sourceLineNo">092</span> if (backupInfo.getBandwidth() &gt; -1) {<a name="line.92"></a>
<span class="sourceLineNo">093</span> argsList.add("-bandwidth");<a name="line.93"></a>
<span class="sourceLineNo">094</span> argsList.add(String.valueOf(backupInfo.getBandwidth()));<a name="line.94"></a>
<span class="sourceLineNo">095</span> }<a name="line.95"></a>
<span class="sourceLineNo">096</span> if (backupInfo.getWorkers() &gt; -1) {<a name="line.96"></a>
<span class="sourceLineNo">097</span> argsList.add("-mappers");<a name="line.97"></a>
<span class="sourceLineNo">098</span> argsList.add(String.valueOf(backupInfo.getWorkers()));<a name="line.98"></a>
<span class="sourceLineNo">099</span> }<a name="line.99"></a>
<span class="sourceLineNo">100</span><a name="line.100"></a>
<span class="sourceLineNo">101</span> String[] args = argsList.toArray(new String[0]);<a name="line.101"></a>
<span class="sourceLineNo">102</span><a name="line.102"></a>
<span class="sourceLineNo">103</span> String jobname = "Full-Backup_" + backupInfo.getBackupId() + "_" + table.getNameAsString();<a name="line.103"></a>
<span class="sourceLineNo">104</span> if (LOG.isDebugEnabled()) {<a name="line.104"></a>
<span class="sourceLineNo">105</span> LOG.debug("Setting snapshot copy job name to : " + jobname);<a name="line.105"></a>
<span class="sourceLineNo">106</span> }<a name="line.106"></a>
<span class="sourceLineNo">107</span> conf.set(JOB_NAME_CONF_KEY, jobname);<a name="line.107"></a>
<span class="sourceLineNo">108</span><a name="line.108"></a>
<span class="sourceLineNo">109</span> LOG.debug("Copy snapshot " + args[1] + " to " + args[3]);<a name="line.109"></a>
<span class="sourceLineNo">110</span> res = copyService.copy(backupInfo, backupManager, conf, BackupType.FULL, args);<a name="line.110"></a>
<span class="sourceLineNo">111</span><a name="line.111"></a>
<span class="sourceLineNo">112</span> // if one snapshot export failed, do not continue for remained snapshots<a name="line.112"></a>
<span class="sourceLineNo">113</span> if (res != 0) {<a name="line.113"></a>
<span class="sourceLineNo">114</span> LOG.error("Exporting Snapshot " + args[1] + " failed with return code: " + res + ".");<a name="line.114"></a>
<span class="sourceLineNo">115</span><a name="line.115"></a>
<span class="sourceLineNo">116</span> throw new IOException("Failed of exporting snapshot " + args[1] + " to " + args[3]<a name="line.116"></a>
<span class="sourceLineNo">117</span> + " with reason code " + res);<a name="line.117"></a>
<span class="sourceLineNo">118</span> }<a name="line.118"></a>
<span class="sourceLineNo">119</span><a name="line.119"></a>
<span class="sourceLineNo">120</span> conf.unset(JOB_NAME_CONF_KEY);<a name="line.120"></a>
<span class="sourceLineNo">121</span> LOG.info("Snapshot copy " + args[1] + " finished.");<a name="line.121"></a>
<span class="sourceLineNo">122</span> }<a name="line.122"></a>
<span class="sourceLineNo">123</span> }<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> * Backup request execution.<a name="line.126"></a>
<span class="sourceLineNo">127</span> * @throws IOException if the execution of the backup fails<a name="line.127"></a>
<span class="sourceLineNo">128</span> */<a name="line.128"></a>
<span class="sourceLineNo">129</span> @Override<a name="line.129"></a>
<span class="sourceLineNo">130</span> public void execute() throws IOException {<a name="line.130"></a>
<span class="sourceLineNo">131</span> try (Admin admin = conn.getAdmin()) {<a name="line.131"></a>
<span class="sourceLineNo">132</span> // Begin BACKUP<a name="line.132"></a>
<span class="sourceLineNo">133</span> beginBackup(backupManager, backupInfo);<a name="line.133"></a>
<span class="sourceLineNo">134</span> String savedStartCode;<a name="line.134"></a>
<span class="sourceLineNo">135</span> boolean firstBackup;<a name="line.135"></a>
<span class="sourceLineNo">136</span> // do snapshot for full table backup<a name="line.136"></a>
<span class="sourceLineNo">137</span><a name="line.137"></a>
<span class="sourceLineNo">138</span> savedStartCode = backupManager.readBackupStartCode();<a name="line.138"></a>
<span class="sourceLineNo">139</span> firstBackup = savedStartCode == null || Long.parseLong(savedStartCode) == 0L;<a name="line.139"></a>
<span class="sourceLineNo">140</span> if (firstBackup) {<a name="line.140"></a>
<span class="sourceLineNo">141</span> // This is our first backup. Let's put some marker to system table so that we can hold the<a name="line.141"></a>
<span class="sourceLineNo">142</span> // logs while we do the backup.<a name="line.142"></a>
<span class="sourceLineNo">143</span> backupManager.writeBackupStartCode(0L);<a name="line.143"></a>
<span class="sourceLineNo">144</span> }<a name="line.144"></a>
<span class="sourceLineNo">145</span> // We roll log here before we do the snapshot. It is possible there is duplicate data<a name="line.145"></a>
<span class="sourceLineNo">146</span> // in the log that is already in the snapshot. But if we do it after the snapshot, we<a name="line.146"></a>
<span class="sourceLineNo">147</span> // could have data loss.<a name="line.147"></a>
<span class="sourceLineNo">148</span> // A better approach is to do the roll log on each RS in the same global procedure as<a name="line.148"></a>
<span class="sourceLineNo">149</span> // the snapshot.<a name="line.149"></a>
<span class="sourceLineNo">150</span> LOG.info("Execute roll log procedure for full backup ...");<a name="line.150"></a>
<span class="sourceLineNo">151</span><a name="line.151"></a>
<span class="sourceLineNo">152</span> Map&lt;String, String&gt; props = new HashMap&lt;&gt;();<a name="line.152"></a>
<span class="sourceLineNo">153</span> props.put("backupRoot", backupInfo.getBackupRootDir());<a name="line.153"></a>
<span class="sourceLineNo">154</span> admin.execProcedure(LogRollMasterProcedureManager.ROLLLOG_PROCEDURE_SIGNATURE,<a name="line.154"></a>
<span class="sourceLineNo">155</span> LogRollMasterProcedureManager.ROLLLOG_PROCEDURE_NAME, props);<a name="line.155"></a>
<span class="sourceLineNo">156</span><a name="line.156"></a>
<span class="sourceLineNo">157</span> newTimestamps = backupManager.readRegionServerLastLogRollResult();<a name="line.157"></a>
<span class="sourceLineNo">158</span><a name="line.158"></a>
<span class="sourceLineNo">159</span> // SNAPSHOT_TABLES:<a name="line.159"></a>
<span class="sourceLineNo">160</span> backupInfo.setPhase(BackupPhase.SNAPSHOT);<a name="line.160"></a>
<span class="sourceLineNo">161</span> for (TableName tableName : tableList) {<a name="line.161"></a>
<span class="sourceLineNo">162</span> String snapshotName = "snapshot_" + Long.toString(EnvironmentEdgeManager.currentTime())<a name="line.162"></a>
<span class="sourceLineNo">163</span> + "_" + tableName.getNamespaceAsString() + "_" + tableName.getQualifierAsString();<a name="line.163"></a>
<span class="sourceLineNo">164</span><a name="line.164"></a>
<span class="sourceLineNo">165</span> snapshotTable(admin, tableName, snapshotName);<a name="line.165"></a>
<span class="sourceLineNo">166</span> backupInfo.setSnapshotName(tableName, snapshotName);<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> // SNAPSHOT_COPY:<a name="line.169"></a>
<span class="sourceLineNo">170</span> // do snapshot copy<a name="line.170"></a>
<span class="sourceLineNo">171</span> LOG.debug("snapshot copy for " + backupId);<a name="line.171"></a>
<span class="sourceLineNo">172</span> snapshotCopy(backupInfo);<a name="line.172"></a>
<span class="sourceLineNo">173</span> // Updates incremental backup table set<a name="line.173"></a>
<span class="sourceLineNo">174</span> backupManager.addIncrementalBackupTableSet(backupInfo.getTables());<a name="line.174"></a>
<span class="sourceLineNo">175</span><a name="line.175"></a>
<span class="sourceLineNo">176</span> // BACKUP_COMPLETE:<a name="line.176"></a>
<span class="sourceLineNo">177</span> // set overall backup status: complete. Here we make sure to complete the backup.<a name="line.177"></a>
<span class="sourceLineNo">178</span> // After this checkpoint, even if entering cancel process, will let the backup finished<a name="line.178"></a>
<span class="sourceLineNo">179</span> backupInfo.setState(BackupState.COMPLETE);<a name="line.179"></a>
<span class="sourceLineNo">180</span> // The table list in backupInfo is good for both full backup and incremental backup.<a name="line.180"></a>
<span class="sourceLineNo">181</span> // For incremental backup, it contains the incremental backup table set.<a name="line.181"></a>
<span class="sourceLineNo">182</span> backupManager.writeRegionServerLogTimestamp(backupInfo.getTables(), newTimestamps);<a name="line.182"></a>
<span class="sourceLineNo">183</span><a name="line.183"></a>
<span class="sourceLineNo">184</span> Map&lt;TableName, Map&lt;String, Long&gt;&gt; newTableSetTimestampMap =<a name="line.184"></a>
<span class="sourceLineNo">185</span> backupManager.readLogTimestampMap();<a name="line.185"></a>
<span class="sourceLineNo">186</span><a name="line.186"></a>
<span class="sourceLineNo">187</span> backupInfo.setTableSetTimestampMap(newTableSetTimestampMap);<a name="line.187"></a>
<span class="sourceLineNo">188</span> Long newStartCode =<a name="line.188"></a>
<span class="sourceLineNo">189</span> BackupUtils.getMinValue(BackupUtils.getRSLogTimestampMins(newTableSetTimestampMap));<a name="line.189"></a>
<span class="sourceLineNo">190</span> backupManager.writeBackupStartCode(newStartCode);<a name="line.190"></a>
<span class="sourceLineNo">191</span><a name="line.191"></a>
<span class="sourceLineNo">192</span> // backup complete<a name="line.192"></a>
<span class="sourceLineNo">193</span> completeBackup(conn, backupInfo, backupManager, BackupType.FULL, conf);<a name="line.193"></a>
<span class="sourceLineNo">194</span> } catch (Exception e) {<a name="line.194"></a>
<span class="sourceLineNo">195</span> failBackup(conn, backupInfo, backupManager, e, "Unexpected BackupException : ",<a name="line.195"></a>
<span class="sourceLineNo">196</span> BackupType.FULL, conf);<a name="line.196"></a>
<span class="sourceLineNo">197</span> throw new IOException(e);<a name="line.197"></a>
<span class="sourceLineNo">198</span> }<a name="line.198"></a>
<span class="sourceLineNo">199</span> }<a name="line.199"></a>
<span class="sourceLineNo">200</span><a name="line.200"></a>
<span class="sourceLineNo">201</span> protected void snapshotTable(Admin admin, TableName tableName, String snapshotName)<a name="line.201"></a>
<span class="sourceLineNo">202</span> throws IOException {<a name="line.202"></a>
<span class="sourceLineNo">203</span> int maxAttempts = conf.getInt(BACKUP_MAX_ATTEMPTS_KEY, DEFAULT_BACKUP_MAX_ATTEMPTS);<a name="line.203"></a>
<span class="sourceLineNo">204</span> int pause = conf.getInt(BACKUP_ATTEMPTS_PAUSE_MS_KEY, DEFAULT_BACKUP_ATTEMPTS_PAUSE_MS);<a name="line.204"></a>
<span class="sourceLineNo">205</span> int attempts = 0;<a name="line.205"></a>
<span class="sourceLineNo">206</span><a name="line.206"></a>
<span class="sourceLineNo">207</span> while (attempts++ &lt; maxAttempts) {<a name="line.207"></a>
<span class="sourceLineNo">208</span> try {<a name="line.208"></a>
<span class="sourceLineNo">209</span> admin.snapshot(snapshotName, tableName);<a name="line.209"></a>
<span class="sourceLineNo">210</span> return;<a name="line.210"></a>
<span class="sourceLineNo">211</span> } catch (IOException ee) {<a name="line.211"></a>
<span class="sourceLineNo">212</span> LOG.warn("Snapshot attempt " + attempts + " failed for table " + tableName<a name="line.212"></a>
<span class="sourceLineNo">213</span> + ", sleeping for " + pause + "ms", ee);<a name="line.213"></a>
<span class="sourceLineNo">214</span> if (attempts &lt; maxAttempts) {<a name="line.214"></a>
<span class="sourceLineNo">215</span> try {<a name="line.215"></a>
<span class="sourceLineNo">216</span> Thread.sleep(pause);<a name="line.216"></a>
<span class="sourceLineNo">217</span> } catch (InterruptedException e) {<a name="line.217"></a>
<span class="sourceLineNo">218</span> Thread.currentThread().interrupt();<a name="line.218"></a>
<span class="sourceLineNo">219</span> break;<a name="line.219"></a>
<span class="sourceLineNo">220</span> }<a name="line.220"></a>
<span class="sourceLineNo">221</span> }<a name="line.221"></a>
<span class="sourceLineNo">222</span> }<a name="line.222"></a>
<span class="sourceLineNo">223</span> }<a name="line.223"></a>
<span class="sourceLineNo">224</span> throw new IOException("Failed to snapshot table " + tableName);<a name="line.224"></a>
<span class="sourceLineNo">225</span> }<a name="line.225"></a>
<span class="sourceLineNo">226</span>}<a name="line.226"></a>
</pre>
</div>
</body>
</html>