http://git-wip-us.apache.org/repos/asf/hbase-site/blob/93ae3fc9/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.ObserverOperationWithResult.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.ObserverOperationWithResult.html b/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.ObserverOperationWithResult.html index cb1b7e5..2bc02b6 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.ObserverOperationWithResult.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.ObserverOperationWithResult.html @@ -7,728 +7,736 @@ <body> <div class="sourceContainer"> <pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> -<span class="sourceLineNo">002</span> *<a name="line.2"></a> -<span class="sourceLineNo">003</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.3"></a> -<span class="sourceLineNo">004</span> * or more contributor license agreements. See the NOTICE file<a name="line.4"></a> -<span class="sourceLineNo">005</span> * distributed with this work for additional information<a name="line.5"></a> -<span class="sourceLineNo">006</span> * regarding copyright ownership. The ASF licenses this file<a name="line.6"></a> -<span class="sourceLineNo">007</span> * to you under the Apache License, Version 2.0 (the<a name="line.7"></a> -<span class="sourceLineNo">008</span> * "License"); you may not use this file except in compliance<a name="line.8"></a> -<span class="sourceLineNo">009</span> * with the License. You may obtain a copy of the License at<a name="line.9"></a> -<span class="sourceLineNo">010</span> *<a name="line.10"></a> -<span class="sourceLineNo">011</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.11"></a> -<span class="sourceLineNo">012</span> *<a name="line.12"></a> -<span class="sourceLineNo">013</span> * Unless required by applicable law or agreed to in writing, software<a name="line.13"></a> -<span class="sourceLineNo">014</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.14"></a> -<span class="sourceLineNo">015</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.15"></a> -<span class="sourceLineNo">016</span> * See the License for the specific language governing permissions and<a name="line.16"></a> -<span class="sourceLineNo">017</span> * limitations under the License.<a name="line.17"></a> -<span class="sourceLineNo">018</span> */<a name="line.18"></a> -<span class="sourceLineNo">019</span><a name="line.19"></a> -<span class="sourceLineNo">020</span>package org.apache.hadoop.hbase.coprocessor;<a name="line.20"></a> -<span class="sourceLineNo">021</span><a name="line.21"></a> -<span class="sourceLineNo">022</span>import java.io.IOException;<a name="line.22"></a> -<span class="sourceLineNo">023</span>import java.util.ArrayList;<a name="line.23"></a> -<span class="sourceLineNo">024</span>import java.util.Collections;<a name="line.24"></a> -<span class="sourceLineNo">025</span>import java.util.Comparator;<a name="line.25"></a> -<span class="sourceLineNo">026</span>import java.util.HashSet;<a name="line.26"></a> -<span class="sourceLineNo">027</span>import java.util.List;<a name="line.27"></a> -<span class="sourceLineNo">028</span>import java.util.Optional;<a name="line.28"></a> -<span class="sourceLineNo">029</span>import java.util.Set;<a name="line.29"></a> -<span class="sourceLineNo">030</span>import java.util.TreeSet;<a name="line.30"></a> -<span class="sourceLineNo">031</span>import java.util.UUID;<a name="line.31"></a> -<span class="sourceLineNo">032</span>import java.util.concurrent.ConcurrentSkipListSet;<a name="line.32"></a> -<span class="sourceLineNo">033</span>import java.util.concurrent.atomic.AtomicInteger;<a name="line.33"></a> -<span class="sourceLineNo">034</span>import java.util.function.Function;<a name="line.34"></a> -<span class="sourceLineNo">035</span><a name="line.35"></a> -<span class="sourceLineNo">036</span>import org.apache.commons.logging.Log;<a name="line.36"></a> -<span class="sourceLineNo">037</span>import org.apache.commons.logging.LogFactory;<a name="line.37"></a> -<span class="sourceLineNo">038</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.38"></a> -<span class="sourceLineNo">039</span>import org.apache.yetus.audience.InterfaceStability;<a name="line.39"></a> -<span class="sourceLineNo">040</span>import org.apache.hadoop.conf.Configuration;<a name="line.40"></a> -<span class="sourceLineNo">041</span>import org.apache.hadoop.fs.Path;<a name="line.41"></a> -<span class="sourceLineNo">042</span>import org.apache.hadoop.hbase.Abortable;<a name="line.42"></a> -<span class="sourceLineNo">043</span>import org.apache.hadoop.hbase.Coprocessor;<a name="line.43"></a> -<span class="sourceLineNo">044</span>import org.apache.hadoop.hbase.CoprocessorEnvironment;<a name="line.44"></a> -<span class="sourceLineNo">045</span>import org.apache.hadoop.hbase.DoNotRetryIOException;<a name="line.45"></a> -<span class="sourceLineNo">046</span>import org.apache.hadoop.hbase.HBaseInterfaceAudience;<a name="line.46"></a> -<span class="sourceLineNo">047</span>import org.apache.hadoop.hbase.HConstants;<a name="line.47"></a> -<span class="sourceLineNo">048</span>import org.apache.hadoop.hbase.ipc.RpcServer;<a name="line.48"></a> -<span class="sourceLineNo">049</span>import org.apache.hadoop.hbase.security.User;<a name="line.49"></a> -<span class="sourceLineNo">050</span>import org.apache.hadoop.hbase.shaded.com.google.common.annotations.VisibleForTesting;<a name="line.50"></a> -<span class="sourceLineNo">051</span>import org.apache.hadoop.hbase.util.CoprocessorClassLoader;<a name="line.51"></a> -<span class="sourceLineNo">052</span>import org.apache.hadoop.hbase.util.SortedList;<a name="line.52"></a> -<span class="sourceLineNo">053</span><a name="line.53"></a> -<span class="sourceLineNo">054</span>/**<a name="line.54"></a> -<span class="sourceLineNo">055</span> * Provides the common setup framework and runtime services for coprocessor<a name="line.55"></a> -<span class="sourceLineNo">056</span> * invocation from HBase services.<a name="line.56"></a> -<span class="sourceLineNo">057</span> * @param <C> type of specific coprocessor this host will handle<a name="line.57"></a> -<span class="sourceLineNo">058</span> * @param <E> type of specific coprocessor environment this host requires.<a name="line.58"></a> -<span class="sourceLineNo">059</span> * provides<a name="line.59"></a> -<span class="sourceLineNo">060</span> */<a name="line.60"></a> -<span class="sourceLineNo">061</span>@InterfaceAudience.Private<a name="line.61"></a> -<span class="sourceLineNo">062</span>public abstract class CoprocessorHost<C extends Coprocessor, E extends CoprocessorEnvironment<C>> {<a name="line.62"></a> -<span class="sourceLineNo">063</span> public static final String REGION_COPROCESSOR_CONF_KEY =<a name="line.63"></a> -<span class="sourceLineNo">064</span> "hbase.coprocessor.region.classes";<a name="line.64"></a> -<span class="sourceLineNo">065</span> public static final String REGIONSERVER_COPROCESSOR_CONF_KEY =<a name="line.65"></a> -<span class="sourceLineNo">066</span> "hbase.coprocessor.regionserver.classes";<a name="line.66"></a> -<span class="sourceLineNo">067</span> public static final String USER_REGION_COPROCESSOR_CONF_KEY =<a name="line.67"></a> -<span class="sourceLineNo">068</span> "hbase.coprocessor.user.region.classes";<a name="line.68"></a> -<span class="sourceLineNo">069</span> public static final String MASTER_COPROCESSOR_CONF_KEY =<a name="line.69"></a> -<span class="sourceLineNo">070</span> "hbase.coprocessor.master.classes";<a name="line.70"></a> -<span class="sourceLineNo">071</span> public static final String WAL_COPROCESSOR_CONF_KEY =<a name="line.71"></a> -<span class="sourceLineNo">072</span> "hbase.coprocessor.wal.classes";<a name="line.72"></a> -<span class="sourceLineNo">073</span> public static final String ABORT_ON_ERROR_KEY = "hbase.coprocessor.abortonerror";<a name="line.73"></a> -<span class="sourceLineNo">074</span> public static final boolean DEFAULT_ABORT_ON_ERROR = true;<a name="line.74"></a> -<span class="sourceLineNo">075</span> public static final String COPROCESSORS_ENABLED_CONF_KEY = "hbase.coprocessor.enabled";<a name="line.75"></a> -<span class="sourceLineNo">076</span> public static final boolean DEFAULT_COPROCESSORS_ENABLED = true;<a name="line.76"></a> -<span class="sourceLineNo">077</span> public static final String USER_COPROCESSORS_ENABLED_CONF_KEY =<a name="line.77"></a> -<span class="sourceLineNo">078</span> "hbase.coprocessor.user.enabled";<a name="line.78"></a> -<span class="sourceLineNo">079</span> public static final boolean DEFAULT_USER_COPROCESSORS_ENABLED = true;<a name="line.79"></a> -<span class="sourceLineNo">080</span><a name="line.80"></a> -<span class="sourceLineNo">081</span> private static final Log LOG = LogFactory.getLog(CoprocessorHost.class);<a name="line.81"></a> -<span class="sourceLineNo">082</span> protected Abortable abortable;<a name="line.82"></a> -<span class="sourceLineNo">083</span> /** Ordered set of loaded coprocessors with lock */<a name="line.83"></a> -<span class="sourceLineNo">084</span> protected final SortedList<E> coprocEnvironments =<a name="line.84"></a> -<span class="sourceLineNo">085</span> new SortedList<>(new EnvironmentPriorityComparator());<a name="line.85"></a> -<span class="sourceLineNo">086</span> protected Configuration conf;<a name="line.86"></a> -<span class="sourceLineNo">087</span> // unique file prefix to use for local copies of jars when classloading<a name="line.87"></a> -<span class="sourceLineNo">088</span> protected String pathPrefix;<a name="line.88"></a> -<span class="sourceLineNo">089</span> protected AtomicInteger loadSequence = new AtomicInteger();<a name="line.89"></a> -<span class="sourceLineNo">090</span><a name="line.90"></a> -<span class="sourceLineNo">091</span> public CoprocessorHost(Abortable abortable) {<a name="line.91"></a> -<span class="sourceLineNo">092</span> this.abortable = abortable;<a name="line.92"></a> -<span class="sourceLineNo">093</span> this.pathPrefix = UUID.randomUUID().toString();<a name="line.93"></a> -<span class="sourceLineNo">094</span> }<a name="line.94"></a> -<span class="sourceLineNo">095</span><a name="line.95"></a> -<span class="sourceLineNo">096</span> /**<a name="line.96"></a> -<span class="sourceLineNo">097</span> * Not to be confused with the per-object _coprocessors_ (above),<a name="line.97"></a> -<span class="sourceLineNo">098</span> * coprocessorNames is static and stores the set of all coprocessors ever<a name="line.98"></a> -<span class="sourceLineNo">099</span> * loaded by any thread in this JVM. It is strictly additive: coprocessors are<a name="line.99"></a> -<span class="sourceLineNo">100</span> * added to coprocessorNames, by checkAndLoadInstance() but are never removed, since<a name="line.100"></a> -<span class="sourceLineNo">101</span> * the intention is to preserve a history of all loaded coprocessors for<a name="line.101"></a> -<span class="sourceLineNo">102</span> * diagnosis in case of server crash (HBASE-4014).<a name="line.102"></a> -<span class="sourceLineNo">103</span> */<a name="line.103"></a> -<span class="sourceLineNo">104</span> private static Set<String> coprocessorNames =<a name="line.104"></a> -<span class="sourceLineNo">105</span> Collections.synchronizedSet(new HashSet<String>());<a name="line.105"></a> -<span class="sourceLineNo">106</span><a name="line.106"></a> -<span class="sourceLineNo">107</span> public static Set<String> getLoadedCoprocessors() {<a name="line.107"></a> -<span class="sourceLineNo">108</span> synchronized (coprocessorNames) {<a name="line.108"></a> -<span class="sourceLineNo">109</span> return new HashSet(coprocessorNames);<a name="line.109"></a> -<span class="sourceLineNo">110</span> }<a name="line.110"></a> -<span class="sourceLineNo">111</span> }<a name="line.111"></a> -<span class="sourceLineNo">112</span><a name="line.112"></a> -<span class="sourceLineNo">113</span> /**<a name="line.113"></a> -<span class="sourceLineNo">114</span> * Used to create a parameter to the HServerLoad constructor so that<a name="line.114"></a> -<span class="sourceLineNo">115</span> * HServerLoad can provide information about the coprocessors loaded by this<a name="line.115"></a> -<span class="sourceLineNo">116</span> * regionserver.<a name="line.116"></a> -<span class="sourceLineNo">117</span> * (HBASE-4070: Improve region server metrics to report loaded coprocessors<a name="line.117"></a> -<span class="sourceLineNo">118</span> * to master).<a name="line.118"></a> -<span class="sourceLineNo">119</span> */<a name="line.119"></a> -<span class="sourceLineNo">120</span> public Set<String> getCoprocessors() {<a name="line.120"></a> -<span class="sourceLineNo">121</span> Set<String> returnValue = new TreeSet<>();<a name="line.121"></a> -<span class="sourceLineNo">122</span> for (E e: coprocEnvironments) {<a name="line.122"></a> -<span class="sourceLineNo">123</span> returnValue.add(e.getInstance().getClass().getSimpleName());<a name="line.123"></a> -<span class="sourceLineNo">124</span> }<a name="line.124"></a> -<span class="sourceLineNo">125</span> return returnValue;<a name="line.125"></a> -<span class="sourceLineNo">126</span> }<a name="line.126"></a> -<span class="sourceLineNo">127</span><a name="line.127"></a> -<span class="sourceLineNo">128</span> /**<a name="line.128"></a> -<span class="sourceLineNo">129</span> * Load system coprocessors once only. Read the class names from configuration.<a name="line.129"></a> -<span class="sourceLineNo">130</span> * Called by constructor.<a name="line.130"></a> -<span class="sourceLineNo">131</span> */<a name="line.131"></a> -<span class="sourceLineNo">132</span> protected void loadSystemCoprocessors(Configuration conf, String confKey) {<a name="line.132"></a> -<span class="sourceLineNo">133</span> boolean coprocessorsEnabled = conf.getBoolean(COPROCESSORS_ENABLED_CONF_KEY,<a name="line.133"></a> -<span class="sourceLineNo">134</span> DEFAULT_COPROCESSORS_ENABLED);<a name="line.134"></a> -<span class="sourceLineNo">135</span> if (!coprocessorsEnabled) {<a name="line.135"></a> -<span class="sourceLineNo">136</span> return;<a name="line.136"></a> -<span class="sourceLineNo">137</span> }<a name="line.137"></a> -<span class="sourceLineNo">138</span><a name="line.138"></a> -<span class="sourceLineNo">139</span> Class<?> implClass;<a name="line.139"></a> -<span class="sourceLineNo">140</span><a name="line.140"></a> -<span class="sourceLineNo">141</span> // load default coprocessors from configure file<a name="line.141"></a> -<span class="sourceLineNo">142</span> String[] defaultCPClasses = conf.getStrings(confKey);<a name="line.142"></a> -<span class="sourceLineNo">143</span> if (defaultCPClasses == null || defaultCPClasses.length == 0)<a name="line.143"></a> -<span class="sourceLineNo">144</span> return;<a name="line.144"></a> -<span class="sourceLineNo">145</span><a name="line.145"></a> -<span class="sourceLineNo">146</span> int priority = Coprocessor.PRIORITY_SYSTEM;<a name="line.146"></a> -<span class="sourceLineNo">147</span> for (String className : defaultCPClasses) {<a name="line.147"></a> -<span class="sourceLineNo">148</span> className = className.trim();<a name="line.148"></a> -<span class="sourceLineNo">149</span> if (findCoprocessor(className) != null) {<a name="line.149"></a> -<span class="sourceLineNo">150</span> // If already loaded will just continue<a name="line.150"></a> -<span class="sourceLineNo">151</span> LOG.warn("Attempted duplicate loading of " + className + "; skipped");<a name="line.151"></a> -<span class="sourceLineNo">152</span> continue;<a name="line.152"></a> -<span class="sourceLineNo">153</span> }<a name="line.153"></a> -<span class="sourceLineNo">154</span> ClassLoader cl = this.getClass().getClassLoader();<a name="line.154"></a> -<span class="sourceLineNo">155</span> Thread.currentThread().setContextClassLoader(cl);<a name="line.155"></a> -<span class="sourceLineNo">156</span> try {<a name="line.156"></a> -<span class="sourceLineNo">157</span> implClass = cl.loadClass(className);<a name="line.157"></a> -<span class="sourceLineNo">158</span> // Add coprocessors as we go to guard against case where a coprocessor is specified twice<a name="line.158"></a> -<span class="sourceLineNo">159</span> // in the configuration<a name="line.159"></a> -<span class="sourceLineNo">160</span> E env = checkAndLoadInstance(implClass, priority, conf);<a name="line.160"></a> -<span class="sourceLineNo">161</span> if (env != null) {<a name="line.161"></a> -<span class="sourceLineNo">162</span> this.coprocEnvironments.add(env);<a name="line.162"></a> -<span class="sourceLineNo">163</span> LOG.info(<a name="line.163"></a> -<span class="sourceLineNo">164</span> "System coprocessor " + className + " was loaded " + "successfully with priority (" + priority + ").");<a name="line.164"></a> -<span class="sourceLineNo">165</span> ++priority;<a name="line.165"></a> -<span class="sourceLineNo">166</span> }<a name="line.166"></a> -<span class="sourceLineNo">167</span> } catch (Throwable t) {<a name="line.167"></a> -<span class="sourceLineNo">168</span> // We always abort if system coprocessors cannot be loaded<a name="line.168"></a> -<span class="sourceLineNo">169</span> abortServer(className, t);<a name="line.169"></a> -<span class="sourceLineNo">170</span> }<a name="line.170"></a> -<span class="sourceLineNo">171</span> }<a name="line.171"></a> -<span class="sourceLineNo">172</span> }<a name="line.172"></a> -<span class="sourceLineNo">173</span><a name="line.173"></a> -<span class="sourceLineNo">174</span> /**<a name="line.174"></a> -<span class="sourceLineNo">175</span> * Load a coprocessor implementation into the host<a name="line.175"></a> -<span class="sourceLineNo">176</span> * @param path path to implementation jar<a name="line.176"></a> -<span class="sourceLineNo">177</span> * @param className the main class name<a name="line.177"></a> -<span class="sourceLineNo">178</span> * @param priority chaining priority<a name="line.178"></a> -<span class="sourceLineNo">179</span> * @param conf configuration for coprocessor<a name="line.179"></a> -<span class="sourceLineNo">180</span> * @throws java.io.IOException Exception<a name="line.180"></a> -<span class="sourceLineNo">181</span> */<a name="line.181"></a> -<span class="sourceLineNo">182</span> public E load(Path path, String className, int priority,<a name="line.182"></a> -<span class="sourceLineNo">183</span> Configuration conf) throws IOException {<a name="line.183"></a> -<span class="sourceLineNo">184</span> String[] includedClassPrefixes = null;<a name="line.184"></a> -<span class="sourceLineNo">185</span> if (conf.get(HConstants.CP_HTD_ATTR_INCLUSION_KEY) != null){<a name="line.185"></a> -<span class="sourceLineNo">186</span> String prefixes = conf.get(HConstants.CP_HTD_ATTR_INCLUSION_KEY);<a name="line.186"></a> -<span class="sourceLineNo">187</span> includedClassPrefixes = prefixes.split(";");<a name="line.187"></a> -<span class="sourceLineNo">188</span> }<a name="line.188"></a> -<span class="sourceLineNo">189</span> return load(path, className, priority, conf, includedClassPrefixes);<a name="line.189"></a> -<span class="sourceLineNo">190</span> }<a name="line.190"></a> -<span class="sourceLineNo">191</span><a name="line.191"></a> -<span class="sourceLineNo">192</span> /**<a name="line.192"></a> -<span class="sourceLineNo">193</span> * Load a coprocessor implementation into the host<a name="line.193"></a> -<span class="sourceLineNo">194</span> * @param path path to implementation jar<a name="line.194"></a> -<span class="sourceLineNo">195</span> * @param className the main class name<a name="line.195"></a> -<span class="sourceLineNo">196</span> * @param priority chaining priority<a name="line.196"></a> -<span class="sourceLineNo">197</span> * @param conf configuration for coprocessor<a name="line.197"></a> -<span class="sourceLineNo">198</span> * @param includedClassPrefixes class name prefixes to include<a name="line.198"></a> -<span class="sourceLineNo">199</span> * @throws java.io.IOException Exception<a name="line.199"></a> -<span class="sourceLineNo">200</span> */<a name="line.200"></a> -<span class="sourceLineNo">201</span> public E load(Path path, String className, int priority,<a name="line.201"></a> -<span class="sourceLineNo">202</span> Configuration conf, String[] includedClassPrefixes) throws IOException {<a name="line.202"></a> -<span class="sourceLineNo">203</span> Class<?> implClass;<a name="line.203"></a> -<span class="sourceLineNo">204</span> LOG.debug("Loading coprocessor class " + className + " with path " +<a name="line.204"></a> -<span class="sourceLineNo">205</span> path + " and priority " + priority);<a name="line.205"></a> -<span class="sourceLineNo">206</span><a name="line.206"></a> -<span class="sourceLineNo">207</span> ClassLoader cl = null;<a name="line.207"></a> -<span class="sourceLineNo">208</span> if (path == null) {<a name="line.208"></a> -<span class="sourceLineNo">209</span> try {<a name="line.209"></a> -<span class="sourceLineNo">210</span> implClass = getClass().getClassLoader().loadClass(className);<a name="line.210"></a> -<span class="sourceLineNo">211</span> } catch (ClassNotFoundException e) {<a name="line.211"></a> -<span class="sourceLineNo">212</span> throw new IOException("No jar path specified for " + className);<a name="line.212"></a> -<span class="sourceLineNo">213</span> }<a name="line.213"></a> -<span class="sourceLineNo">214</span> } else {<a name="line.214"></a> -<span class="sourceLineNo">215</span> cl = CoprocessorClassLoader.getClassLoader(<a name="line.215"></a> -<span class="sourceLineNo">216</span> path, getClass().getClassLoader(), pathPrefix, conf);<a name="line.216"></a> -<span class="sourceLineNo">217</span> try {<a name="line.217"></a> -<span class="sourceLineNo">218</span> implClass = ((CoprocessorClassLoader)cl).loadClass(className, includedClassPrefixes);<a name="line.218"></a> -<span class="sourceLineNo">219</span> } catch (ClassNotFoundException e) {<a name="line.219"></a> -<span class="sourceLineNo">220</span> throw new IOException("Cannot load external coprocessor class " + className, e);<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> //load custom code for coprocessor<a name="line.224"></a> -<span class="sourceLineNo">225</span> Thread currentThread = Thread.currentThread();<a name="line.225"></a> -<span class="sourceLineNo">226</span> ClassLoader hostClassLoader = currentThread.getContextClassLoader();<a name="line.226"></a> -<span class="sourceLineNo">227</span> try{<a name="line.227"></a> -<span class="sourceLineNo">228</span> // switch temporarily to the thread classloader for custom CP<a name="line.228"></a> -<span class="sourceLineNo">229</span> currentThread.setContextClassLoader(cl);<a name="line.229"></a> -<span class="sourceLineNo">230</span> E cpInstance = checkAndLoadInstance(implClass, priority, conf);<a name="line.230"></a> -<span class="sourceLineNo">231</span> return cpInstance;<a name="line.231"></a> -<span class="sourceLineNo">232</span> } finally {<a name="line.232"></a> -<span class="sourceLineNo">233</span> // restore the fresh (host) classloader<a name="line.233"></a> -<span class="sourceLineNo">234</span> currentThread.setContextClassLoader(hostClassLoader);<a name="line.234"></a> -<span class="sourceLineNo">235</span> }<a name="line.235"></a> -<span class="sourceLineNo">236</span> }<a name="line.236"></a> -<span class="sourceLineNo">237</span><a name="line.237"></a> -<span class="sourceLineNo">238</span> @VisibleForTesting<a name="line.238"></a> -<span class="sourceLineNo">239</span> public void load(Class<? extends C> implClass, int priority, Configuration conf)<a name="line.239"></a> -<span class="sourceLineNo">240</span> throws IOException {<a name="line.240"></a> -<span class="sourceLineNo">241</span> E env = checkAndLoadInstance(implClass, priority, conf);<a name="line.241"></a> -<span class="sourceLineNo">242</span> coprocEnvironments.add(env);<a name="line.242"></a> -<span class="sourceLineNo">243</span> }<a name="line.243"></a> -<span class="sourceLineNo">244</span><a name="line.244"></a> -<span class="sourceLineNo">245</span> /**<a name="line.245"></a> -<span class="sourceLineNo">246</span> * @param implClass Implementation class<a name="line.246"></a> -<span class="sourceLineNo">247</span> * @param priority priority<a name="line.247"></a> -<span class="sourceLineNo">248</span> * @param conf configuration<a name="line.248"></a> -<span class="sourceLineNo">249</span> * @throws java.io.IOException Exception<a name="line.249"></a> -<span class="sourceLineNo">250</span> */<a name="line.250"></a> -<span class="sourceLineNo">251</span> public E checkAndLoadInstance(Class<?> implClass, int priority, Configuration conf)<a name="line.251"></a> -<span class="sourceLineNo">252</span> throws IOException {<a name="line.252"></a> -<span class="sourceLineNo">253</span> // create the instance<a name="line.253"></a> -<span class="sourceLineNo">254</span> C impl;<a name="line.254"></a> -<span class="sourceLineNo">255</span> try {<a name="line.255"></a> -<span class="sourceLineNo">256</span> impl = checkAndGetInstance(implClass);<a name="line.256"></a> -<span class="sourceLineNo">257</span> if (impl == null) {<a name="line.257"></a> -<span class="sourceLineNo">258</span> LOG.error("Cannot load coprocessor " + implClass.getSimpleName());<a name="line.258"></a> -<span class="sourceLineNo">259</span> return null;<a name="line.259"></a> -<span class="sourceLineNo">260</span> }<a name="line.260"></a> -<span class="sourceLineNo">261</span> } catch (InstantiationException|IllegalAccessException e) {<a name="line.261"></a> -<span class="sourceLineNo">262</span> throw new IOException(e);<a name="line.262"></a> -<span class="sourceLineNo">263</span> }<a name="line.263"></a> -<span class="sourceLineNo">264</span> // create the environment<a name="line.264"></a> -<span class="sourceLineNo">265</span> E env = createEnvironment(impl, priority, loadSequence.incrementAndGet(), conf);<a name="line.265"></a> -<span class="sourceLineNo">266</span> env.startup();<a name="line.266"></a> -<span class="sourceLineNo">267</span> // HBASE-4014: maintain list of loaded coprocessors for later crash analysis<a name="line.267"></a> -<span class="sourceLineNo">268</span> // if server (master or regionserver) aborts.<a name="line.268"></a> -<span class="sourceLineNo">269</span> coprocessorNames.add(implClass.getName());<a name="line.269"></a> -<span class="sourceLineNo">270</span> return env;<a name="line.270"></a> -<span class="sourceLineNo">271</span> }<a name="line.271"></a> -<span class="sourceLineNo">272</span><a name="line.272"></a> -<span class="sourceLineNo">273</span> /**<a name="line.273"></a> -<span class="sourceLineNo">274</span> * Called when a new Coprocessor class is loaded<a name="line.274"></a> -<span class="sourceLineNo">275</span> */<a name="line.275"></a> -<span class="sourceLineNo">276</span> public abstract E createEnvironment(C instance, int priority, int sequence, Configuration conf);<a name="line.276"></a> -<span class="sourceLineNo">277</span><a name="line.277"></a> -<span class="sourceLineNo">278</span> /**<a name="line.278"></a> -<span class="sourceLineNo">279</span> * Called when a new Coprocessor class needs to be loaded. Checks if type of the given class<a name="line.279"></a> -<span class="sourceLineNo">280</span> * is what the corresponding host implementation expects. If it is of correct type, returns an<a name="line.280"></a> -<span class="sourceLineNo">281</span> * instance of the coprocessor to be loaded. If not, returns null.<a name="line.281"></a> -<span class="sourceLineNo">282</span> * If an exception occurs when trying to create instance of a coprocessor, it's passed up and<a name="line.282"></a> -<span class="sourceLineNo">283</span> * eventually results into server aborting.<a name="line.283"></a> -<span class="sourceLineNo">284</span> */<a name="line.284"></a> -<span class="sourceLineNo">285</span> public abstract C checkAndGetInstance(Class<?> implClass)<a name="line.285"></a> -<span class="sourceLineNo">286</span> throws InstantiationException, IllegalAccessException;<a name="line.286"></a> -<span class="sourceLineNo">287</span><a name="line.287"></a> -<span class="sourceLineNo">288</span> public void shutdown(E e) {<a name="line.288"></a> -<span class="sourceLineNo">289</span> if (LOG.isDebugEnabled()) {<a name="line.289"></a> -<span class="sourceLineNo">290</span> LOG.debug("Stop coprocessor " + e.getInstance().getClass().getName());<a name="line.290"></a> -<span class="sourceLineNo">291</span> }<a name="line.291"></a> -<span class="sourceLineNo">292</span> e.shutdown();<a name="line.292"></a> -<span class="sourceLineNo">293</span> }<a name="line.293"></a> -<span class="sourceLineNo">294</span><a name="line.294"></a> -<span class="sourceLineNo">295</span> /**<a name="line.295"></a> -<span class="sourceLineNo">296</span> * Find coprocessors by full class name or simple name.<a name="line.296"></a> -<span class="sourceLineNo">297</span> */<a name="line.297"></a> -<span class="sourceLineNo">298</span> public C findCoprocessor(String className) {<a name="line.298"></a> -<span class="sourceLineNo">299</span> for (E env: coprocEnvironments) {<a name="line.299"></a> -<span class="sourceLineNo">300</span> if (env.getInstance().getClass().getName().equals(className) ||<a name="line.300"></a> -<span class="sourceLineNo">301</span> env.getInstance().getClass().getSimpleName().equals(className)) {<a name="line.301"></a> -<span class="sourceLineNo">302</span> return env.getInstance();<a name="line.302"></a> -<span class="sourceLineNo">303</span> }<a name="line.303"></a> -<span class="sourceLineNo">304</span> }<a name="line.304"></a> -<span class="sourceLineNo">305</span> return null;<a name="line.305"></a> -<span class="sourceLineNo">306</span> }<a name="line.306"></a> -<span class="sourceLineNo">307</span><a name="line.307"></a> -<span class="sourceLineNo">308</span> @VisibleForTesting<a name="line.308"></a> -<span class="sourceLineNo">309</span> public <T extends C> T findCoprocessor(Class<T> cls) {<a name="line.309"></a> -<span class="sourceLineNo">310</span> for (E env: coprocEnvironments) {<a name="line.310"></a> -<span class="sourceLineNo">311</span> if (cls.isAssignableFrom(env.getInstance().getClass())) {<a name="line.311"></a> -<span class="sourceLineNo">312</span> return (T) env.getInstance();<a name="line.312"></a> -<span class="sourceLineNo">313</span> }<a name="line.313"></a> -<span class="sourceLineNo">314</span> }<a name="line.314"></a> -<span class="sourceLineNo">315</span> return null;<a name="line.315"></a> -<span class="sourceLineNo">316</span> }<a name="line.316"></a> -<span class="sourceLineNo">317</span><a name="line.317"></a> -<span class="sourceLineNo">318</span> /**<a name="line.318"></a> -<span class="sourceLineNo">319</span> * Find list of coprocessors that extend/implement the given class/interface<a name="line.319"></a> -<span class="sourceLineNo">320</span> * @param cls the class/interface to look for<a name="line.320"></a> -<span class="sourceLineNo">321</span> * @return the list of coprocessors, or null if not found<a name="line.321"></a> -<span class="sourceLineNo">322</span> */<a name="line.322"></a> -<span class="sourceLineNo">323</span> public <T extends C> List<T> findCoprocessors(Class<T> cls) {<a name="line.323"></a> -<span class="sourceLineNo">324</span> ArrayList<T> ret = new ArrayList<>();<a name="line.324"></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><a name="line.18"></a> +<span class="sourceLineNo">019</span>package org.apache.hadoop.hbase.coprocessor;<a name="line.19"></a> +<span class="sourceLineNo">020</span><a name="line.20"></a> +<span class="sourceLineNo">021</span>import java.io.IOException;<a name="line.21"></a> +<span class="sourceLineNo">022</span>import java.util.ArrayList;<a name="line.22"></a> +<span class="sourceLineNo">023</span>import java.util.Collections;<a name="line.23"></a> +<span class="sourceLineNo">024</span>import java.util.Comparator;<a name="line.24"></a> +<span class="sourceLineNo">025</span>import java.util.HashSet;<a name="line.25"></a> +<span class="sourceLineNo">026</span>import java.util.List;<a name="line.26"></a> +<span class="sourceLineNo">027</span>import java.util.Optional;<a name="line.27"></a> +<span class="sourceLineNo">028</span>import java.util.Set;<a name="line.28"></a> +<span class="sourceLineNo">029</span>import java.util.TreeSet;<a name="line.29"></a> +<span class="sourceLineNo">030</span>import java.util.UUID;<a name="line.30"></a> +<span class="sourceLineNo">031</span>import java.util.concurrent.ConcurrentSkipListSet;<a name="line.31"></a> +<span class="sourceLineNo">032</span>import java.util.concurrent.atomic.AtomicInteger;<a name="line.32"></a> +<span class="sourceLineNo">033</span>import java.util.function.Function;<a name="line.33"></a> +<span class="sourceLineNo">034</span><a name="line.34"></a> +<span class="sourceLineNo">035</span>import org.apache.commons.logging.Log;<a name="line.35"></a> +<span class="sourceLineNo">036</span>import org.apache.commons.logging.LogFactory;<a name="line.36"></a> +<span class="sourceLineNo">037</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.37"></a> +<span class="sourceLineNo">038</span>import org.apache.hadoop.conf.Configuration;<a name="line.38"></a> +<span class="sourceLineNo">039</span>import org.apache.hadoop.fs.Path;<a name="line.39"></a> +<span class="sourceLineNo">040</span>import org.apache.hadoop.hbase.Abortable;<a name="line.40"></a> +<span class="sourceLineNo">041</span>import org.apache.hadoop.hbase.Coprocessor;<a name="line.41"></a> +<span class="sourceLineNo">042</span>import org.apache.hadoop.hbase.CoprocessorEnvironment;<a name="line.42"></a> +<span class="sourceLineNo">043</span>import org.apache.hadoop.hbase.DoNotRetryIOException;<a name="line.43"></a> +<span class="sourceLineNo">044</span>import org.apache.hadoop.hbase.HConstants;<a name="line.44"></a> +<span class="sourceLineNo">045</span>import org.apache.hadoop.hbase.ipc.RpcServer;<a name="line.45"></a> +<span class="sourceLineNo">046</span>import org.apache.hadoop.hbase.security.User;<a name="line.46"></a> +<span class="sourceLineNo">047</span>import org.apache.hadoop.hbase.shaded.com.google.common.annotations.VisibleForTesting;<a name="line.47"></a> +<span class="sourceLineNo">048</span>import org.apache.hadoop.hbase.util.CoprocessorClassLoader;<a name="line.48"></a> +<span class="sourceLineNo">049</span>import org.apache.hadoop.hbase.util.SortedList;<a name="line.49"></a> +<span class="sourceLineNo">050</span><a name="line.50"></a> +<span class="sourceLineNo">051</span>/**<a name="line.51"></a> +<span class="sourceLineNo">052</span> * Provides the common setup framework and runtime services for coprocessor<a name="line.52"></a> +<span class="sourceLineNo">053</span> * invocation from HBase services.<a name="line.53"></a> +<span class="sourceLineNo">054</span> * @param <C> type of specific coprocessor this host will handle<a name="line.54"></a> +<span class="sourceLineNo">055</span> * @param <E> type of specific coprocessor environment this host requires.<a name="line.55"></a> +<span class="sourceLineNo">056</span> * provides<a name="line.56"></a> +<span class="sourceLineNo">057</span> */<a name="line.57"></a> +<span class="sourceLineNo">058</span>@InterfaceAudience.Private<a name="line.58"></a> +<span class="sourceLineNo">059</span>public abstract class CoprocessorHost<C extends Coprocessor, E extends CoprocessorEnvironment<C>> {<a name="line.59"></a> +<span class="sourceLineNo">060</span> public static final String REGION_COPROCESSOR_CONF_KEY =<a name="line.60"></a> +<span class="sourceLineNo">061</span> "hbase.coprocessor.region.classes";<a name="line.61"></a> +<span class="sourceLineNo">062</span> public static final String REGIONSERVER_COPROCESSOR_CONF_KEY =<a name="line.62"></a> +<span class="sourceLineNo">063</span> "hbase.coprocessor.regionserver.classes";<a name="line.63"></a> +<span class="sourceLineNo">064</span> public static final String USER_REGION_COPROCESSOR_CONF_KEY =<a name="line.64"></a> +<span class="sourceLineNo">065</span> "hbase.coprocessor.user.region.classes";<a name="line.65"></a> +<span class="sourceLineNo">066</span> public static final String MASTER_COPROCESSOR_CONF_KEY =<a name="line.66"></a> +<span class="sourceLineNo">067</span> "hbase.coprocessor.master.classes";<a name="line.67"></a> +<span class="sourceLineNo">068</span> public static final String WAL_COPROCESSOR_CONF_KEY =<a name="line.68"></a> +<span class="sourceLineNo">069</span> "hbase.coprocessor.wal.classes";<a name="line.69"></a> +<span class="sourceLineNo">070</span> public static final String ABORT_ON_ERROR_KEY = "hbase.coprocessor.abortonerror";<a name="line.70"></a> +<span class="sourceLineNo">071</span> public static final boolean DEFAULT_ABORT_ON_ERROR = true;<a name="line.71"></a> +<span class="sourceLineNo">072</span> public static final String COPROCESSORS_ENABLED_CONF_KEY = "hbase.coprocessor.enabled";<a name="line.72"></a> +<span class="sourceLineNo">073</span> public static final boolean DEFAULT_COPROCESSORS_ENABLED = true;<a name="line.73"></a> +<span class="sourceLineNo">074</span> public static final String USER_COPROCESSORS_ENABLED_CONF_KEY =<a name="line.74"></a> +<span class="sourceLineNo">075</span> "hbase.coprocessor.user.enabled";<a name="line.75"></a> +<span class="sourceLineNo">076</span> public static final boolean DEFAULT_USER_COPROCESSORS_ENABLED = true;<a name="line.76"></a> +<span class="sourceLineNo">077</span><a name="line.77"></a> +<span class="sourceLineNo">078</span> private static final Log LOG = LogFactory.getLog(CoprocessorHost.class);<a name="line.78"></a> +<span class="sourceLineNo">079</span> protected Abortable abortable;<a name="line.79"></a> +<span class="sourceLineNo">080</span> /** Ordered set of loaded coprocessors with lock */<a name="line.80"></a> +<span class="sourceLineNo">081</span> protected final SortedList<E> coprocEnvironments =<a name="line.81"></a> +<span class="sourceLineNo">082</span> new SortedList<>(new EnvironmentPriorityComparator());<a name="line.82"></a> +<span class="sourceLineNo">083</span> protected Configuration conf;<a name="line.83"></a> +<span class="sourceLineNo">084</span> // unique file prefix to use for local copies of jars when classloading<a name="line.84"></a> +<span class="sourceLineNo">085</span> protected String pathPrefix;<a name="line.85"></a> +<span class="sourceLineNo">086</span> protected AtomicInteger loadSequence = new AtomicInteger();<a name="line.86"></a> +<span class="sourceLineNo">087</span><a name="line.87"></a> +<span class="sourceLineNo">088</span> public CoprocessorHost(Abortable abortable) {<a name="line.88"></a> +<span class="sourceLineNo">089</span> this.abortable = abortable;<a name="line.89"></a> +<span class="sourceLineNo">090</span> this.pathPrefix = UUID.randomUUID().toString();<a name="line.90"></a> +<span class="sourceLineNo">091</span> }<a name="line.91"></a> +<span class="sourceLineNo">092</span><a name="line.92"></a> +<span class="sourceLineNo">093</span> /**<a name="line.93"></a> +<span class="sourceLineNo">094</span> * Not to be confused with the per-object _coprocessors_ (above),<a name="line.94"></a> +<span class="sourceLineNo">095</span> * coprocessorNames is static and stores the set of all coprocessors ever<a name="line.95"></a> +<span class="sourceLineNo">096</span> * loaded by any thread in this JVM. It is strictly additive: coprocessors are<a name="line.96"></a> +<span class="sourceLineNo">097</span> * added to coprocessorNames, by checkAndLoadInstance() but are never removed, since<a name="line.97"></a> +<span class="sourceLineNo">098</span> * the intention is to preserve a history of all loaded coprocessors for<a name="line.98"></a> +<span class="sourceLineNo">099</span> * diagnosis in case of server crash (HBASE-4014).<a name="line.99"></a> +<span class="sourceLineNo">100</span> */<a name="line.100"></a> +<span class="sourceLineNo">101</span> private static Set<String> coprocessorNames =<a name="line.101"></a> +<span class="sourceLineNo">102</span> Collections.synchronizedSet(new HashSet<String>());<a name="line.102"></a> +<span class="sourceLineNo">103</span><a name="line.103"></a> +<span class="sourceLineNo">104</span> public static Set<String> getLoadedCoprocessors() {<a name="line.104"></a> +<span class="sourceLineNo">105</span> synchronized (coprocessorNames) {<a name="line.105"></a> +<span class="sourceLineNo">106</span> return new HashSet(coprocessorNames);<a name="line.106"></a> +<span class="sourceLineNo">107</span> }<a name="line.107"></a> +<span class="sourceLineNo">108</span> }<a name="line.108"></a> +<span class="sourceLineNo">109</span><a name="line.109"></a> +<span class="sourceLineNo">110</span> /**<a name="line.110"></a> +<span class="sourceLineNo">111</span> * Used to create a parameter to the HServerLoad constructor so that<a name="line.111"></a> +<span class="sourceLineNo">112</span> * HServerLoad can provide information about the coprocessors loaded by this<a name="line.112"></a> +<span class="sourceLineNo">113</span> * regionserver.<a name="line.113"></a> +<span class="sourceLineNo">114</span> * (HBASE-4070: Improve region server metrics to report loaded coprocessors<a name="line.114"></a> +<span class="sourceLineNo">115</span> * to master).<a name="line.115"></a> +<span class="sourceLineNo">116</span> */<a name="line.116"></a> +<span class="sourceLineNo">117</span> public Set<String> getCoprocessors() {<a name="line.117"></a> +<span class="sourceLineNo">118</span> Set<String> returnValue = new TreeSet<>();<a name="line.118"></a> +<span class="sourceLineNo">119</span> for (E e: coprocEnvironments) {<a name="line.119"></a> +<span class="sourceLineNo">120</span> returnValue.add(e.getInstance().getClass().getSimpleName());<a name="line.120"></a> +<span class="sourceLineNo">121</span> }<a name="line.121"></a> +<span class="sourceLineNo">122</span> return returnValue;<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> * Load system coprocessors once only. Read the class names from configuration.<a name="line.126"></a> +<span class="sourceLineNo">127</span> * Called by constructor.<a name="line.127"></a> +<span class="sourceLineNo">128</span> */<a name="line.128"></a> +<span class="sourceLineNo">129</span> protected void loadSystemCoprocessors(Configuration conf, String confKey) {<a name="line.129"></a> +<span class="sourceLineNo">130</span> boolean coprocessorsEnabled = conf.getBoolean(COPROCESSORS_ENABLED_CONF_KEY,<a name="line.130"></a> +<span class="sourceLineNo">131</span> DEFAULT_COPROCESSORS_ENABLED);<a name="line.131"></a> +<span class="sourceLineNo">132</span> if (!coprocessorsEnabled) {<a name="line.132"></a> +<span class="sourceLineNo">133</span> return;<a name="line.133"></a> +<span class="sourceLineNo">134</span> }<a name="line.134"></a> +<span class="sourceLineNo">135</span><a name="line.135"></a> +<span class="sourceLineNo">136</span> Class<?> implClass;<a name="line.136"></a> +<span class="sourceLineNo">137</span><a name="line.137"></a> +<span class="sourceLineNo">138</span> // load default coprocessors from configure file<a name="line.138"></a> +<span class="sourceLineNo">139</span> String[] defaultCPClasses = conf.getStrings(confKey);<a name="line.139"></a> +<span class="sourceLineNo">140</span> if (defaultCPClasses == null || defaultCPClasses.length == 0)<a name="line.140"></a> +<span class="sourceLineNo">141</span> return;<a name="line.141"></a> +<span class="sourceLineNo">142</span><a name="line.142"></a> +<span class="sourceLineNo">143</span> int priority = Coprocessor.PRIORITY_SYSTEM;<a name="line.143"></a> +<span class="sourceLineNo">144</span> for (String className : defaultCPClasses) {<a name="line.144"></a> +<span class="sourceLineNo">145</span> className = className.trim();<a name="line.145"></a> +<span class="sourceLineNo">146</span> if (findCoprocessor(className) != null) {<a name="line.146"></a> +<span class="sourceLineNo">147</span> // If already loaded will just continue<a name="line.147"></a> +<span class="sourceLineNo">148</span> LOG.warn("Attempted duplicate loading of " + className + "; skipped");<a name="line.148"></a> +<span class="sourceLineNo">149</span> continue;<a name="line.149"></a> +<span class="sourceLineNo">150</span> }<a name="line.150"></a> +<span class="sourceLineNo">151</span> ClassLoader cl = this.getClass().getClassLoader();<a name="line.151"></a> +<span class="sourceLineNo">152</span> Thread.currentThread().setContextClassLoader(cl);<a name="line.152"></a> +<span class="sourceLineNo">153</span> try {<a name="line.153"></a> +<span class="sourceLineNo">154</span> implClass = cl.loadClass(className);<a name="line.154"></a> +<span class="sourceLineNo">155</span> // Add coprocessors as we go to guard against case where a coprocessor is specified twice<a name="line.155"></a> +<span class="sourceLineNo">156</span> // in the configuration<a name="line.156"></a> +<span class="sourceLineNo">157</span> E env = checkAndLoadInstance(implClass, priority, conf);<a name="line.157"></a> +<span class="sourceLineNo">158</span> if (env != null) {<a name="line.158"></a> +<span class="sourceLineNo">159</span> this.coprocEnvironments.add(env);<a name="line.159"></a> +<span class="sourceLineNo">160</span> LOG.info(<a name="line.160"></a> +<span class="sourceLineNo">161</span> "System coprocessor " + className + " was loaded " + "successfully with priority (" + priority + ").");<a name="line.161"></a> +<span class="sourceLineNo">162</span> ++priority;<a name="line.162"></a> +<span class="sourceLineNo">163</span> }<a name="line.163"></a> +<span class="sourceLineNo">164</span> } catch (Throwable t) {<a name="line.164"></a> +<span class="sourceLineNo">165</span> // We always abort if system coprocessors cannot be loaded<a name="line.165"></a> +<span class="sourceLineNo">166</span> abortServer(className, t);<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> }<a name="line.169"></a> +<span class="sourceLineNo">170</span><a name="line.170"></a> +<span class="sourceLineNo">171</span> /**<a name="line.171"></a> +<span class="sourceLineNo">172</span> * Load a coprocessor implementation into the host<a name="line.172"></a> +<span class="sourceLineNo">173</span> * @param path path to implementation jar<a name="line.173"></a> +<span class="sourceLineNo">174</span> * @param className the main class name<a name="line.174"></a> +<span class="sourceLineNo">175</span> * @param priority chaining priority<a name="line.175"></a> +<span class="sourceLineNo">176</span> * @param conf configuration for coprocessor<a name="line.176"></a> +<span class="sourceLineNo">177</span> * @throws java.io.IOException Exception<a name="line.177"></a> +<span class="sourceLineNo">178</span> */<a name="line.178"></a> +<span class="sourceLineNo">179</span> public E load(Path path, String className, int priority,<a name="line.179"></a> +<span class="sourceLineNo">180</span> Configuration conf) throws IOException {<a name="line.180"></a> +<span class="sourceLineNo">181</span> String[] includedClassPrefixes = null;<a name="line.181"></a> +<span class="sourceLineNo">182</span> if (conf.get(HConstants.CP_HTD_ATTR_INCLUSION_KEY) != null){<a name="line.182"></a> +<span class="sourceLineNo">183</span> String prefixes = conf.get(HConstants.CP_HTD_ATTR_INCLUSION_KEY);<a name="line.183"></a> +<span class="sourceLineNo">184</span> includedClassPrefixes = prefixes.split(";");<a name="line.184"></a> +<span class="sourceLineNo">185</span> }<a name="line.185"></a> +<span class="sourceLineNo">186</span> return load(path, className, priority, conf, includedClassPrefixes);<a name="line.186"></a> +<span class="sourceLineNo">187</span> }<a name="line.187"></a> +<span class="sourceLineNo">188</span><a name="line.188"></a> +<span class="sourceLineNo">189</span> /**<a name="line.189"></a> +<span class="sourceLineNo">190</span> * Load a coprocessor implementation into the host<a name="line.190"></a> +<span class="sourceLineNo">191</span> * @param path path to implementation jar<a name="line.191"></a> +<span class="sourceLineNo">192</span> * @param className the main class name<a name="line.192"></a> +<span class="sourceLineNo">193</span> * @param priority chaining priority<a name="line.193"></a> +<span class="sourceLineNo">194</span> * @param conf configuration for coprocessor<a name="line.194"></a> +<span class="sourceLineNo">195</span> * @param includedClassPrefixes class name prefixes to include<a name="line.195"></a> +<span class="sourceLineNo">196</span> * @throws java.io.IOException Exception<a name="line.196"></a> +<span class="sourceLineNo">197</span> */<a name="line.197"></a> +<span class="sourceLineNo">198</span> public E load(Path path, String className, int priority,<a name="line.198"></a> +<span class="sourceLineNo">199</span> Configuration conf, String[] includedClassPrefixes) throws IOException {<a name="line.199"></a> +<span class="sourceLineNo">200</span> Class<?> implClass;<a name="line.200"></a> +<span class="sourceLineNo">201</span> LOG.debug("Loading coprocessor class " + className + " with path " +<a name="line.201"></a> +<span class="sourceLineNo">202</span> path + " and priority " + priority);<a name="line.202"></a> +<span class="sourceLineNo">203</span><a name="line.203"></a> +<span class="sourceLineNo">204</span> ClassLoader cl = null;<a name="line.204"></a> +<span class="sourceLineNo">205</span> if (path == null) {<a name="line.205"></a> +<span class="sourceLineNo">206</span> try {<a name="line.206"></a> +<span class="sourceLineNo">207</span> implClass = getClass().getClassLoader().loadClass(className);<a name="line.207"></a> +<span class="sourceLineNo">208</span> } catch (ClassNotFoundException e) {<a name="line.208"></a> +<span class="sourceLineNo">209</span> throw new IOException("No jar path specified for " + className);<a name="line.209"></a> +<span class="sourceLineNo">210</span> }<a name="line.210"></a> +<span class="sourceLineNo">211</span> } else {<a name="line.211"></a> +<span class="sourceLineNo">212</span> cl = CoprocessorClassLoader.getClassLoader(<a name="line.212"></a> +<span class="sourceLineNo">213</span> path, getClass().getClassLoader(), pathPrefix, conf);<a name="line.213"></a> +<span class="sourceLineNo">214</span> try {<a name="line.214"></a> +<span class="sourceLineNo">215</span> implClass = ((CoprocessorClassLoader)cl).loadClass(className, includedClassPrefixes);<a name="line.215"></a> +<span class="sourceLineNo">216</span> } catch (ClassNotFoundException e) {<a name="line.216"></a> +<span class="sourceLineNo">217</span> throw new IOException("Cannot load external coprocessor class " + className, e);<a name="line.217"></a> +<span class="sourceLineNo">218</span> }<a name="line.218"></a> +<span class="sourceLineNo">219</span> }<a name="line.219"></a> +<span class="sourceLineNo">220</span><a name="line.220"></a> +<span class="sourceLineNo">221</span> //load custom code for coprocessor<a name="line.221"></a> +<span class="sourceLineNo">222</span> Thread currentThread = Thread.currentThread();<a name="line.222"></a> +<span class="sourceLineNo">223</span> ClassLoader hostClassLoader = currentThread.getContextClassLoader();<a name="line.223"></a> +<span class="sourceLineNo">224</span> try{<a name="line.224"></a> +<span class="sourceLineNo">225</span> // switch temporarily to the thread classloader for custom CP<a name="line.225"></a> +<span class="sourceLineNo">226</span> currentThread.setContextClassLoader(cl);<a name="line.226"></a> +<span class="sourceLineNo">227</span> E cpInstance = checkAndLoadInstance(implClass, priority, conf);<a name="line.227"></a> +<span class="sourceLineNo">228</span> return cpInstance;<a name="line.228"></a> +<span class="sourceLineNo">229</span> } finally {<a name="line.229"></a> +<span class="sourceLineNo">230</span> // restore the fresh (host) classloader<a name="line.230"></a> +<span class="sourceLineNo">231</span> currentThread.setContextClassLoader(hostClassLoader);<a name="line.231"></a> +<span class="sourceLineNo">232</span> }<a name="line.232"></a> +<span class="sourceLineNo">233</span> }<a name="line.233"></a> +<span class="sourceLineNo">234</span><a name="line.234"></a> +<span class="sourceLineNo">235</span> @VisibleForTesting<a name="line.235"></a> +<span class="sourceLineNo">236</span> public void load(Class<? extends C> implClass, int priority, Configuration conf)<a name="line.236"></a> +<span class="sourceLineNo">237</span> throws IOException {<a name="line.237"></a> +<span class="sourceLineNo">238</span> E env = checkAndLoadInstance(implClass, priority, conf);<a name="line.238"></a> +<span class="sourceLineNo">239</span> coprocEnvironments.add(env);<a name="line.239"></a> +<span class="sourceLineNo">240</span> }<a name="line.240"></a> +<span class="sourceLineNo">241</span><a name="line.241"></a> +<span class="sourceLineNo">242</span> /**<a name="line.242"></a> +<span class="sourceLineNo">243</span> * @param implClass Implementation class<a name="line.243"></a> +<span class="sourceLineNo">244</span> * @param priority priority<a name="line.244"></a> +<span class="sourceLineNo">245</span> * @param conf configuration<a name="line.245"></a> +<span class="sourceLineNo">246</span> * @throws java.io.IOException Exception<a name="line.246"></a> +<span class="sourceLineNo">247</span> */<a name="line.247"></a> +<span class="sourceLineNo">248</span> public E checkAndLoadInstance(Class<?> implClass, int priority, Configuration conf)<a name="line.248"></a> +<span class="sourceLineNo">249</span> throws IOException {<a name="line.249"></a> +<span class="sourceLineNo">250</span> // create the instance<a name="line.250"></a> +<span class="sourceLineNo">251</span> C impl;<a name="line.251"></a> +<span class="sourceLineNo">252</span> try {<a name="line.252"></a> +<span class="sourceLineNo">253</span> impl = checkAndGetInstance(implClass);<a name="line.253"></a> +<span class="sourceLineNo">254</span> if (impl == null) {<a name="line.254"></a> +<span class="sourceLineNo">255</span> LOG.error("Cannot load coprocessor " + implClass.getSimpleName());<a name="line.255"></a> +<span class="sourceLineNo">256</span> return null;<a name="line.256"></a> +<span class="sourceLineNo">257</span> }<a name="line.257"></a> +<span class="sourceLineNo">258</span> } catch (InstantiationException|IllegalAccessException e) {<a name="line.258"></a> +<span class="sourceLineNo">259</span> throw new IOException(e);<a name="line.259"></a> +<span class="sourceLineNo">260</span> }<a name="line.260"></a> +<span class="sourceLineNo">261</span> // create the environment<a name="line.261"></a> +<span class="sourceLineNo">262</span> E env = createEnvironment(impl, priority, loadSequence.incrementAndGet(), conf);<a name="line.262"></a> +<span class="sourceLineNo">263</span> env.startup();<a name="line.263"></a> +<span class="sourceLineNo">264</span> // HBASE-4014: maintain list of loaded coprocessors for later crash analysis<a name="line.264"></a> +<span class="sourceLineNo">265</span> // if server (master or regionserver) aborts.<a name="line.265"></a> +<span class="sourceLineNo">266</span> coprocessorNames.add(implClass.getName());<a name="line.266"></a> +<span class="sourceLineNo">267</span> return env;<a name="line.267"></a> +<span class="sourceLineNo">268</span> }<a name="line.268"></a> +<span class="sourceLineNo">269</span><a name="line.269"></a> +<span class="sourceLineNo">270</span> /**<a name="line.270"></a> +<span class="sourceLineNo">271</span> * Called when a new Coprocessor class is loaded<a name="line.271"></a> +<span class="sourceLineNo">272</span> */<a name="line.272"></a> +<span class="sourceLineNo">273</span> public abstract E createEnvironment(C instance, int priority, int sequence, Configuration conf);<a name="line.273"></a> +<span class="sourceLineNo">274</span><a name="line.274"></a> +<span class="sourceLineNo">275</span> /**<a name="line.275"></a> +<span class="sourceLineNo">276</span> * Called when a new Coprocessor class needs to be loaded. Checks if type of the given class<a name="line.276"></a> +<span class="sourceLineNo">277</span> * is what the corresponding host implementation expects. If it is of correct type, returns an<a name="line.277"></a> +<span class="sourceLineNo">278</span> * instance of the coprocessor to be loaded. If not, returns null.<a name="line.278"></a> +<span class="sourceLineNo">279</span> * If an exception occurs when trying to create instance of a coprocessor, it's passed up and<a name="line.279"></a> +<span class="sourceLineNo">280</span> * eventually results into server aborting.<a name="line.280"></a> +<span class="sourceLineNo">281</span> */<a name="line.281"></a> +<span class="sourceLineNo">282</span> public abstract C checkAndGetInstance(Class<?> implClass)<a name="line.282"></a> +<span class="sourceLineNo">283</span> throws InstantiationException, IllegalAccessException;<a name="line.283"></a> +<span class="sourceLineNo">284</span><a name="line.284"></a> +<span class="sourceLineNo">285</span> public void shutdown(E e) {<a name="line.285"></a> +<span class="sourceLineNo">286</span> if (LOG.isDebugEnabled()) {<a name="line.286"></a> +<span class="sourceLineNo">287</span> LOG.debug("Stop coprocessor " + e.getInstance().getClass().getName());<a name="line.287"></a> +<span class="sourceLineNo">288</span> }<a name="line.288"></a> +<span class="sourceLineNo">289</span> e.shutdown();<a name="line.289"></a> +<span class="sourceLineNo">290</span> }<a name="line.290"></a> +<span class="sourceLineNo">291</span><a name="line.291"></a> +<span class="sourceLineNo">292</span> /**<a name="line.292"></a> +<span class="sourceLineNo">293</span> * Find coprocessors by full class name or simple name.<a name="line.293"></a> +<span class="sourceLineNo">294</span> */<a name="line.294"></a> +<span class="sourceLineNo">295</span> public C findCoprocessor(String className) {<a name="line.295"></a> +<span class="sourceLineNo">296</span> for (E env: coprocEnvironments) {<a name="line.296"></a> +<span class="sourceLineNo">297</span> if (env.getInstance().getClass().getName().equals(className) ||<a name="line.297"></a> +<span class="sourceLineNo">298</span> env.getInstance().getClass().getSimpleName().equals(className)) {<a name="line.298"></a> +<span class="sourceLineNo">299</span> return env.getInstance();<a name="line.299"></a> +<span class="sourceLineNo">300</span> }<a name="line.300"></a> +<span class="sourceLineNo">301</span> }<a name="line.301"></a> +<span class="sourceLineNo">302</span> return null;<a name="line.302"></a> +<span class="sourceLineNo">303</span> }<a name="line.303"></a> +<span class="sourceLineNo">304</span><a name="line.304"></a> +<span class="sourceLineNo">305</span> @VisibleForTesting<a name="line.305"></a> +<span class="sourceLineNo">306</span> public <T extends C> T findCoprocessor(Class<T> cls) {<a name="line.306"></a> +<span class="sourceLineNo">307</span> for (E env: coprocEnvironments) {<a name="line.307"></a> +<span class="sourceLineNo">308</span> if (cls.isAssignableFrom(env.getInstance().getClass())) {<a name="line.308"></a> +<span class="sourceLineNo">309</span> return (T) env.getInstance();<a name="line.309"></a> +<span class="sourceLineNo">310</span> }<a name="line.310"></a> +<span class="sourceLineNo">311</span> }<a name="line.311"></a> +<span class="sourceLineNo">312</span> return null;<a name="line.312"></a> +<span class="sourceLineNo">313</span> }<a name="line.313"></a> +<span class="sourceLineNo">314</span><a name="line.314"></a> +<span class="sourceLineNo">315</span> /**<a name="line.315"></a> +<span class="sourceLineNo">316</span> * Find list of coprocessors that extend/implement the given class/interface<a name="line.316"></a> +<span class="sourceLineNo">317</span> * @param cls the class/interface to look for<a name="line.317"></a> +<span class="sourceLineNo">318</span> * @return the list of coprocessors, or null if not found<a name="line.318"></a> +<span class="sourceLineNo">319</span> */<a name="line.319"></a> +<span class="sourceLineNo">320</span> public <T extends C> List<T> findCoprocessors(Class<T> cls) {<a name="line.320"></a> +<span class="sourceLineNo">321</span> ArrayList<T> ret = new ArrayList<>();<a name="line.321"></a> +<span class="sourceLineNo">322</span><a name="line.322"></a> +<span class="sourceLineNo">323</span> for (E env: coprocEnvironments) {<a name="line.323"></a> +<span class="sourceLineNo">324</span> C cp = env.getInstance();<a name="line.324"></a> <span class="sourceLineNo">325</span><a name="line.325"></a> -<span class="sourceLineNo">326</span> for (E env: coprocEnvironments) {<a name="line.326"></a> -<span class="sourceLineNo">327</span> C cp = env.getInstance();<a name="line.327"></a> -<span class="sourceLineNo">328</span><a name="line.328"></a> -<span class="sourceLineNo">329</span> if(cp != null) {<a name="line.329"></a> -<span class="sourceLineNo">330</span> if (cls.isAssignableFrom(cp.getClass())) {<a name="line.330"></a> -<span class="sourceLineNo">331</span> ret.add((T)cp);<a name="line.331"></a> -<span class="sourceLineNo">332</span> }<a name="line.332"></a> -<span class="sourceLineNo">333</span> }<a name="line.333"></a> -<span class="sourceLineNo">334</span> }<a name="line.334"></a> -<span class="sourceLineNo">335</span> return ret;<a name="line.335"></a> -<span class="sourceLineNo">336</span> }<a name="line.336"></a> -<span class="sourceLineNo">337</span><a name="line.337"></a> -<span class="sourceLineNo">338</span> /**<a name="line.338"></a> -<span class="sourceLineNo">339</span> * Find a coprocessor environment by class name<a name="line.339"></a> -<span class="sourceLineNo">340</span> * @param className the class name<a name="line.340"></a> -<span class="sourceLineNo">341</span> * @return the coprocessor, or null if not found<a name="line.341"></a> -<span class="sourceLineNo">342</span> */<a name="line.342"></a> -<span class="sourceLineNo">343</span> @VisibleForTesting<a name="line.343"></a> -<span class="sourceLineNo">344</span> public E findCoprocessorEnvironment(String className) {<a name="line.344"></a> -<span class="sourceLineNo">345</span> for (E env: coprocEnvironments) {<a name="line.345"></a> -<span class="sourceLineNo">346</span> if (env.getInstance().getClass().getName().equals(className) ||<a name="line.346"></a> -<span class="sourceLineNo">347</span> env.getInstance().getClass().getSimpleName().equals(className)) {<a name="line.347"></a> -<span class="sourceLineNo">348</span> return env;<a name="line.348"></a> -<span class="sourceLineNo">349</span> }<a name="line.349"></a> -<span class="sourceLineNo">350</span> }<a name="line.350"></a> -<span class="sourceLineNo">351</span> return null;<a name="line.351"></a> -<span class="sourceLineNo">352</span> }<a name="line.352"></a> -<span class="sourceLineNo">353</span><a name="line.353"></a> -<span class="sourceLineNo">354</span> /**<a name="line.354"></a> -<span class="sourceLineNo">355</span> * Retrieves the set of classloaders used to instantiate Coprocessor classes defined in external<a name="line.355"></a> -<span class="sourceLineNo">356</span> * jar files.<a name="line.356"></a> -<span class="sourceLineNo">357</span> * @return A set of ClassLoader instances<a name="line.357"></a> -<span class="sourceLineNo">358</span> */<a name="line.358"></a> -<span class="sourceLineNo">359</span> Set<ClassLoader> getExternalClassLoaders() {<a name="line.359"></a> -<span class="sourceLineNo">360</span> Set<ClassLoader> externalClassLoaders = new HashSet<>();<a name="line.360"></a> -<span class="sourceLineNo">361</span> final ClassLoader systemClassLoader = this.getClass().getClassLoader();<a name="line.361"></a> -<span class="sourceLineNo">362</span> for (E env : coprocEnvironments) {<a name="line.362"></a> -<span class="sourceLineNo">363</span> ClassLoader cl = env.getInstance().getClass().getClassLoader();<a name="line.363"></a> -<span class="sourceLineNo">364</span> if (cl != systemClassLoader){<a name="line.364"></a> -<span class="sourceLineNo">365</span> //do not include system classloader<a name="line.365"></a> -<span class="sourceLineNo">366</span> externalClassLoaders.add(cl);<a name="line.366"></a> -<span class="sourceLineNo">367</span> }<a name="line.367"></a> -<span class="sourceLineNo">368</span> }<a name="line.368"></a> -<span class="sourceLineNo">369</span> return externalClassLoaders;<a name="line.369"></a> -<span class="sourceLineNo">370</span> }<a name="line.370"></a> -<span class="sourceLineNo">371</span><a name="line.371"></a> -<span class="sourceLineNo">372</span> /**<a name="line.372"></a> -<span class="sourceLineNo">373</span> * Environment priority comparator.<a name="line.373"></a> -<span class="sourceLineNo">374</span> * Coprocessors are chained in sorted order.<a name="line.374"></a> -<span class="sourceLineNo">375</span> */<a name="line.375"></a> -<span class="sourceLineNo">376</span> static class EnvironmentPriorityComparator implements Comparator<CoprocessorEnvironment> {<a name="line.376"></a> -<span class="sourceLineNo">377</span> @Override<a name="line.377"></a> -<span class="sourceLineNo">378</span> public int compare(final CoprocessorEnvironment env1,<a name="line.378"></a> -<span class="sourceLineNo">379</span> final CoprocessorEnvironment env2) {<a name="line.379"></a> -<span class="sourceLineNo">380</span> if (env1.getPriority() < env2.getPriority()) {<a name="line.380"></a> -<span class="sourceLineNo">381</span> return -1;<a name="line.381"></a> -<span class="sourceLineNo">382</span> } else if (env1.getPriority() > env2.getPriority()) {<a name="line.382"></a> -<span class="sourceLineNo">383</span> return 1;<a name="line.383"></a> -<span class="sourceLineNo">384</span> }<a name="line.384"></a> -<span class="sourceLineNo">385</span> if (env1.getLoadSequence() < env2.getLoadSequence()) {<a name="line.385"></a> -<span class="sourceLineNo">386</span> return -1;<a name="line.386"></a> -<span class="sourceLineNo">387</span> } else if (env1.getLoadSequence() > env2.getLoadSequence()) {<a name="line.387"></a> -<span class="sourceLineNo">388</span> return 1;<a name="line.388"></a> -<span class="sourceLineNo">389</span> }<a name="line.389"></a> -<span class="sourceLineNo">390</span> return 0;<a name="line.390"></a> -<span class="sourceLineNo">391</span> }<a name="line.391"></a> -<span class="sourceLineNo">392</span> }<a name="line.392"></a> -<span class="sourceLineNo">393</span><a name="line.393"></a> -<span class="sourceLineNo">394</span> protected void abortServer(final E environment, final Throwable e) {<a name="line.394"></a> -<span class="sourceLineNo">395</span> abortServer(environment.getInstance().getClass().getName(), e);<a name="line.395"></a> -<span class="sourceLineNo">396</span> }<a name="line.396"></a> -<span class="sourceLineNo">397</span><a name="line.397"></a> -<span class="sourceLineNo">398</span> protected void abortServer(final String coprocessorName, final Throwable e) {<a name="line.398"></a> -<span class="sourceLineNo">399</span> String message = "The coprocessor " + coprocessorName + " threw " + e.toString();<a name="line.399"></a> -<span class="sourceLineNo">400</span> LOG.error(message, e);<a name="line.400"></a> -<span class="sourceLineNo">401</span> if (abortable != null) {<a name="line.401"></a> -<span class="sourceLineNo">402</span> abortable.abort(message, e);<a name="line.402"></a> -<span class="sourceLineNo">403</span> } else {<a name="line.403"></a> -<span class="sourceLineNo">404</span> LOG.warn("No available Abortable, process was not aborted");<a name="line.404"></a> -<span class="sourceLineNo">405</span> }<a name="line.405"></a> -<span class="sourceLineNo">406</span> }<a name="line.406"></a> -<span class="sourceLineNo">407</span><a name="line.407"></a> -<span class="sourceLineNo">408</span> /**<a name="line.408"></a> -<span class="sourceLineNo">409</span> * This is used by coprocessor hooks which are declared to throw IOException<a name="line.409"></a> -<span class="sourceLineNo">410</span> * (or its subtypes). For such hooks, we should handle throwable objects<a name="line.410"></a> -<span class="sourceLineNo">411</span> * depending on the Throwable's type. Those which are instances of<a name="line.411"></a> -<span class="sourceLineNo">412</span> * IOException should be passed on to the client. This is in conformance with<a name="line.412"></a> -<span class="sourceLineNo">413</span> * the HBase idiom regarding IOException: that it represents a circumstance<a name="line.413"></a> -<span class="sourceLineNo">414</span> * that should be passed along to the client for its own handling. For<a name="line.414"></a> -<span class="sourceLineNo">415</span> * example, a coprocessor that implements access controls would throw a<a name="line.415"></a> -<span class="sourceLineNo">416</span> * subclass of IOException, such as AccessDeniedException, in its preGet()<a name="line.416"></a> -<span class="sourceLineNo">417</span> * method to prevent an unauthorized client's performing a Get on a particular<a name="line.417"></a> -<span class="sourceLineNo">418</span> * table.<a name="line.418"></a> -<span class="sourceLineNo">419</span> * @param env Coprocessor Environment<a name="line.419"></a> -<span class="sourceLineNo">420</span> * @param e Throwable object thrown by coprocessor.<a name="line.420"></a> -<span class="sourceLineNo">421</span> * @exception IOException Exception<a name="line.421"></a> -<span class="sourceLineNo">422</span> */<a name="line.422"></a> -<span class="sourceLineNo">423</span> // Note to devs: Class comments of all observers ({@link MasterObserver}, {@link WALObserver},<a name="line.423"></a> -<span class="sourceLineNo">424</span> // etc) mention this nuance of our exception handling so that coprocessor can throw appropriate<a name="line.424"></a> -<span class="sourceLineNo">425</span> // exceptions depending on situation. If any changes are made to this logic, make sure to<a name="line.425"></a> -<span class="sourceLineNo">426</span> // update all classes' comments.<a name="line.426"></a> -<span class="sourceLineNo">427</span> protected void handleCoprocessorThrowable(final E env, final Throwable e) throws IOException {<a name="line.427"></a> -<span class="sourceLineNo">428</span> if (e instanceof IOException) {<a name="line.428"></a> -<span class="sourceLineNo">429</span> throw (IOException)e;<a name="line.429"></a> -<span class="sourceLineNo">430</span> }<a name="line.430"></a> -<span class="sourceLineNo">431</span> // If we got here, e is not an IOException. A loaded coprocessor has a<a name="line.431"></a> -<span class="sourceLineNo">432</span> // fatal bug, and the server (master or regionserver) should remove the<a name="line.432"></a> -<span class="sourceLineNo">433</span> // faulty coprocessor from its set of active coprocessors. Setting<a name="line.433"></a> -<span class="sourceLineNo">434</span> // 'hbase.coprocessor.abortonerror' to true will cause abortServer(),<a name="line.434"></a> -<span class="sourceLineNo">435</span> // which may be useful in development and testing environments where<a name="line.435"></a> -<span class="sourceLineNo">436</span> // 'failing fast' for error analysis is desired.<a name="line.436"></a> -<span class="sourceLineNo">437</span> if (env.getConfiguration().getBoolean(ABORT_ON_ERROR_KEY, DEFAULT_ABORT_ON_ERROR)) {<a name="line.437"></a> -<span class="sourceLineNo">438</span> // server is configured to abort.<a name="line.438"></a> -<span class="sourceLineNo">439</span> abortServer(env, e);<a name="line.439"></a> -<span class="sourceLineNo">440</span> } else {<a name="line.440"></a> -<span class="sourceLineNo">441</span> // If available, pull a table name out of the environment<a name="line.441"></a> -<span class="sourceLineNo">442</span> if(env instanceof RegionCoprocessorEnvironment) {<a name="line.442"></a> -<span class="sourceLineNo">443</span> String tableName = ((RegionCoprocessorEnvironment)env).getRegionInfo().getTable().getNameAsString();<a name="line.443"></a> -<span class="sourceLineNo">444</span> LOG.error("Removing coprocessor '" + env.toString() + "' from table '"+ tableName + "'", e);<a name="line.444"></a> -<span class="sourceLineNo">445</span> } else {<a name="line.445"></a> -<span class="sourceLineNo">446</span> LOG.error("Removing coprocessor '" + env.toString() + "' from " +<a name="line.446"></a> -<span class="sourceLineNo">447</span> "environment",e);<a name="line.447"></a> -<span class="sourceLineNo">448</span> }<a name="line.448"></a> -<span class="sourceLineNo">449</span><a name="line.449"></a> -<span class="sourceLineNo">450</span> coprocEnvironments.remove(env);<a name="line.450"></a> -<span class="sourceLineNo">451</span> try {<a name="line.451"></a> -<span class="sourceLineNo">452</span> shutdown(env);<a name="line.452"></a> -<span class="sourceLineNo">453</span> } catch (Exception x) {<a name="line.453"></a> -<span class="sourceLineNo">454</span> LOG.error("Uncaught exception when shutting down coprocessor '"<a name="line.454"></a> -<span class="sourceLineNo">455</span> + env.toString() + "'", x);<a name="line.455"></a> -<span class="sourceLineNo">456</span> }<a name="line.456"></a> -<span class="sourceLineNo">457</span> throw new DoNotRetryIOException("Coprocessor: '" + env.toString() +<a name="line.457"></a> -<span class="sourceLineNo">458</span> "' threw: '" + e + "' and has been removed from the active " +<a name="line.458"></a> -<span class="sourceLineNo">459</span> "coprocessor set.", e);<a name="line.459"></a> -<span class="sourceLineNo">460</span> }<a name="line.460"></a> -<span class="sourceLineNo">461</span> }<a name="line.461"></a> -<span class="sourceLineNo">462</span><a name="line.462"></a> -<span class="sourceLineNo">463</span> /**<a name="line.463"></a> -<span class="sourceLineNo">464</span> * Used to gracefully handle fallback to deprecated methods when we<a name="line.464"></a> -<span class="sourceLineNo">465</span> * evolve coprocessor APIs.<a name="line.465"></a> -<span class="sourceLineNo">466</span> *<a name="line.466"></a> -<span class="sourceLineNo">467</span> * When a particular Coprocessor API is updated to change methods, hosts can support fallback<a name="line.467"></a> -<span class="sourceLineNo">468</span> * to the deprecated API by using this method to determine if an instance implements the new API.<a name="line.468"></a> -<span class="sourceLineNo">469</span> * In the event that said support is partial, then in the face of a runtime issue that prevents<a name="line.469"></a> -<span class="sourceLineNo">470</span> * proper operation {@link #legacyWarning(Class, String)} should be used to let operators know.<a name="line.470"></a> -<span class="sourceLineNo">471</span> *<a name="line.471"></a> -<span class="sourceLineNo">472</span> * For examples of this in action, see the implementation of<a name="line.472"></a> -<span class="sourceLineNo">473</span> * <ul><a name="line.473"></a> -<span class="sourceLineNo">474</span> * <li>{@link org.apache.hadoop.hbase.regionserver.RegionCoprocessorHost}<a name="line.474"></a> -<span class="sourceLineNo">475</span> * <li>{@link org.apache.hadoop.hbase.regionserver.wal.WALCoprocessorHost}<a name="line.475"></a> -<span class="sourceLineNo">476</span> * </ul><a name="line.476"></a> -<span class="sourceLineNo">477</span> *<a name="line.477"></a> -<span class="sourceLineNo">478</span> * @param clazz Coprocessor you wish to evaluate<a name="line.478"></a> -<span class="sourceLineNo">479</span> * @param methodName the name of the non-deprecated method version<a name="line.479"></a> -<span class="sourceLineNo">480</span> * @param parameterTypes the Class of the non-deprecated method's arguments in the order they are<a name="line.480"></a> -<span class="sourceLineNo">481</span> * declared.<a name="line.481"></a> -<span class="sourceLineNo">482</span> */<a name="line.482"></a> -<span class="sourceLineNo">483</span> @InterfaceAudience.Private<a name="line.483"></a> -<span class="sourceLineNo">484</span> protected static boolean useLegacyMethod(final Class<? extends Coprocessor> clazz,<a name="line.484"></a> -<span class="sourceLineNo">485</span> final String methodName, final Class<?>... parameterTypes) {<a name="line.485"></a> -<span class="sourceLineNo">486</span> boolean useLegacy;<a name="line.486"></a> -<span class="sourceLineNo">487</span> // Use reflection to see if they implement the non-deprecated version<a name="line.487"></a> -<span class="sourceLineNo">488</span> try {<a name="line.488"></a> -<span class="sourceLineNo">489</span> clazz.getDeclaredMethod(methodName, parameterTypes);<a name="line.489"></a> -<span class="sourceLineNo">490</span> LOG.debug("Found an implementation of '" + methodName + "' that uses updated method " +<a name="line.490"></a> -<span class="sourceLineNo">491</span> "signature. Skipping legacy support for invocations in '" + clazz +"'.");<a name="line.491"></a> -<span class="sourceLineNo">492</span> useLegacy = false;<a name="line.492"></a> -<span class="sourceLineNo">493</span> } catch (NoSuchMethodException exception) {<a name="line.493"></a> -<span class="sourceLineNo">494</span> useLegacy = true;<a name="line.494"></a> -<span class="sourceLineNo">495</span> } catch (SecurityException exception) {<a name="line.495"></a> -<span class="sourceLineNo">496</span> LOG.warn("The Security Manager denied our attempt to detect if the coprocessor '" + clazz +<a name="line.496"></a> -<span class="sourceLineNo">497</span> "' requires legacy support; assuming it does. If you get later errors about legacy " +<a name="line.497"></a> -<span class="sourceLineNo">498</span> "coprocessor use, consider updating your security policy to allow access to the package" +<a name="line.498"></a> -<span class="sourceLineNo">499</span> " and declared members of your implementation.");<a name="line.499"></a> -<span class="sourceLineNo">500</span> LOG.debug("Details of Security Manager rejection.", exception);<a name="line.500"></a> -<span class="sourceLineNo">501</span> useLegacy = true;<a name="line.501"></a> -<span class="sourceLineNo">502</span> }<a name="line.502"></a> -<span class="sourceLineNo">503</span> return useLegacy;<a name="line.503"></a> -<span class="sourceLineNo">504</span> }<a name="line.504"></a> -<span class="sourceLineNo">505</span><a name="line.505"></a> -<span class="sourceLineNo">506</span> /**<a name="line.506"></a> -<span class="sourceLineNo">507</span> * Used to limit legacy handling to once per Coprocessor class per classloader.<a name="line.507"></a> -<span class="sourceLineNo">508</span> */<a name="line.508"></a> -<span class="sourceLineNo">509</span> private static final Set<Class<? extends Coprocessor>> legacyWarning =<a name="line.509"></a> -<span class="sourceLineNo">510</span> new ConcurrentSkipListSet<>(<a name="line.510"></a> -<span class="sourceLineNo">511</span> new Comparator<Class<? extends Coprocessor>>() {<a name="line.511"></a> -<span class="sourceLineNo">512</span> @Override<a name="line.512"></a> -<span class="sourceLineNo">513</span> public int compare(Class<? extends Coprocessor> c1, Class<? extends Coprocessor> c2) {<a name="line.513"></a> -<span class="sourceLineNo">514</span> if (c1.equals(c2)) {<a name="line.514"></a> -<span class="sourceLineNo">515</span> return 0;<a name="line.515"></a> -<span class="sourceLineNo">516</span> }<a name="line.516"></a> -<span class="sourceLineNo">517</span> return c1.getName().compareTo(c2.getName());<a name="line.517"></a> -<span class="sourceLineNo">518</span> }<a name="line.518"></a> -<span class="sourceLineNo">519</span> });<a name="line.519"></a> -<span class="sourceLineNo">520</span><a name="line.520"></a> -<span class="sourceLineNo">521</span> /**<a name="line.521"></a> -<span class="sourceLineNo">522</span> * limits the amount of logging to once per coprocessor class.<a name="line.522"></a> -<span class="sourceLineNo">523</span> * Used in concert with {@link #useLegacyMethod(Class, String, Class[])} when a runtime issue<a name="line.523"></a> -<span class="sourceLineNo">524</span> * prevents properly supporting the legacy version of a coprocessor API.<a name="line.524"></a> -<span class="sourceLineNo">525</span> * Since coprocessors can be in tight loops this serves to limit the amount of log spam we create.<a name="line.525"></a> -<span class="sourceLineNo">526</span> */<a name="line.526"></a> -<span class="sourceLineNo">527</span> @InterfaceAudience.Private<a name="line.527"></a> -<span class="sourceLineNo">528</span> protected void legacyWarning(final Class<? extends Coprocessor> clazz, final String message) {<a name="line.528"></a> -<span class="sourceLineNo">529</span> if(legacyWarning.add(clazz)) {<a name="line.529"></a> -<span class="sourceLineNo">530</span> LOG.error("You have a legacy coprocessor loaded and there are events we can't map to the " +<a name="line.530"></a> -<span class="sourceLineNo">531</span> " deprecated API. Your coprocessor will not see these events. Please update '" + clazz +<a name="line.531"></a> -<span class="sourceLineNo">532</span> "'. Details of the problem: " + message);<a name="line.532"></a> -<span class="sourceLineNo">533</span> }<a name="line.533"></a> -<span class="sourceLineNo">534</span> }<a name="line.534"></a> -<span class="sourceLineNo">535</span><a name="line.535"></a> -<span class="sourceLineNo">536</span> /**<a name="line.536"></a> -<span class="sourceLineNo">537</span> * Implementations defined function to get an observer of type {@code O} from a coprocessor of<a name="line.537"></a> -<span class="sourceLineNo">538</span> * type {@code C}. Concrete implementations of CoprocessorHost define one getter for each<a name="line.538"></a> -<span class="sourceLineNo">539</span> * observer they can handle. For e.g. RegionCoprocessorHost will use 3 getters, one for<a name="line.539"></a> -<span class="sourceLineNo">540</span> * each of RegionObserver, EndpointObserver and BulkLoadObserver.<a name="line.540"></a> -<span class="sourceLineNo">541</span> * These getters are used by {@code ObserverOperation} to get appropriate observer from the<a name="line.541"></a> -<span class="sourceLineNo">542</span> * coprocessor.<a name="line.542"></a> -<span class="sourceLineNo">543</span> */<a name="line.543"></a> -<span class="sourceLineNo">544</span> @FunctionalInterface<a name="line.544"></a> -<span class="sourceLineNo">545</span> public interface ObserverGetter<C, O> extends Function<C, Optional<O>> {}<a name="line.545"></a> +<span class="sourceLineNo">326</span> if(cp != null) {<a name="line.326"></a> +<span class="sourceLineNo">327</span> if (cls.isAssignableFrom(cp.getClass())) {<a name="line.327"></a> +<span class="sourceLineNo">328</span> ret.add((T)cp);<a name="line.328"></a> +<span class="sourceLineNo">329</span> }<a name="line.329"></a> +<span class="sourceLineNo">330</span> }<a name="line.330"></a> +<span class="sourceLineNo">331</span> }<a name="line.331"></a> +<span class="sourceLineNo">332</span> return ret;<a name="line.332"></a> +<span class="sourceLineNo">333</span> }<a name="line.333"></a> +<span class="sourceLineNo">334</span><a name="line.334"></a> +<span class="sourceLineNo">335</span> /**<a name="line.335"></a> +<span class="sourceLineNo">336</span> * Find a coprocessor environment by class name<a name="line.336"></a> +<span class="sourceLineNo">337</span> * @param className the class name<a name="line.337"></a> +<span class="sourceLineNo">338</span> * @return the coprocessor, or null if not found<a name="line.338"></a> +<span class="sourceLineNo">339</span> */<a name="line.339"></a> +<span class="sourceLineNo">340</span> @VisibleForTesting<a name="line.340"></a> +<span class="sourceLineNo">341</span> public E findCoprocessorEnvironment(String className) {<a name="line.341"></a> +<span class="sourceLineNo">342</span> for (E env: coproc
<TRUNCATED>