| <!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, class: ShellExecEndpointCoprocessor"> |
| <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;</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.io.IOException;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.util.Collections;</span> |
| <span class="source-line-no">022</span><span id="line-22">import java.util.concurrent.ExecutorService;</span> |
| <span class="source-line-no">023</span><span id="line-23">import java.util.concurrent.Executors;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.commons.lang3.StringUtils;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.conf.Configuration;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.chaos.monkies.ChaosMonkey;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.coprocessor.MasterCoprocessor;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.coprocessor.RegionServerCoprocessor;</span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.coprocessor.protobuf.generated.ShellExecEndpoint;</span> |
| <span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.coprocessor.protobuf.generated.ShellExecEndpoint.ShellExecRequest;</span> |
| <span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.coprocessor.protobuf.generated.ShellExecEndpoint.ShellExecResponse;</span> |
| <span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.ipc.CoprocessorRpcUtils;</span> |
| <span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.util.Shell;</span> |
| <span class="source-line-no">034</span><span id="line-34">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">035</span><span id="line-35">import org.slf4j.Logger;</span> |
| <span class="source-line-no">036</span><span id="line-36">import org.slf4j.LoggerFactory;</span> |
| <span class="source-line-no">037</span><span id="line-37"></span> |
| <span class="source-line-no">038</span><span id="line-38">import org.apache.hbase.thirdparty.com.google.common.util.concurrent.ThreadFactoryBuilder;</span> |
| <span class="source-line-no">039</span><span id="line-39">import org.apache.hbase.thirdparty.com.google.protobuf.RpcCallback;</span> |
| <span class="source-line-no">040</span><span id="line-40">import org.apache.hbase.thirdparty.com.google.protobuf.RpcController;</span> |
| <span class="source-line-no">041</span><span id="line-41">import org.apache.hbase.thirdparty.com.google.protobuf.Service;</span> |
| <span class="source-line-no">042</span><span id="line-42"></span> |
| <span class="source-line-no">043</span><span id="line-43">/**</span> |
| <span class="source-line-no">044</span><span id="line-44"> * Receives shell commands from the client and executes them blindly. Intended only for use by</span> |
| <span class="source-line-no">045</span><span id="line-45"> * {@link ChaosMonkey} via {@link CoprocClusterManager}</span> |
| <span class="source-line-no">046</span><span id="line-46"> */</span> |
| <span class="source-line-no">047</span><span id="line-47">@InterfaceAudience.Private</span> |
| <span class="source-line-no">048</span><span id="line-48">public class ShellExecEndpointCoprocessor extends ShellExecEndpoint.ShellExecService</span> |
| <span class="source-line-no">049</span><span id="line-49"> implements MasterCoprocessor, RegionServerCoprocessor {</span> |
| <span class="source-line-no">050</span><span id="line-50"> private static final Logger LOG = LoggerFactory.getLogger(ShellExecEndpointCoprocessor.class);</span> |
| <span class="source-line-no">051</span><span id="line-51"></span> |
| <span class="source-line-no">052</span><span id="line-52"> public static final String BACKGROUND_DELAY_MS_KEY = "hbase.it.shellexeccoproc.async.delay.ms";</span> |
| <span class="source-line-no">053</span><span id="line-53"> public static final long DEFAULT_BACKGROUND_DELAY_MS = 1_000;</span> |
| <span class="source-line-no">054</span><span id="line-54"></span> |
| <span class="source-line-no">055</span><span id="line-55"> private final ExecutorService backgroundExecutor;</span> |
| <span class="source-line-no">056</span><span id="line-56"> private Configuration conf;</span> |
| <span class="source-line-no">057</span><span id="line-57"></span> |
| <span class="source-line-no">058</span><span id="line-58"> public ShellExecEndpointCoprocessor() {</span> |
| <span class="source-line-no">059</span><span id="line-59"> backgroundExecutor = Executors.newSingleThreadExecutor(new ThreadFactoryBuilder()</span> |
| <span class="source-line-no">060</span><span id="line-60"> .setNameFormat(ShellExecEndpointCoprocessor.class.getSimpleName() + "-{}").setDaemon(true)</span> |
| <span class="source-line-no">061</span><span id="line-61"> .setUncaughtExceptionHandler((t, e) -> LOG.warn("Thread {} threw", t, e)).build());</span> |
| <span class="source-line-no">062</span><span id="line-62"> }</span> |
| <span class="source-line-no">063</span><span id="line-63"></span> |
| <span class="source-line-no">064</span><span id="line-64"> @Override</span> |
| <span class="source-line-no">065</span><span id="line-65"> public Iterable<Service> getServices() {</span> |
| <span class="source-line-no">066</span><span id="line-66"> return Collections.singletonList(this);</span> |
| <span class="source-line-no">067</span><span id="line-67"> }</span> |
| <span class="source-line-no">068</span><span id="line-68"></span> |
| <span class="source-line-no">069</span><span id="line-69"> @Override</span> |
| <span class="source-line-no">070</span><span id="line-70"> public void start(CoprocessorEnvironment env) {</span> |
| <span class="source-line-no">071</span><span id="line-71"> conf = env.getConfiguration();</span> |
| <span class="source-line-no">072</span><span id="line-72"> }</span> |
| <span class="source-line-no">073</span><span id="line-73"></span> |
| <span class="source-line-no">074</span><span id="line-74"> @Override</span> |
| <span class="source-line-no">075</span><span id="line-75"> public void shellExec(final RpcController controller, final ShellExecRequest request,</span> |
| <span class="source-line-no">076</span><span id="line-76"> final RpcCallback<ShellExecResponse> done) {</span> |
| <span class="source-line-no">077</span><span id="line-77"> final String command = request.getCommand();</span> |
| <span class="source-line-no">078</span><span id="line-78"> if (StringUtils.isBlank(command)) {</span> |
| <span class="source-line-no">079</span><span id="line-79"> throw new RuntimeException("Request contained an empty command.");</span> |
| <span class="source-line-no">080</span><span id="line-80"> }</span> |
| <span class="source-line-no">081</span><span id="line-81"> final boolean awaitResponse = !request.hasAwaitResponse() || request.getAwaitResponse();</span> |
| <span class="source-line-no">082</span><span id="line-82"> final String[] subShellCmd = new String[] { "/usr/bin/env", "bash", "-c", command };</span> |
| <span class="source-line-no">083</span><span id="line-83"> final Shell.ShellCommandExecutor shell = new Shell.ShellCommandExecutor(subShellCmd);</span> |
| <span class="source-line-no">084</span><span id="line-84"></span> |
| <span class="source-line-no">085</span><span id="line-85"> final String msgFmt =</span> |
| <span class="source-line-no">086</span><span id="line-86"> "Executing command" + (!awaitResponse ? " on a background thread" : "") + ": {}";</span> |
| <span class="source-line-no">087</span><span id="line-87"> LOG.info(msgFmt, command);</span> |
| <span class="source-line-no">088</span><span id="line-88"></span> |
| <span class="source-line-no">089</span><span id="line-89"> if (awaitResponse) {</span> |
| <span class="source-line-no">090</span><span id="line-90"> runForegroundTask(shell, controller, done);</span> |
| <span class="source-line-no">091</span><span id="line-91"> } else {</span> |
| <span class="source-line-no">092</span><span id="line-92"> runBackgroundTask(shell, done);</span> |
| <span class="source-line-no">093</span><span id="line-93"> }</span> |
| <span class="source-line-no">094</span><span id="line-94"> }</span> |
| <span class="source-line-no">095</span><span id="line-95"></span> |
| <span class="source-line-no">096</span><span id="line-96"> private void runForegroundTask(final Shell.ShellCommandExecutor shell,</span> |
| <span class="source-line-no">097</span><span id="line-97"> final RpcController controller, final RpcCallback<ShellExecResponse> done) {</span> |
| <span class="source-line-no">098</span><span id="line-98"> ShellExecResponse.Builder builder = ShellExecResponse.newBuilder();</span> |
| <span class="source-line-no">099</span><span id="line-99"> try {</span> |
| <span class="source-line-no">100</span><span id="line-100"> doExec(shell, builder);</span> |
| <span class="source-line-no">101</span><span id="line-101"> } catch (IOException e) {</span> |
| <span class="source-line-no">102</span><span id="line-102"> LOG.error("Failure launching process", e);</span> |
| <span class="source-line-no">103</span><span id="line-103"> CoprocessorRpcUtils.setControllerException(controller, e);</span> |
| <span class="source-line-no">104</span><span id="line-104"> }</span> |
| <span class="source-line-no">105</span><span id="line-105"> done.run(builder.build());</span> |
| <span class="source-line-no">106</span><span id="line-106"> }</span> |
| <span class="source-line-no">107</span><span id="line-107"></span> |
| <span class="source-line-no">108</span><span id="line-108"> private void runBackgroundTask(final Shell.ShellCommandExecutor shell,</span> |
| <span class="source-line-no">109</span><span id="line-109"> final RpcCallback<ShellExecResponse> done) {</span> |
| <span class="source-line-no">110</span><span id="line-110"> final long sleepDuration = conf.getLong(BACKGROUND_DELAY_MS_KEY, DEFAULT_BACKGROUND_DELAY_MS);</span> |
| <span class="source-line-no">111</span><span id="line-111"> backgroundExecutor.execute(() -> {</span> |
| <span class="source-line-no">112</span><span id="line-112"> try {</span> |
| <span class="source-line-no">113</span><span id="line-113"> // sleep first so that the RPC can ACK. race condition here as we have no means of blocking</span> |
| <span class="source-line-no">114</span><span id="line-114"> // until the IPC response has been acknowledged by the client.</span> |
| <span class="source-line-no">115</span><span id="line-115"> Thread.sleep(sleepDuration);</span> |
| <span class="source-line-no">116</span><span id="line-116"> doExec(shell, ShellExecResponse.newBuilder());</span> |
| <span class="source-line-no">117</span><span id="line-117"> } catch (InterruptedException e) {</span> |
| <span class="source-line-no">118</span><span id="line-118"> LOG.warn("Interrupted before launching process.", e);</span> |
| <span class="source-line-no">119</span><span id="line-119"> } catch (IOException e) {</span> |
| <span class="source-line-no">120</span><span id="line-120"> LOG.error("Failure launching process", e);</span> |
| <span class="source-line-no">121</span><span id="line-121"> }</span> |
| <span class="source-line-no">122</span><span id="line-122"> });</span> |
| <span class="source-line-no">123</span><span id="line-123"> done.run(ShellExecResponse.newBuilder().build());</span> |
| <span class="source-line-no">124</span><span id="line-124"> }</span> |
| <span class="source-line-no">125</span><span id="line-125"></span> |
| <span class="source-line-no">126</span><span id="line-126"> /**</span> |
| <span class="source-line-no">127</span><span id="line-127"> * Execute {@code shell} and collect results into {@code builder} as side-effects.</span> |
| <span class="source-line-no">128</span><span id="line-128"> */</span> |
| <span class="source-line-no">129</span><span id="line-129"> private void doExec(final Shell.ShellCommandExecutor shell,</span> |
| <span class="source-line-no">130</span><span id="line-130"> final ShellExecResponse.Builder builder) throws IOException {</span> |
| <span class="source-line-no">131</span><span id="line-131"> try {</span> |
| <span class="source-line-no">132</span><span id="line-132"> shell.execute();</span> |
| <span class="source-line-no">133</span><span id="line-133"> builder.setExitCode(shell.getExitCode()).setStdout(shell.getOutput());</span> |
| <span class="source-line-no">134</span><span id="line-134"> } catch (Shell.ExitCodeException e) {</span> |
| <span class="source-line-no">135</span><span id="line-135"> LOG.warn("Launched process failed", e);</span> |
| <span class="source-line-no">136</span><span id="line-136"> builder.setExitCode(e.getExitCode()).setStdout(shell.getOutput()).setStderr(e.getMessage());</span> |
| <span class="source-line-no">137</span><span id="line-137"> }</span> |
| <span class="source-line-no">138</span><span id="line-138"> }</span> |
| <span class="source-line-no">139</span><span id="line-139">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
