| <!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.coprocessor, class: CoprocessorHost, class: ObserverOperationWithoutResult"> |
| <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.coprocessor;</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.ArrayList;</span> |
| <span class="source-line-no">022</span><span id="line-22">import java.util.Collections;</span> |
| <span class="source-line-no">023</span><span id="line-23">import java.util.Comparator;</span> |
| <span class="source-line-no">024</span><span id="line-24">import java.util.HashSet;</span> |
| <span class="source-line-no">025</span><span id="line-25">import java.util.List;</span> |
| <span class="source-line-no">026</span><span id="line-26">import java.util.Optional;</span> |
| <span class="source-line-no">027</span><span id="line-27">import java.util.Set;</span> |
| <span class="source-line-no">028</span><span id="line-28">import java.util.TreeSet;</span> |
| <span class="source-line-no">029</span><span id="line-29">import java.util.UUID;</span> |
| <span class="source-line-no">030</span><span id="line-30">import java.util.concurrent.ConcurrentSkipListSet;</span> |
| <span class="source-line-no">031</span><span id="line-31">import java.util.concurrent.atomic.AtomicInteger;</span> |
| <span class="source-line-no">032</span><span id="line-32">import java.util.function.Function;</span> |
| <span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.conf.Configuration;</span> |
| <span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.fs.Path;</span> |
| <span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.hbase.Abortable;</span> |
| <span class="source-line-no">036</span><span id="line-36">import org.apache.hadoop.hbase.Coprocessor;</span> |
| <span class="source-line-no">037</span><span id="line-37">import org.apache.hadoop.hbase.CoprocessorEnvironment;</span> |
| <span class="source-line-no">038</span><span id="line-38">import org.apache.hadoop.hbase.DoNotRetryIOException;</span> |
| <span class="source-line-no">039</span><span id="line-39">import org.apache.hadoop.hbase.HConstants;</span> |
| <span class="source-line-no">040</span><span id="line-40">import org.apache.hadoop.hbase.ipc.RpcServer;</span> |
| <span class="source-line-no">041</span><span id="line-41">import org.apache.hadoop.hbase.security.User;</span> |
| <span class="source-line-no">042</span><span id="line-42">import org.apache.hadoop.hbase.util.CoprocessorClassLoader;</span> |
| <span class="source-line-no">043</span><span id="line-43">import org.apache.hadoop.hbase.util.SortedList;</span> |
| <span class="source-line-no">044</span><span id="line-44">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">045</span><span id="line-45">import org.slf4j.Logger;</span> |
| <span class="source-line-no">046</span><span id="line-46">import org.slf4j.LoggerFactory;</span> |
| <span class="source-line-no">047</span><span id="line-47"></span> |
| <span class="source-line-no">048</span><span id="line-48">import org.apache.hbase.thirdparty.com.google.common.base.Strings;</span> |
| <span class="source-line-no">049</span><span id="line-49"></span> |
| <span class="source-line-no">050</span><span id="line-50">/**</span> |
| <span class="source-line-no">051</span><span id="line-51"> * Provides the common setup framework and runtime services for coprocessor invocation from HBase</span> |
| <span class="source-line-no">052</span><span id="line-52"> * services.</span> |
| <span class="source-line-no">053</span><span id="line-53"> * @param <C> type of specific coprocessor this host will handle</span> |
| <span class="source-line-no">054</span><span id="line-54"> * @param <E> type of specific coprocessor environment this host requires. provides</span> |
| <span class="source-line-no">055</span><span id="line-55"> */</span> |
| <span class="source-line-no">056</span><span id="line-56">@InterfaceAudience.Private</span> |
| <span class="source-line-no">057</span><span id="line-57">public abstract class CoprocessorHost<C extends Coprocessor, E extends CoprocessorEnvironment<C>> {</span> |
| <span class="source-line-no">058</span><span id="line-58"> public static final String REGION_COPROCESSOR_CONF_KEY = "hbase.coprocessor.region.classes";</span> |
| <span class="source-line-no">059</span><span id="line-59"> public static final String REGIONSERVER_COPROCESSOR_CONF_KEY =</span> |
| <span class="source-line-no">060</span><span id="line-60"> "hbase.coprocessor.regionserver.classes";</span> |
| <span class="source-line-no">061</span><span id="line-61"> public static final String USER_REGION_COPROCESSOR_CONF_KEY =</span> |
| <span class="source-line-no">062</span><span id="line-62"> "hbase.coprocessor.user.region.classes";</span> |
| <span class="source-line-no">063</span><span id="line-63"> public static final String MASTER_COPROCESSOR_CONF_KEY = "hbase.coprocessor.master.classes";</span> |
| <span class="source-line-no">064</span><span id="line-64"> public static final String WAL_COPROCESSOR_CONF_KEY = "hbase.coprocessor.wal.classes";</span> |
| <span class="source-line-no">065</span><span id="line-65"> public static final String ABORT_ON_ERROR_KEY = "hbase.coprocessor.abortonerror";</span> |
| <span class="source-line-no">066</span><span id="line-66"> public static final boolean DEFAULT_ABORT_ON_ERROR = true;</span> |
| <span class="source-line-no">067</span><span id="line-67"> public static final String COPROCESSORS_ENABLED_CONF_KEY = "hbase.coprocessor.enabled";</span> |
| <span class="source-line-no">068</span><span id="line-68"> public static final boolean DEFAULT_COPROCESSORS_ENABLED = true;</span> |
| <span class="source-line-no">069</span><span id="line-69"> public static final String USER_COPROCESSORS_ENABLED_CONF_KEY = "hbase.coprocessor.user.enabled";</span> |
| <span class="source-line-no">070</span><span id="line-70"> public static final boolean DEFAULT_USER_COPROCESSORS_ENABLED = true;</span> |
| <span class="source-line-no">071</span><span id="line-71"> public static final String SKIP_LOAD_DUPLICATE_TABLE_COPROCESSOR =</span> |
| <span class="source-line-no">072</span><span id="line-72"> "hbase.skip.load.duplicate.table.coprocessor";</span> |
| <span class="source-line-no">073</span><span id="line-73"> public static final boolean DEFAULT_SKIP_LOAD_DUPLICATE_TABLE_COPROCESSOR = false;</span> |
| <span class="source-line-no">074</span><span id="line-74"></span> |
| <span class="source-line-no">075</span><span id="line-75"> private static final Logger LOG = LoggerFactory.getLogger(CoprocessorHost.class);</span> |
| <span class="source-line-no">076</span><span id="line-76"> protected Abortable abortable;</span> |
| <span class="source-line-no">077</span><span id="line-77"> /** Ordered set of loaded coprocessors with lock */</span> |
| <span class="source-line-no">078</span><span id="line-78"> protected final SortedList<E> coprocEnvironments =</span> |
| <span class="source-line-no">079</span><span id="line-79"> new SortedList<>(new EnvironmentPriorityComparator());</span> |
| <span class="source-line-no">080</span><span id="line-80"> protected Configuration conf;</span> |
| <span class="source-line-no">081</span><span id="line-81"> // unique file prefix to use for local copies of jars when classloading</span> |
| <span class="source-line-no">082</span><span id="line-82"> protected String pathPrefix;</span> |
| <span class="source-line-no">083</span><span id="line-83"> protected AtomicInteger loadSequence = new AtomicInteger();</span> |
| <span class="source-line-no">084</span><span id="line-84"></span> |
| <span class="source-line-no">085</span><span id="line-85"> public CoprocessorHost(Abortable abortable) {</span> |
| <span class="source-line-no">086</span><span id="line-86"> this.abortable = abortable;</span> |
| <span class="source-line-no">087</span><span id="line-87"> this.pathPrefix = UUID.randomUUID().toString();</span> |
| <span class="source-line-no">088</span><span id="line-88"> }</span> |
| <span class="source-line-no">089</span><span id="line-89"></span> |
| <span class="source-line-no">090</span><span id="line-90"> /**</span> |
| <span class="source-line-no">091</span><span id="line-91"> * Not to be confused with the per-object _coprocessors_ (above), coprocessorNames is static and</span> |
| <span class="source-line-no">092</span><span id="line-92"> * stores the set of all coprocessors ever loaded by any thread in this JVM. It is strictly</span> |
| <span class="source-line-no">093</span><span id="line-93"> * additive: coprocessors are added to coprocessorNames, by checkAndLoadInstance() but are never</span> |
| <span class="source-line-no">094</span><span id="line-94"> * removed, since the intention is to preserve a history of all loaded coprocessors for diagnosis</span> |
| <span class="source-line-no">095</span><span id="line-95"> * in case of server crash (HBASE-4014).</span> |
| <span class="source-line-no">096</span><span id="line-96"> */</span> |
| <span class="source-line-no">097</span><span id="line-97"> private static Set<String> coprocessorNames = Collections.synchronizedSet(new HashSet<String>());</span> |
| <span class="source-line-no">098</span><span id="line-98"></span> |
| <span class="source-line-no">099</span><span id="line-99"> public static Set<String> getLoadedCoprocessors() {</span> |
| <span class="source-line-no">100</span><span id="line-100"> synchronized (coprocessorNames) {</span> |
| <span class="source-line-no">101</span><span id="line-101"> return new HashSet(coprocessorNames);</span> |
| <span class="source-line-no">102</span><span id="line-102"> }</span> |
| <span class="source-line-no">103</span><span id="line-103"> }</span> |
| <span class="source-line-no">104</span><span id="line-104"></span> |
| <span class="source-line-no">105</span><span id="line-105"> /**</span> |
| <span class="source-line-no">106</span><span id="line-106"> * Used to create a parameter to the HServerLoad constructor so that HServerLoad can provide</span> |
| <span class="source-line-no">107</span><span id="line-107"> * information about the coprocessors loaded by this regionserver. (HBASE-4070: Improve region</span> |
| <span class="source-line-no">108</span><span id="line-108"> * server metrics to report loaded coprocessors to master).</span> |
| <span class="source-line-no">109</span><span id="line-109"> */</span> |
| <span class="source-line-no">110</span><span id="line-110"> public Set<String> getCoprocessors() {</span> |
| <span class="source-line-no">111</span><span id="line-111"> Set<String> returnValue = new TreeSet<>();</span> |
| <span class="source-line-no">112</span><span id="line-112"> for (E e : coprocEnvironments) {</span> |
| <span class="source-line-no">113</span><span id="line-113"> returnValue.add(e.getInstance().getClass().getSimpleName());</span> |
| <span class="source-line-no">114</span><span id="line-114"> }</span> |
| <span class="source-line-no">115</span><span id="line-115"> return returnValue;</span> |
| <span class="source-line-no">116</span><span id="line-116"> }</span> |
| <span class="source-line-no">117</span><span id="line-117"></span> |
| <span class="source-line-no">118</span><span id="line-118"> /**</span> |
| <span class="source-line-no">119</span><span id="line-119"> * Load system coprocessors once only. Read the class names from configuration. Called by</span> |
| <span class="source-line-no">120</span><span id="line-120"> * constructor.</span> |
| <span class="source-line-no">121</span><span id="line-121"> */</span> |
| <span class="source-line-no">122</span><span id="line-122"> protected void loadSystemCoprocessors(Configuration conf, String confKey) {</span> |
| <span class="source-line-no">123</span><span id="line-123"> boolean coprocessorsEnabled =</span> |
| <span class="source-line-no">124</span><span id="line-124"> conf.getBoolean(COPROCESSORS_ENABLED_CONF_KEY, DEFAULT_COPROCESSORS_ENABLED);</span> |
| <span class="source-line-no">125</span><span id="line-125"> if (!coprocessorsEnabled) {</span> |
| <span class="source-line-no">126</span><span id="line-126"> return;</span> |
| <span class="source-line-no">127</span><span id="line-127"> }</span> |
| <span class="source-line-no">128</span><span id="line-128"></span> |
| <span class="source-line-no">129</span><span id="line-129"> Class<?> implClass;</span> |
| <span class="source-line-no">130</span><span id="line-130"></span> |
| <span class="source-line-no">131</span><span id="line-131"> // load default coprocessors from configure file</span> |
| <span class="source-line-no">132</span><span id="line-132"> String[] defaultCPClasses = conf.getStrings(confKey);</span> |
| <span class="source-line-no">133</span><span id="line-133"> if (defaultCPClasses == null || defaultCPClasses.length == 0) return;</span> |
| <span class="source-line-no">134</span><span id="line-134"></span> |
| <span class="source-line-no">135</span><span id="line-135"> int currentSystemPriority = Coprocessor.PRIORITY_SYSTEM;</span> |
| <span class="source-line-no">136</span><span id="line-136"> for (String className : defaultCPClasses) {</span> |
| <span class="source-line-no">137</span><span id="line-137"> // After HBASE-23710 and HBASE-26714 when configuring for system coprocessor, we accept</span> |
| <span class="source-line-no">138</span><span id="line-138"> // an optional format of className|priority|path</span> |
| <span class="source-line-no">139</span><span id="line-139"> String[] classNameToken = className.split("\\|");</span> |
| <span class="source-line-no">140</span><span id="line-140"> boolean hasPriorityOverride = false;</span> |
| <span class="source-line-no">141</span><span id="line-141"> boolean hasPath = false;</span> |
| <span class="source-line-no">142</span><span id="line-142"> className = classNameToken[0];</span> |
| <span class="source-line-no">143</span><span id="line-143"> int overridePriority = Coprocessor.PRIORITY_SYSTEM;</span> |
| <span class="source-line-no">144</span><span id="line-144"> Path path = null;</span> |
| <span class="source-line-no">145</span><span id="line-145"> if (classNameToken.length > 1 && !Strings.isNullOrEmpty(classNameToken[1])) {</span> |
| <span class="source-line-no">146</span><span id="line-146"> overridePriority = Integer.parseInt(classNameToken[1]);</span> |
| <span class="source-line-no">147</span><span id="line-147"> hasPriorityOverride = true;</span> |
| <span class="source-line-no">148</span><span id="line-148"> }</span> |
| <span class="source-line-no">149</span><span id="line-149"> if (classNameToken.length > 2 && !Strings.isNullOrEmpty(classNameToken[2])) {</span> |
| <span class="source-line-no">150</span><span id="line-150"> path = new Path(classNameToken[2].trim());</span> |
| <span class="source-line-no">151</span><span id="line-151"> hasPath = true;</span> |
| <span class="source-line-no">152</span><span id="line-152"> }</span> |
| <span class="source-line-no">153</span><span id="line-153"> className = className.trim();</span> |
| <span class="source-line-no">154</span><span id="line-154"> if (findCoprocessor(className) != null) {</span> |
| <span class="source-line-no">155</span><span id="line-155"> // If already loaded will just continue</span> |
| <span class="source-line-no">156</span><span id="line-156"> LOG.warn("Attempted duplicate loading of " + className + "; skipped");</span> |
| <span class="source-line-no">157</span><span id="line-157"> continue;</span> |
| <span class="source-line-no">158</span><span id="line-158"> }</span> |
| <span class="source-line-no">159</span><span id="line-159"> ClassLoader cl = this.getClass().getClassLoader();</span> |
| <span class="source-line-no">160</span><span id="line-160"> try {</span> |
| <span class="source-line-no">161</span><span id="line-161"> // override the class loader if a path for the system coprocessor is provided.</span> |
| <span class="source-line-no">162</span><span id="line-162"> if (hasPath) {</span> |
| <span class="source-line-no">163</span><span id="line-163"> cl = CoprocessorClassLoader.getClassLoader(path, this.getClass().getClassLoader(),</span> |
| <span class="source-line-no">164</span><span id="line-164"> pathPrefix, conf);</span> |
| <span class="source-line-no">165</span><span id="line-165"> }</span> |
| <span class="source-line-no">166</span><span id="line-166"> Thread.currentThread().setContextClassLoader(cl);</span> |
| <span class="source-line-no">167</span><span id="line-167"> implClass = cl.loadClass(className);</span> |
| <span class="source-line-no">168</span><span id="line-168"> int coprocPriority = hasPriorityOverride ? overridePriority : currentSystemPriority;</span> |
| <span class="source-line-no">169</span><span id="line-169"> // Add coprocessors as we go to guard against case where a coprocessor is specified twice</span> |
| <span class="source-line-no">170</span><span id="line-170"> // in the configuration</span> |
| <span class="source-line-no">171</span><span id="line-171"> E env = checkAndLoadInstance(implClass, coprocPriority, conf);</span> |
| <span class="source-line-no">172</span><span id="line-172"> if (env != null) {</span> |
| <span class="source-line-no">173</span><span id="line-173"> this.coprocEnvironments.add(env);</span> |
| <span class="source-line-no">174</span><span id="line-174"> LOG.info("System coprocessor {} loaded, priority={}.", className, coprocPriority);</span> |
| <span class="source-line-no">175</span><span id="line-175"> if (!hasPriorityOverride) {</span> |
| <span class="source-line-no">176</span><span id="line-176"> ++currentSystemPriority;</span> |
| <span class="source-line-no">177</span><span id="line-177"> }</span> |
| <span class="source-line-no">178</span><span id="line-178"> }</span> |
| <span class="source-line-no">179</span><span id="line-179"> } catch (Throwable t) {</span> |
| <span class="source-line-no">180</span><span id="line-180"> // We always abort if system coprocessors cannot be loaded</span> |
| <span class="source-line-no">181</span><span id="line-181"> abortServer(className, t);</span> |
| <span class="source-line-no">182</span><span id="line-182"> }</span> |
| <span class="source-line-no">183</span><span id="line-183"> }</span> |
| <span class="source-line-no">184</span><span id="line-184"> }</span> |
| <span class="source-line-no">185</span><span id="line-185"></span> |
| <span class="source-line-no">186</span><span id="line-186"> /**</span> |
| <span class="source-line-no">187</span><span id="line-187"> * Load a coprocessor implementation into the host</span> |
| <span class="source-line-no">188</span><span id="line-188"> * @param path path to implementation jar</span> |
| <span class="source-line-no">189</span><span id="line-189"> * @param className the main class name</span> |
| <span class="source-line-no">190</span><span id="line-190"> * @param priority chaining priority</span> |
| <span class="source-line-no">191</span><span id="line-191"> * @param conf configuration for coprocessor</span> |
| <span class="source-line-no">192</span><span id="line-192"> * @throws java.io.IOException Exception</span> |
| <span class="source-line-no">193</span><span id="line-193"> */</span> |
| <span class="source-line-no">194</span><span id="line-194"> public E load(Path path, String className, int priority, Configuration conf) throws IOException {</span> |
| <span class="source-line-no">195</span><span id="line-195"> String[] includedClassPrefixes = null;</span> |
| <span class="source-line-no">196</span><span id="line-196"> if (conf.get(HConstants.CP_HTD_ATTR_INCLUSION_KEY) != null) {</span> |
| <span class="source-line-no">197</span><span id="line-197"> String prefixes = conf.get(HConstants.CP_HTD_ATTR_INCLUSION_KEY);</span> |
| <span class="source-line-no">198</span><span id="line-198"> includedClassPrefixes = prefixes.split(";");</span> |
| <span class="source-line-no">199</span><span id="line-199"> }</span> |
| <span class="source-line-no">200</span><span id="line-200"> return load(path, className, priority, conf, includedClassPrefixes);</span> |
| <span class="source-line-no">201</span><span id="line-201"> }</span> |
| <span class="source-line-no">202</span><span id="line-202"></span> |
| <span class="source-line-no">203</span><span id="line-203"> /**</span> |
| <span class="source-line-no">204</span><span id="line-204"> * Load a coprocessor implementation into the host</span> |
| <span class="source-line-no">205</span><span id="line-205"> * @param path path to implementation jar</span> |
| <span class="source-line-no">206</span><span id="line-206"> * @param className the main class name</span> |
| <span class="source-line-no">207</span><span id="line-207"> * @param priority chaining priority</span> |
| <span class="source-line-no">208</span><span id="line-208"> * @param conf configuration for coprocessor</span> |
| <span class="source-line-no">209</span><span id="line-209"> * @param includedClassPrefixes class name prefixes to include</span> |
| <span class="source-line-no">210</span><span id="line-210"> * @throws java.io.IOException Exception</span> |
| <span class="source-line-no">211</span><span id="line-211"> */</span> |
| <span class="source-line-no">212</span><span id="line-212"> public E load(Path path, String className, int priority, Configuration conf,</span> |
| <span class="source-line-no">213</span><span id="line-213"> String[] includedClassPrefixes) throws IOException {</span> |
| <span class="source-line-no">214</span><span id="line-214"> Class<?> implClass;</span> |
| <span class="source-line-no">215</span><span id="line-215"> LOG.debug("Loading coprocessor class " + className + " with path " + path + " and priority "</span> |
| <span class="source-line-no">216</span><span id="line-216"> + priority);</span> |
| <span class="source-line-no">217</span><span id="line-217"></span> |
| <span class="source-line-no">218</span><span id="line-218"> boolean skipLoadDuplicateCoprocessor = conf.getBoolean(SKIP_LOAD_DUPLICATE_TABLE_COPROCESSOR,</span> |
| <span class="source-line-no">219</span><span id="line-219"> DEFAULT_SKIP_LOAD_DUPLICATE_TABLE_COPROCESSOR);</span> |
| <span class="source-line-no">220</span><span id="line-220"> if (skipLoadDuplicateCoprocessor && findCoprocessor(className) != null) {</span> |
| <span class="source-line-no">221</span><span id="line-221"> // If already loaded will just continue</span> |
| <span class="source-line-no">222</span><span id="line-222"> LOG.warn("Attempted duplicate loading of {}; skipped", className);</span> |
| <span class="source-line-no">223</span><span id="line-223"> return null;</span> |
| <span class="source-line-no">224</span><span id="line-224"> }</span> |
| <span class="source-line-no">225</span><span id="line-225"></span> |
| <span class="source-line-no">226</span><span id="line-226"> ClassLoader cl = null;</span> |
| <span class="source-line-no">227</span><span id="line-227"> if (path == null) {</span> |
| <span class="source-line-no">228</span><span id="line-228"> try {</span> |
| <span class="source-line-no">229</span><span id="line-229"> implClass = getClass().getClassLoader().loadClass(className);</span> |
| <span class="source-line-no">230</span><span id="line-230"> } catch (ClassNotFoundException e) {</span> |
| <span class="source-line-no">231</span><span id="line-231"> throw new IOException("No jar path specified for " + className);</span> |
| <span class="source-line-no">232</span><span id="line-232"> }</span> |
| <span class="source-line-no">233</span><span id="line-233"> } else {</span> |
| <span class="source-line-no">234</span><span id="line-234"> cl =</span> |
| <span class="source-line-no">235</span><span id="line-235"> CoprocessorClassLoader.getClassLoader(path, getClass().getClassLoader(), pathPrefix, conf);</span> |
| <span class="source-line-no">236</span><span id="line-236"> try {</span> |
| <span class="source-line-no">237</span><span id="line-237"> implClass = ((CoprocessorClassLoader) cl).loadClass(className, includedClassPrefixes);</span> |
| <span class="source-line-no">238</span><span id="line-238"> } catch (ClassNotFoundException e) {</span> |
| <span class="source-line-no">239</span><span id="line-239"> throw new IOException("Cannot load external coprocessor class " + className, e);</span> |
| <span class="source-line-no">240</span><span id="line-240"> }</span> |
| <span class="source-line-no">241</span><span id="line-241"> }</span> |
| <span class="source-line-no">242</span><span id="line-242"></span> |
| <span class="source-line-no">243</span><span id="line-243"> // load custom code for coprocessor</span> |
| <span class="source-line-no">244</span><span id="line-244"> Thread currentThread = Thread.currentThread();</span> |
| <span class="source-line-no">245</span><span id="line-245"> ClassLoader hostClassLoader = currentThread.getContextClassLoader();</span> |
| <span class="source-line-no">246</span><span id="line-246"> try {</span> |
| <span class="source-line-no">247</span><span id="line-247"> // switch temporarily to the thread classloader for custom CP</span> |
| <span class="source-line-no">248</span><span id="line-248"> currentThread.setContextClassLoader(cl);</span> |
| <span class="source-line-no">249</span><span id="line-249"> E cpInstance = checkAndLoadInstance(implClass, priority, conf);</span> |
| <span class="source-line-no">250</span><span id="line-250"> return cpInstance;</span> |
| <span class="source-line-no">251</span><span id="line-251"> } finally {</span> |
| <span class="source-line-no">252</span><span id="line-252"> // restore the fresh (host) classloader</span> |
| <span class="source-line-no">253</span><span id="line-253"> currentThread.setContextClassLoader(hostClassLoader);</span> |
| <span class="source-line-no">254</span><span id="line-254"> }</span> |
| <span class="source-line-no">255</span><span id="line-255"> }</span> |
| <span class="source-line-no">256</span><span id="line-256"></span> |
| <span class="source-line-no">257</span><span id="line-257"> public void load(Class<? extends C> implClass, int priority, Configuration conf)</span> |
| <span class="source-line-no">258</span><span id="line-258"> throws IOException {</span> |
| <span class="source-line-no">259</span><span id="line-259"> E env = checkAndLoadInstance(implClass, priority, conf);</span> |
| <span class="source-line-no">260</span><span id="line-260"> coprocEnvironments.add(env);</span> |
| <span class="source-line-no">261</span><span id="line-261"> }</span> |
| <span class="source-line-no">262</span><span id="line-262"></span> |
| <span class="source-line-no">263</span><span id="line-263"> /**</span> |
| <span class="source-line-no">264</span><span id="line-264"> * @param implClass Implementation class</span> |
| <span class="source-line-no">265</span><span id="line-265"> * @param priority priority</span> |
| <span class="source-line-no">266</span><span id="line-266"> * @param conf configuration</span> |
| <span class="source-line-no">267</span><span id="line-267"> * @throws java.io.IOException Exception</span> |
| <span class="source-line-no">268</span><span id="line-268"> */</span> |
| <span class="source-line-no">269</span><span id="line-269"> public E checkAndLoadInstance(Class<?> implClass, int priority, Configuration conf)</span> |
| <span class="source-line-no">270</span><span id="line-270"> throws IOException {</span> |
| <span class="source-line-no">271</span><span id="line-271"> // create the instance</span> |
| <span class="source-line-no">272</span><span id="line-272"> C impl;</span> |
| <span class="source-line-no">273</span><span id="line-273"> try {</span> |
| <span class="source-line-no">274</span><span id="line-274"> impl = checkAndGetInstance(implClass);</span> |
| <span class="source-line-no">275</span><span id="line-275"> if (impl == null) {</span> |
| <span class="source-line-no">276</span><span id="line-276"> LOG.error("Cannot load coprocessor " + implClass.getSimpleName());</span> |
| <span class="source-line-no">277</span><span id="line-277"> return null;</span> |
| <span class="source-line-no">278</span><span id="line-278"> }</span> |
| <span class="source-line-no">279</span><span id="line-279"> } catch (InstantiationException | IllegalAccessException e) {</span> |
| <span class="source-line-no">280</span><span id="line-280"> throw new IOException(e);</span> |
| <span class="source-line-no">281</span><span id="line-281"> }</span> |
| <span class="source-line-no">282</span><span id="line-282"> // create the environment</span> |
| <span class="source-line-no">283</span><span id="line-283"> E env = createEnvironment(impl, priority, loadSequence.incrementAndGet(), conf);</span> |
| <span class="source-line-no">284</span><span id="line-284"> assert env instanceof BaseEnvironment;</span> |
| <span class="source-line-no">285</span><span id="line-285"> ((BaseEnvironment<C>) env).startup();</span> |
| <span class="source-line-no">286</span><span id="line-286"> // HBASE-4014: maintain list of loaded coprocessors for later crash analysis</span> |
| <span class="source-line-no">287</span><span id="line-287"> // if server (master or regionserver) aborts.</span> |
| <span class="source-line-no">288</span><span id="line-288"> coprocessorNames.add(implClass.getName());</span> |
| <span class="source-line-no">289</span><span id="line-289"> return env;</span> |
| <span class="source-line-no">290</span><span id="line-290"> }</span> |
| <span class="source-line-no">291</span><span id="line-291"></span> |
| <span class="source-line-no">292</span><span id="line-292"> /**</span> |
| <span class="source-line-no">293</span><span id="line-293"> * Called when a new Coprocessor class is loaded</span> |
| <span class="source-line-no">294</span><span id="line-294"> */</span> |
| <span class="source-line-no">295</span><span id="line-295"> public abstract E createEnvironment(C instance, int priority, int sequence, Configuration conf);</span> |
| <span class="source-line-no">296</span><span id="line-296"></span> |
| <span class="source-line-no">297</span><span id="line-297"> /**</span> |
| <span class="source-line-no">298</span><span id="line-298"> * Called when a new Coprocessor class needs to be loaded. Checks if type of the given class is</span> |
| <span class="source-line-no">299</span><span id="line-299"> * what the corresponding host implementation expects. If it is of correct type, returns an</span> |
| <span class="source-line-no">300</span><span id="line-300"> * instance of the coprocessor to be loaded. If not, returns null. If an exception occurs when</span> |
| <span class="source-line-no">301</span><span id="line-301"> * trying to create instance of a coprocessor, it's passed up and eventually results into server</span> |
| <span class="source-line-no">302</span><span id="line-302"> * aborting.</span> |
| <span class="source-line-no">303</span><span id="line-303"> */</span> |
| <span class="source-line-no">304</span><span id="line-304"> public abstract C checkAndGetInstance(Class<?> implClass)</span> |
| <span class="source-line-no">305</span><span id="line-305"> throws InstantiationException, IllegalAccessException;</span> |
| <span class="source-line-no">306</span><span id="line-306"></span> |
| <span class="source-line-no">307</span><span id="line-307"> public void shutdown(E e) {</span> |
| <span class="source-line-no">308</span><span id="line-308"> assert e instanceof BaseEnvironment;</span> |
| <span class="source-line-no">309</span><span id="line-309"> if (LOG.isDebugEnabled()) {</span> |
| <span class="source-line-no">310</span><span id="line-310"> LOG.debug("Stop coprocessor " + e.getInstance().getClass().getName());</span> |
| <span class="source-line-no">311</span><span id="line-311"> }</span> |
| <span class="source-line-no">312</span><span id="line-312"> ((BaseEnvironment<C>) e).shutdown();</span> |
| <span class="source-line-no">313</span><span id="line-313"> }</span> |
| <span class="source-line-no">314</span><span id="line-314"></span> |
| <span class="source-line-no">315</span><span id="line-315"> /**</span> |
| <span class="source-line-no">316</span><span id="line-316"> * Find coprocessors by full class name or simple name.</span> |
| <span class="source-line-no">317</span><span id="line-317"> */</span> |
| <span class="source-line-no">318</span><span id="line-318"> public C findCoprocessor(String className) {</span> |
| <span class="source-line-no">319</span><span id="line-319"> for (E env : coprocEnvironments) {</span> |
| <span class="source-line-no">320</span><span id="line-320"> if (</span> |
| <span class="source-line-no">321</span><span id="line-321"> env.getInstance().getClass().getName().equals(className)</span> |
| <span class="source-line-no">322</span><span id="line-322"> || env.getInstance().getClass().getSimpleName().equals(className)</span> |
| <span class="source-line-no">323</span><span id="line-323"> ) {</span> |
| <span class="source-line-no">324</span><span id="line-324"> return env.getInstance();</span> |
| <span class="source-line-no">325</span><span id="line-325"> }</span> |
| <span class="source-line-no">326</span><span id="line-326"> }</span> |
| <span class="source-line-no">327</span><span id="line-327"> return null;</span> |
| <span class="source-line-no">328</span><span id="line-328"> }</span> |
| <span class="source-line-no">329</span><span id="line-329"></span> |
| <span class="source-line-no">330</span><span id="line-330"> public <T extends C> T findCoprocessor(Class<T> cls) {</span> |
| <span class="source-line-no">331</span><span id="line-331"> for (E env : coprocEnvironments) {</span> |
| <span class="source-line-no">332</span><span id="line-332"> if (cls.isAssignableFrom(env.getInstance().getClass())) {</span> |
| <span class="source-line-no">333</span><span id="line-333"> return (T) env.getInstance();</span> |
| <span class="source-line-no">334</span><span id="line-334"> }</span> |
| <span class="source-line-no">335</span><span id="line-335"> }</span> |
| <span class="source-line-no">336</span><span id="line-336"> return null;</span> |
| <span class="source-line-no">337</span><span id="line-337"> }</span> |
| <span class="source-line-no">338</span><span id="line-338"></span> |
| <span class="source-line-no">339</span><span id="line-339"> /**</span> |
| <span class="source-line-no">340</span><span id="line-340"> * Find list of coprocessors that extend/implement the given class/interface</span> |
| <span class="source-line-no">341</span><span id="line-341"> * @param cls the class/interface to look for</span> |
| <span class="source-line-no">342</span><span id="line-342"> * @return the list of coprocessors, or null if not found</span> |
| <span class="source-line-no">343</span><span id="line-343"> */</span> |
| <span class="source-line-no">344</span><span id="line-344"> public <T extends C> List<T> findCoprocessors(Class<T> cls) {</span> |
| <span class="source-line-no">345</span><span id="line-345"> ArrayList<T> ret = new ArrayList<>();</span> |
| <span class="source-line-no">346</span><span id="line-346"></span> |
| <span class="source-line-no">347</span><span id="line-347"> for (E env : coprocEnvironments) {</span> |
| <span class="source-line-no">348</span><span id="line-348"> C cp = env.getInstance();</span> |
| <span class="source-line-no">349</span><span id="line-349"></span> |
| <span class="source-line-no">350</span><span id="line-350"> if (cp != null) {</span> |
| <span class="source-line-no">351</span><span id="line-351"> if (cls.isAssignableFrom(cp.getClass())) {</span> |
| <span class="source-line-no">352</span><span id="line-352"> ret.add((T) cp);</span> |
| <span class="source-line-no">353</span><span id="line-353"> }</span> |
| <span class="source-line-no">354</span><span id="line-354"> }</span> |
| <span class="source-line-no">355</span><span id="line-355"> }</span> |
| <span class="source-line-no">356</span><span id="line-356"> return ret;</span> |
| <span class="source-line-no">357</span><span id="line-357"> }</span> |
| <span class="source-line-no">358</span><span id="line-358"></span> |
| <span class="source-line-no">359</span><span id="line-359"> /**</span> |
| <span class="source-line-no">360</span><span id="line-360"> * Find a coprocessor environment by class name</span> |
| <span class="source-line-no">361</span><span id="line-361"> * @param className the class name</span> |
| <span class="source-line-no">362</span><span id="line-362"> * @return the coprocessor, or null if not found</span> |
| <span class="source-line-no">363</span><span id="line-363"> */</span> |
| <span class="source-line-no">364</span><span id="line-364"> public E findCoprocessorEnvironment(String className) {</span> |
| <span class="source-line-no">365</span><span id="line-365"> for (E env : coprocEnvironments) {</span> |
| <span class="source-line-no">366</span><span id="line-366"> if (</span> |
| <span class="source-line-no">367</span><span id="line-367"> env.getInstance().getClass().getName().equals(className)</span> |
| <span class="source-line-no">368</span><span id="line-368"> || env.getInstance().getClass().getSimpleName().equals(className)</span> |
| <span class="source-line-no">369</span><span id="line-369"> ) {</span> |
| <span class="source-line-no">370</span><span id="line-370"> return env;</span> |
| <span class="source-line-no">371</span><span id="line-371"> }</span> |
| <span class="source-line-no">372</span><span id="line-372"> }</span> |
| <span class="source-line-no">373</span><span id="line-373"> return null;</span> |
| <span class="source-line-no">374</span><span id="line-374"> }</span> |
| <span class="source-line-no">375</span><span id="line-375"></span> |
| <span class="source-line-no">376</span><span id="line-376"> /**</span> |
| <span class="source-line-no">377</span><span id="line-377"> * Retrieves the set of classloaders used to instantiate Coprocessor classes defined in external</span> |
| <span class="source-line-no">378</span><span id="line-378"> * jar files.</span> |
| <span class="source-line-no">379</span><span id="line-379"> * @return A set of ClassLoader instances</span> |
| <span class="source-line-no">380</span><span id="line-380"> */</span> |
| <span class="source-line-no">381</span><span id="line-381"> Set<ClassLoader> getExternalClassLoaders() {</span> |
| <span class="source-line-no">382</span><span id="line-382"> Set<ClassLoader> externalClassLoaders = new HashSet<>();</span> |
| <span class="source-line-no">383</span><span id="line-383"> final ClassLoader systemClassLoader = this.getClass().getClassLoader();</span> |
| <span class="source-line-no">384</span><span id="line-384"> for (E env : coprocEnvironments) {</span> |
| <span class="source-line-no">385</span><span id="line-385"> ClassLoader cl = env.getInstance().getClass().getClassLoader();</span> |
| <span class="source-line-no">386</span><span id="line-386"> if (cl != systemClassLoader) {</span> |
| <span class="source-line-no">387</span><span id="line-387"> // do not include system classloader</span> |
| <span class="source-line-no">388</span><span id="line-388"> externalClassLoaders.add(cl);</span> |
| <span class="source-line-no">389</span><span id="line-389"> }</span> |
| <span class="source-line-no">390</span><span id="line-390"> }</span> |
| <span class="source-line-no">391</span><span id="line-391"> return externalClassLoaders;</span> |
| <span class="source-line-no">392</span><span id="line-392"> }</span> |
| <span class="source-line-no">393</span><span id="line-393"></span> |
| <span class="source-line-no">394</span><span id="line-394"> /**</span> |
| <span class="source-line-no">395</span><span id="line-395"> * Environment priority comparator. Coprocessors are chained in sorted order.</span> |
| <span class="source-line-no">396</span><span id="line-396"> */</span> |
| <span class="source-line-no">397</span><span id="line-397"> static class EnvironmentPriorityComparator implements Comparator<CoprocessorEnvironment> {</span> |
| <span class="source-line-no">398</span><span id="line-398"> @Override</span> |
| <span class="source-line-no">399</span><span id="line-399"> public int compare(final CoprocessorEnvironment env1, final CoprocessorEnvironment env2) {</span> |
| <span class="source-line-no">400</span><span id="line-400"> if (env1.getPriority() < env2.getPriority()) {</span> |
| <span class="source-line-no">401</span><span id="line-401"> return -1;</span> |
| <span class="source-line-no">402</span><span id="line-402"> } else if (env1.getPriority() > env2.getPriority()) {</span> |
| <span class="source-line-no">403</span><span id="line-403"> return 1;</span> |
| <span class="source-line-no">404</span><span id="line-404"> }</span> |
| <span class="source-line-no">405</span><span id="line-405"> if (env1.getLoadSequence() < env2.getLoadSequence()) {</span> |
| <span class="source-line-no">406</span><span id="line-406"> return -1;</span> |
| <span class="source-line-no">407</span><span id="line-407"> } else if (env1.getLoadSequence() > env2.getLoadSequence()) {</span> |
| <span class="source-line-no">408</span><span id="line-408"> return 1;</span> |
| <span class="source-line-no">409</span><span id="line-409"> }</span> |
| <span class="source-line-no">410</span><span id="line-410"> return 0;</span> |
| <span class="source-line-no">411</span><span id="line-411"> }</span> |
| <span class="source-line-no">412</span><span id="line-412"> }</span> |
| <span class="source-line-no">413</span><span id="line-413"></span> |
| <span class="source-line-no">414</span><span id="line-414"> protected void abortServer(final E environment, final Throwable e) {</span> |
| <span class="source-line-no">415</span><span id="line-415"> abortServer(environment.getInstance().getClass().getName(), e);</span> |
| <span class="source-line-no">416</span><span id="line-416"> }</span> |
| <span class="source-line-no">417</span><span id="line-417"></span> |
| <span class="source-line-no">418</span><span id="line-418"> protected void abortServer(final String coprocessorName, final Throwable e) {</span> |
| <span class="source-line-no">419</span><span id="line-419"> String message = "The coprocessor " + coprocessorName + " threw " + e.toString();</span> |
| <span class="source-line-no">420</span><span id="line-420"> LOG.error(message, e);</span> |
| <span class="source-line-no">421</span><span id="line-421"> if (abortable != null) {</span> |
| <span class="source-line-no">422</span><span id="line-422"> abortable.abort(message, e);</span> |
| <span class="source-line-no">423</span><span id="line-423"> } else {</span> |
| <span class="source-line-no">424</span><span id="line-424"> LOG.warn("No available Abortable, process was not aborted");</span> |
| <span class="source-line-no">425</span><span id="line-425"> }</span> |
| <span class="source-line-no">426</span><span id="line-426"> }</span> |
| <span class="source-line-no">427</span><span id="line-427"></span> |
| <span class="source-line-no">428</span><span id="line-428"> /**</span> |
| <span class="source-line-no">429</span><span id="line-429"> * This is used by coprocessor hooks which are declared to throw IOException (or its subtypes).</span> |
| <span class="source-line-no">430</span><span id="line-430"> * For such hooks, we should handle throwable objects depending on the Throwable's type. Those</span> |
| <span class="source-line-no">431</span><span id="line-431"> * which are instances of IOException should be passed on to the client. This is in conformance</span> |
| <span class="source-line-no">432</span><span id="line-432"> * with the HBase idiom regarding IOException: that it represents a circumstance that should be</span> |
| <span class="source-line-no">433</span><span id="line-433"> * passed along to the client for its own handling. For example, a coprocessor that implements</span> |
| <span class="source-line-no">434</span><span id="line-434"> * access controls would throw a subclass of IOException, such as AccessDeniedException, in its</span> |
| <span class="source-line-no">435</span><span id="line-435"> * preGet() method to prevent an unauthorized client's performing a Get on a particular table.</span> |
| <span class="source-line-no">436</span><span id="line-436"> * @param env Coprocessor Environment</span> |
| <span class="source-line-no">437</span><span id="line-437"> * @param e Throwable object thrown by coprocessor.</span> |
| <span class="source-line-no">438</span><span id="line-438"> * @exception IOException Exception</span> |
| <span class="source-line-no">439</span><span id="line-439"> */</span> |
| <span class="source-line-no">440</span><span id="line-440"> // Note to devs: Class comments of all observers ({@link MasterObserver}, {@link WALObserver},</span> |
| <span class="source-line-no">441</span><span id="line-441"> // etc) mention this nuance of our exception handling so that coprocessor can throw appropriate</span> |
| <span class="source-line-no">442</span><span id="line-442"> // exceptions depending on situation. If any changes are made to this logic, make sure to</span> |
| <span class="source-line-no">443</span><span id="line-443"> // update all classes' comments.</span> |
| <span class="source-line-no">444</span><span id="line-444"> protected void handleCoprocessorThrowable(final E env, final Throwable e) throws IOException {</span> |
| <span class="source-line-no">445</span><span id="line-445"> if (e instanceof IOException) {</span> |
| <span class="source-line-no">446</span><span id="line-446"> throw (IOException) e;</span> |
| <span class="source-line-no">447</span><span id="line-447"> }</span> |
| <span class="source-line-no">448</span><span id="line-448"> // If we got here, e is not an IOException. A loaded coprocessor has a</span> |
| <span class="source-line-no">449</span><span id="line-449"> // fatal bug, and the server (master or regionserver) should remove the</span> |
| <span class="source-line-no">450</span><span id="line-450"> // faulty coprocessor from its set of active coprocessors. Setting</span> |
| <span class="source-line-no">451</span><span id="line-451"> // 'hbase.coprocessor.abortonerror' to true will cause abortServer(),</span> |
| <span class="source-line-no">452</span><span id="line-452"> // which may be useful in development and testing environments where</span> |
| <span class="source-line-no">453</span><span id="line-453"> // 'failing fast' for error analysis is desired.</span> |
| <span class="source-line-no">454</span><span id="line-454"> if (env.getConfiguration().getBoolean(ABORT_ON_ERROR_KEY, DEFAULT_ABORT_ON_ERROR)) {</span> |
| <span class="source-line-no">455</span><span id="line-455"> // server is configured to abort.</span> |
| <span class="source-line-no">456</span><span id="line-456"> abortServer(env, e);</span> |
| <span class="source-line-no">457</span><span id="line-457"> } else {</span> |
| <span class="source-line-no">458</span><span id="line-458"> // If available, pull a table name out of the environment</span> |
| <span class="source-line-no">459</span><span id="line-459"> if (env instanceof RegionCoprocessorEnvironment) {</span> |
| <span class="source-line-no">460</span><span id="line-460"> String tableName =</span> |
| <span class="source-line-no">461</span><span id="line-461"> ((RegionCoprocessorEnvironment) env).getRegionInfo().getTable().getNameAsString();</span> |
| <span class="source-line-no">462</span><span id="line-462"> LOG.error("Removing coprocessor '" + env.toString() + "' from table '" + tableName + "'",</span> |
| <span class="source-line-no">463</span><span id="line-463"> e);</span> |
| <span class="source-line-no">464</span><span id="line-464"> } else {</span> |
| <span class="source-line-no">465</span><span id="line-465"> LOG.error("Removing coprocessor '" + env.toString() + "' from " + "environment", e);</span> |
| <span class="source-line-no">466</span><span id="line-466"> }</span> |
| <span class="source-line-no">467</span><span id="line-467"></span> |
| <span class="source-line-no">468</span><span id="line-468"> coprocEnvironments.remove(env);</span> |
| <span class="source-line-no">469</span><span id="line-469"> try {</span> |
| <span class="source-line-no">470</span><span id="line-470"> shutdown(env);</span> |
| <span class="source-line-no">471</span><span id="line-471"> } catch (Exception x) {</span> |
| <span class="source-line-no">472</span><span id="line-472"> LOG.error("Uncaught exception when shutting down coprocessor '" + env.toString() + "'", x);</span> |
| <span class="source-line-no">473</span><span id="line-473"> }</span> |
| <span class="source-line-no">474</span><span id="line-474"> throw new DoNotRetryIOException("Coprocessor: '" + env.toString() + "' threw: '" + e</span> |
| <span class="source-line-no">475</span><span id="line-475"> + "' and has been removed from the active " + "coprocessor set.", e);</span> |
| <span class="source-line-no">476</span><span id="line-476"> }</span> |
| <span class="source-line-no">477</span><span id="line-477"> }</span> |
| <span class="source-line-no">478</span><span id="line-478"></span> |
| <span class="source-line-no">479</span><span id="line-479"> /**</span> |
| <span class="source-line-no">480</span><span id="line-480"> * Used to limit legacy handling to once per Coprocessor class per classloader.</span> |
| <span class="source-line-no">481</span><span id="line-481"> */</span> |
| <span class="source-line-no">482</span><span id="line-482"> private static final Set<Class<? extends Coprocessor>> legacyWarning =</span> |
| <span class="source-line-no">483</span><span id="line-483"> new ConcurrentSkipListSet<>(new Comparator<Class<? extends Coprocessor>>() {</span> |
| <span class="source-line-no">484</span><span id="line-484"> @Override</span> |
| <span class="source-line-no">485</span><span id="line-485"> public int compare(Class<? extends Coprocessor> c1, Class<? extends Coprocessor> c2) {</span> |
| <span class="source-line-no">486</span><span id="line-486"> if (c1.equals(c2)) {</span> |
| <span class="source-line-no">487</span><span id="line-487"> return 0;</span> |
| <span class="source-line-no">488</span><span id="line-488"> }</span> |
| <span class="source-line-no">489</span><span id="line-489"> return c1.getName().compareTo(c2.getName());</span> |
| <span class="source-line-no">490</span><span id="line-490"> }</span> |
| <span class="source-line-no">491</span><span id="line-491"> });</span> |
| <span class="source-line-no">492</span><span id="line-492"></span> |
| <span class="source-line-no">493</span><span id="line-493"> /**</span> |
| <span class="source-line-no">494</span><span id="line-494"> * Implementations defined function to get an observer of type {@code O} from a coprocessor of</span> |
| <span class="source-line-no">495</span><span id="line-495"> * type {@code C}. Concrete implementations of CoprocessorHost define one getter for each observer</span> |
| <span class="source-line-no">496</span><span id="line-496"> * they can handle. For e.g. RegionCoprocessorHost will use 3 getters, one for each of</span> |
| <span class="source-line-no">497</span><span id="line-497"> * RegionObserver, EndpointObserver and BulkLoadObserver. These getters are used by</span> |
| <span class="source-line-no">498</span><span id="line-498"> * {@code ObserverOperation} to get appropriate observer from the coprocessor.</span> |
| <span class="source-line-no">499</span><span id="line-499"> */</span> |
| <span class="source-line-no">500</span><span id="line-500"> @FunctionalInterface</span> |
| <span class="source-line-no">501</span><span id="line-501"> public interface ObserverGetter<C, O> extends Function<C, Optional<O>> {</span> |
| <span class="source-line-no">502</span><span id="line-502"> }</span> |
| <span class="source-line-no">503</span><span id="line-503"></span> |
| <span class="source-line-no">504</span><span id="line-504"> private abstract class ObserverOperation<O> extends ObserverContextImpl<E> {</span> |
| <span class="source-line-no">505</span><span id="line-505"> ObserverGetter<C, O> observerGetter;</span> |
| <span class="source-line-no">506</span><span id="line-506"></span> |
| <span class="source-line-no">507</span><span id="line-507"> ObserverOperation(ObserverGetter<C, O> observerGetter) {</span> |
| <span class="source-line-no">508</span><span id="line-508"> this(observerGetter, null);</span> |
| <span class="source-line-no">509</span><span id="line-509"> }</span> |
| <span class="source-line-no">510</span><span id="line-510"></span> |
| <span class="source-line-no">511</span><span id="line-511"> ObserverOperation(ObserverGetter<C, O> observerGetter, User user) {</span> |
| <span class="source-line-no">512</span><span id="line-512"> this(observerGetter, user, false);</span> |
| <span class="source-line-no">513</span><span id="line-513"> }</span> |
| <span class="source-line-no">514</span><span id="line-514"></span> |
| <span class="source-line-no">515</span><span id="line-515"> ObserverOperation(ObserverGetter<C, O> observerGetter, boolean bypassable) {</span> |
| <span class="source-line-no">516</span><span id="line-516"> this(observerGetter, null, bypassable);</span> |
| <span class="source-line-no">517</span><span id="line-517"> }</span> |
| <span class="source-line-no">518</span><span id="line-518"></span> |
| <span class="source-line-no">519</span><span id="line-519"> ObserverOperation(ObserverGetter<C, O> observerGetter, User user, boolean bypassable) {</span> |
| <span class="source-line-no">520</span><span id="line-520"> super(user != null ? user : RpcServer.getRequestUser().orElse(null), bypassable);</span> |
| <span class="source-line-no">521</span><span id="line-521"> this.observerGetter = observerGetter;</span> |
| <span class="source-line-no">522</span><span id="line-522"> }</span> |
| <span class="source-line-no">523</span><span id="line-523"></span> |
| <span class="source-line-no">524</span><span id="line-524"> abstract void callObserver() throws IOException;</span> |
| <span class="source-line-no">525</span><span id="line-525"></span> |
| <span class="source-line-no">526</span><span id="line-526"> protected void postEnvCall() {</span> |
| <span class="source-line-no">527</span><span id="line-527"> }</span> |
| <span class="source-line-no">528</span><span id="line-528"> }</span> |
| <span class="source-line-no">529</span><span id="line-529"></span> |
| <span class="source-line-no">530</span><span id="line-530"> // Can't derive ObserverOperation from ObserverOperationWithResult (R = Void) because then all</span> |
| <span class="source-line-no">531</span><span id="line-531"> // ObserverCaller implementations will have to have a return statement.</span> |
| <span class="source-line-no">532</span><span id="line-532"> // O = observer, E = environment, C = coprocessor, R=result type</span> |
| <span class="source-line-no">533</span><span id="line-533"> public abstract class ObserverOperationWithoutResult<O> extends ObserverOperation<O> {</span> |
| <span class="source-line-no">534</span><span id="line-534"> protected abstract void call(O observer) throws IOException;</span> |
| <span class="source-line-no">535</span><span id="line-535"></span> |
| <span class="source-line-no">536</span><span id="line-536"> public ObserverOperationWithoutResult(ObserverGetter<C, O> observerGetter) {</span> |
| <span class="source-line-no">537</span><span id="line-537"> super(observerGetter);</span> |
| <span class="source-line-no">538</span><span id="line-538"> }</span> |
| <span class="source-line-no">539</span><span id="line-539"></span> |
| <span class="source-line-no">540</span><span id="line-540"> public ObserverOperationWithoutResult(ObserverGetter<C, O> observerGetter, User user) {</span> |
| <span class="source-line-no">541</span><span id="line-541"> super(observerGetter, user);</span> |
| <span class="source-line-no">542</span><span id="line-542"> }</span> |
| <span class="source-line-no">543</span><span id="line-543"></span> |
| <span class="source-line-no">544</span><span id="line-544"> public ObserverOperationWithoutResult(ObserverGetter<C, O> observerGetter, User user,</span> |
| <span class="source-line-no">545</span><span id="line-545"> boolean bypassable) {</span> |
| <span class="source-line-no">546</span><span id="line-546"> super(observerGetter, user, bypassable);</span> |
| <span class="source-line-no">547</span><span id="line-547"> }</span> |
| <span class="source-line-no">548</span><span id="line-548"></span> |
| <span class="source-line-no">549</span><span id="line-549"> /**</span> |
| <span class="source-line-no">550</span><span id="line-550"> * In case of coprocessors which have many kinds of observers (for eg, {@link RegionCoprocessor}</span> |
| <span class="source-line-no">551</span><span id="line-551"> * has BulkLoadObserver, RegionObserver, etc), some implementations may not need all observers,</span> |
| <span class="source-line-no">552</span><span id="line-552"> * in which case they will return null for that observer's getter. We simply ignore such cases.</span> |
| <span class="source-line-no">553</span><span id="line-553"> */</span> |
| <span class="source-line-no">554</span><span id="line-554"> @Override</span> |
| <span class="source-line-no">555</span><span id="line-555"> void callObserver() throws IOException {</span> |
| <span class="source-line-no">556</span><span id="line-556"> Optional<O> observer = observerGetter.apply(getEnvironment().getInstance());</span> |
| <span class="source-line-no">557</span><span id="line-557"> if (observer.isPresent()) {</span> |
| <span class="source-line-no">558</span><span id="line-558"> call(observer.get());</span> |
| <span class="source-line-no">559</span><span id="line-559"> }</span> |
| <span class="source-line-no">560</span><span id="line-560"> }</span> |
| <span class="source-line-no">561</span><span id="line-561"> }</span> |
| <span class="source-line-no">562</span><span id="line-562"></span> |
| <span class="source-line-no">563</span><span id="line-563"> public abstract class ObserverOperationWithResult<O, R> extends ObserverOperation<O> {</span> |
| <span class="source-line-no">564</span><span id="line-564"> protected abstract R call(O observer) throws IOException;</span> |
| <span class="source-line-no">565</span><span id="line-565"></span> |
| <span class="source-line-no">566</span><span id="line-566"> private R result;</span> |
| <span class="source-line-no">567</span><span id="line-567"></span> |
| <span class="source-line-no">568</span><span id="line-568"> public ObserverOperationWithResult(ObserverGetter<C, O> observerGetter, R result) {</span> |
| <span class="source-line-no">569</span><span id="line-569"> this(observerGetter, result, false);</span> |
| <span class="source-line-no">570</span><span id="line-570"> }</span> |
| <span class="source-line-no">571</span><span id="line-571"></span> |
| <span class="source-line-no">572</span><span id="line-572"> public ObserverOperationWithResult(ObserverGetter<C, O> observerGetter, R result,</span> |
| <span class="source-line-no">573</span><span id="line-573"> boolean bypassable) {</span> |
| <span class="source-line-no">574</span><span id="line-574"> this(observerGetter, result, null, bypassable);</span> |
| <span class="source-line-no">575</span><span id="line-575"> }</span> |
| <span class="source-line-no">576</span><span id="line-576"></span> |
| <span class="source-line-no">577</span><span id="line-577"> public ObserverOperationWithResult(ObserverGetter<C, O> observerGetter, R result, User user) {</span> |
| <span class="source-line-no">578</span><span id="line-578"> this(observerGetter, result, user, false);</span> |
| <span class="source-line-no">579</span><span id="line-579"> }</span> |
| <span class="source-line-no">580</span><span id="line-580"></span> |
| <span class="source-line-no">581</span><span id="line-581"> private ObserverOperationWithResult(ObserverGetter<C, O> observerGetter, R result, User user,</span> |
| <span class="source-line-no">582</span><span id="line-582"> boolean bypassable) {</span> |
| <span class="source-line-no">583</span><span id="line-583"> super(observerGetter, user, bypassable);</span> |
| <span class="source-line-no">584</span><span id="line-584"> this.result = result;</span> |
| <span class="source-line-no">585</span><span id="line-585"> }</span> |
| <span class="source-line-no">586</span><span id="line-586"></span> |
| <span class="source-line-no">587</span><span id="line-587"> protected R getResult() {</span> |
| <span class="source-line-no">588</span><span id="line-588"> return this.result;</span> |
| <span class="source-line-no">589</span><span id="line-589"> }</span> |
| <span class="source-line-no">590</span><span id="line-590"></span> |
| <span class="source-line-no">591</span><span id="line-591"> @Override</span> |
| <span class="source-line-no">592</span><span id="line-592"> void callObserver() throws IOException {</span> |
| <span class="source-line-no">593</span><span id="line-593"> Optional<O> observer = observerGetter.apply(getEnvironment().getInstance());</span> |
| <span class="source-line-no">594</span><span id="line-594"> if (observer.isPresent()) {</span> |
| <span class="source-line-no">595</span><span id="line-595"> result = call(observer.get());</span> |
| <span class="source-line-no">596</span><span id="line-596"> }</span> |
| <span class="source-line-no">597</span><span id="line-597"> }</span> |
| <span class="source-line-no">598</span><span id="line-598"> }</span> |
| <span class="source-line-no">599</span><span id="line-599"></span> |
| <span class="source-line-no">600</span><span id="line-600"> //////////////////////////////////////////////////////////////////////////////////////////</span> |
| <span class="source-line-no">601</span><span id="line-601"> // Functions to execute observer hooks and handle results (if any)</span> |
| <span class="source-line-no">602</span><span id="line-602"> //////////////////////////////////////////////////////////////////////////////////////////</span> |
| <span class="source-line-no">603</span><span id="line-603"></span> |
| <span class="source-line-no">604</span><span id="line-604"> /**</span> |
| <span class="source-line-no">605</span><span id="line-605"> * Do not call with an observerOperation that is null! Have the caller check.</span> |
| <span class="source-line-no">606</span><span id="line-606"> */</span> |
| <span class="source-line-no">607</span><span id="line-607"> protected <O, R> R execOperationWithResult(</span> |
| <span class="source-line-no">608</span><span id="line-608"> final ObserverOperationWithResult<O, R> observerOperation) throws IOException {</span> |
| <span class="source-line-no">609</span><span id="line-609"> boolean bypass = execOperation(observerOperation);</span> |
| <span class="source-line-no">610</span><span id="line-610"> R result = observerOperation.getResult();</span> |
| <span class="source-line-no">611</span><span id="line-611"> return bypass == observerOperation.isBypassable() ? result : null;</span> |
| <span class="source-line-no">612</span><span id="line-612"> }</span> |
| <span class="source-line-no">613</span><span id="line-613"></span> |
| <span class="source-line-no">614</span><span id="line-614"> /**</span> |
| <span class="source-line-no">615</span><span id="line-615"> * @return True if we are to bypass (Can only be <code>true</code> if</span> |
| <span class="source-line-no">616</span><span id="line-616"> * ObserverOperation#isBypassable().</span> |
| <span class="source-line-no">617</span><span id="line-617"> */</span> |
| <span class="source-line-no">618</span><span id="line-618"> protected <O> boolean execOperation(final ObserverOperation<O> observerOperation)</span> |
| <span class="source-line-no">619</span><span id="line-619"> throws IOException {</span> |
| <span class="source-line-no">620</span><span id="line-620"> boolean bypass = false;</span> |
| <span class="source-line-no">621</span><span id="line-621"> if (observerOperation == null) {</span> |
| <span class="source-line-no">622</span><span id="line-622"> return bypass;</span> |
| <span class="source-line-no">623</span><span id="line-623"> }</span> |
| <span class="source-line-no">624</span><span id="line-624"> List<E> envs = coprocEnvironments.get();</span> |
| <span class="source-line-no">625</span><span id="line-625"> for (E env : envs) {</span> |
| <span class="source-line-no">626</span><span id="line-626"> observerOperation.prepare(env);</span> |
| <span class="source-line-no">627</span><span id="line-627"> Thread currentThread = Thread.currentThread();</span> |
| <span class="source-line-no">628</span><span id="line-628"> ClassLoader cl = currentThread.getContextClassLoader();</span> |
| <span class="source-line-no">629</span><span id="line-629"> try {</span> |
| <span class="source-line-no">630</span><span id="line-630"> currentThread.setContextClassLoader(env.getClassLoader());</span> |
| <span class="source-line-no">631</span><span id="line-631"> observerOperation.callObserver();</span> |
| <span class="source-line-no">632</span><span id="line-632"> } catch (Throwable e) {</span> |
| <span class="source-line-no">633</span><span id="line-633"> handleCoprocessorThrowable(env, e);</span> |
| <span class="source-line-no">634</span><span id="line-634"> } finally {</span> |
| <span class="source-line-no">635</span><span id="line-635"> currentThread.setContextClassLoader(cl);</span> |
| <span class="source-line-no">636</span><span id="line-636"> }</span> |
| <span class="source-line-no">637</span><span id="line-637"> // Internal to shouldBypass, it checks if obeserverOperation#isBypassable().</span> |
| <span class="source-line-no">638</span><span id="line-638"> bypass |= observerOperation.shouldBypass();</span> |
| <span class="source-line-no">639</span><span id="line-639"> observerOperation.postEnvCall();</span> |
| <span class="source-line-no">640</span><span id="line-640"> if (bypass) {</span> |
| <span class="source-line-no">641</span><span id="line-641"> // If CP says bypass, skip out w/o calling any following CPs; they might ruin our response.</span> |
| <span class="source-line-no">642</span><span id="line-642"> // In hbase1, this used to be called 'complete'. In hbase2, we unite bypass and 'complete'.</span> |
| <span class="source-line-no">643</span><span id="line-643"> break;</span> |
| <span class="source-line-no">644</span><span id="line-644"> }</span> |
| <span class="source-line-no">645</span><span id="line-645"> }</span> |
| <span class="source-line-no">646</span><span id="line-646"> return bypass;</span> |
| <span class="source-line-no">647</span><span id="line-647"> }</span> |
| <span class="source-line-no">648</span><span id="line-648"></span> |
| <span class="source-line-no">649</span><span id="line-649"> /**</span> |
| <span class="source-line-no">650</span><span id="line-650"> * Coprocessor classes can be configured in any order, based on that priority is set and chained</span> |
| <span class="source-line-no">651</span><span id="line-651"> * in a sorted order. Should be used preStop*() hooks i.e. when master/regionserver is going down.</span> |
| <span class="source-line-no">652</span><span id="line-652"> * This function first calls coprocessor methods (using ObserverOperation.call()) and then</span> |
| <span class="source-line-no">653</span><span id="line-653"> * shutdowns the environment in postEnvCall(). <br></span> |
| <span class="source-line-no">654</span><span id="line-654"> * Need to execute all coprocessor methods first then postEnvCall(), otherwise some coprocessors</span> |
| <span class="source-line-no">655</span><span id="line-655"> * may remain shutdown if any exception occurs during next coprocessor execution which prevent</span> |
| <span class="source-line-no">656</span><span id="line-656"> * master/regionserver stop or cluster shutdown. (Refer:</span> |
| <span class="source-line-no">657</span><span id="line-657"> * <a href="https://issues.apache.org/jira/browse/HBASE-16663">HBASE-16663</a></span> |
| <span class="source-line-no">658</span><span id="line-658"> * @return true if bypaas coprocessor execution, false if not.</span> |
| <span class="source-line-no">659</span><span id="line-659"> */</span> |
| <span class="source-line-no">660</span><span id="line-660"> protected <O> boolean execShutdown(final ObserverOperation<O> observerOperation)</span> |
| <span class="source-line-no">661</span><span id="line-661"> throws IOException {</span> |
| <span class="source-line-no">662</span><span id="line-662"> if (observerOperation == null) return false;</span> |
| <span class="source-line-no">663</span><span id="line-663"> boolean bypass = false;</span> |
| <span class="source-line-no">664</span><span id="line-664"> List<E> envs = coprocEnvironments.get();</span> |
| <span class="source-line-no">665</span><span id="line-665"> // Iterate the coprocessors and execute ObserverOperation's call()</span> |
| <span class="source-line-no">666</span><span id="line-666"> for (E env : envs) {</span> |
| <span class="source-line-no">667</span><span id="line-667"> observerOperation.prepare(env);</span> |
| <span class="source-line-no">668</span><span id="line-668"> Thread currentThread = Thread.currentThread();</span> |
| <span class="source-line-no">669</span><span id="line-669"> ClassLoader cl = currentThread.getContextClassLoader();</span> |
| <span class="source-line-no">670</span><span id="line-670"> try {</span> |
| <span class="source-line-no">671</span><span id="line-671"> currentThread.setContextClassLoader(env.getClassLoader());</span> |
| <span class="source-line-no">672</span><span id="line-672"> observerOperation.callObserver();</span> |
| <span class="source-line-no">673</span><span id="line-673"> } catch (Throwable e) {</span> |
| <span class="source-line-no">674</span><span id="line-674"> handleCoprocessorThrowable(env, e);</span> |
| <span class="source-line-no">675</span><span id="line-675"> } finally {</span> |
| <span class="source-line-no">676</span><span id="line-676"> currentThread.setContextClassLoader(cl);</span> |
| <span class="source-line-no">677</span><span id="line-677"> }</span> |
| <span class="source-line-no">678</span><span id="line-678"> bypass |= observerOperation.shouldBypass();</span> |
| <span class="source-line-no">679</span><span id="line-679"> }</span> |
| <span class="source-line-no">680</span><span id="line-680"></span> |
| <span class="source-line-no">681</span><span id="line-681"> // Iterate the coprocessors and execute ObserverOperation's postEnvCall()</span> |
| <span class="source-line-no">682</span><span id="line-682"> for (E env : envs) {</span> |
| <span class="source-line-no">683</span><span id="line-683"> observerOperation.prepare(env);</span> |
| <span class="source-line-no">684</span><span id="line-684"> observerOperation.postEnvCall();</span> |
| <span class="source-line-no">685</span><span id="line-685"> }</span> |
| <span class="source-line-no">686</span><span id="line-686"> return bypass;</span> |
| <span class="source-line-no">687</span><span id="line-687"> }</span> |
| <span class="source-line-no">688</span><span id="line-688">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
