http://git-wip-us.apache.org/repos/asf/hbase-site/blob/6674e3ab/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 77fb9b5..c4e8c8b 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 @@ -165,520 +165,519 @@ <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> assert env instanceof BaseEnvironment;<a name="line.263"></a> -<span class="sourceLineNo">264</span> ((BaseEnvironment<C>) env).startup();<a name="line.264"></a> -<span class="sourceLineNo">265</span> // HBASE-4014: maintain list of loaded coprocessors for later crash analysis<a name="line.265"></a> -<span class="sourceLineNo">266</span> // if server (master or regionserver) aborts.<a name="line.266"></a> -<span class="sourceLineNo">267</span> coprocessorNames.add(implClass.getName());<a name="line.267"></a> -<span class="sourceLineNo">268</span> return env;<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> /**<a name="line.271"></a> -<span class="sourceLineNo">272</span> * Called when a new Coprocessor class is loaded<a name="line.272"></a> -<span class="sourceLineNo">273</span> */<a name="line.273"></a> -<span class="sourceLineNo">274</span> public abstract E createEnvironment(C instance, int priority, int sequence, Configuration conf);<a name="line.274"></a> -<span class="sourceLineNo">275</span><a name="line.275"></a> -<span class="sourceLineNo">276</span> /**<a name="line.276"></a> -<span class="sourceLineNo">277</span> * Called when a new Coprocessor class needs to be loaded. Checks if type of the given class<a name="line.277"></a> -<span class="sourceLineNo">278</span> * is what the corresponding host implementation expects. If it is of correct type, returns an<a name="line.278"></a> -<span class="sourceLineNo">279</span> * instance of the coprocessor to be loaded. If not, returns null.<a name="line.279"></a> -<span class="sourceLineNo">280</span> * If an exception occurs when trying to create instance of a coprocessor, it's passed up and<a name="line.280"></a> -<span class="sourceLineNo">281</span> * eventually results into server aborting.<a name="line.281"></a> -<span class="sourceLineNo">282</span> */<a name="line.282"></a> -<span class="sourceLineNo">283</span> public abstract C checkAndGetInstance(Class<?> implClass)<a name="line.283"></a> -<span class="sourceLineNo">284</span> throws InstantiationException, IllegalAccessException;<a name="line.284"></a> -<span class="sourceLineNo">285</span><a name="line.285"></a> -<span class="sourceLineNo">286</span> public void shutdown(E e) {<a name="line.286"></a> -<span class="sourceLineNo">287</span> assert e instanceof BaseEnvironment;<a name="line.287"></a> -<span class="sourceLineNo">288</span> if (LOG.isDebugEnabled()) {<a name="line.288"></a> -<span class="sourceLineNo">289</span> LOG.debug("Stop coprocessor " + e.getInstance().getClass().getName());<a name="line.289"></a> -<span class="sourceLineNo">290</span> }<a name="line.290"></a> -<span class="sourceLineNo">291</span> ((BaseEnvironment<C>) e).shutdown();<a name="line.291"></a> -<span class="sourceLineNo">292</span> }<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> * Find coprocessors by full class name or simple name.<a name="line.295"></a> -<span class="sourceLineNo">296</span> */<a name="line.296"></a> -<span class="sourceLineNo">297</span> public C findCoprocessor(String className) {<a name="line.297"></a> -<span class="sourceLineNo">298</span> for (E env: coprocEnvironments) {<a name="line.298"></a> -<span class="sourceLineNo">299</span> if (env.getInstance().getClass().getName().equals(className) ||<a name="line.299"></a> -<span class="sourceLineNo">300</span> env.getInstance().getClass().getSimpleName().equals(className)) {<a name="line.300"></a> -<span class="sourceLineNo">301</span> return env.getInstance();<a name="line.301"></a> -<span class="sourceLineNo">302</span> }<a name="line.302"></a> -<span class="sourceLineNo">303</span> }<a name="line.303"></a> -<span class="sourceLineNo">304</span> return null;<a name="line.304"></a> -<span class="sourceLineNo">305</span> }<a name="line.305"></a> -<span class="sourceLineNo">306</span><a name="line.306"></a> -<span class="sourceLineNo">307</span> @VisibleForTesting<a name="line.307"></a> -<span class="sourceLineNo">308</span> public <T extends C> T findCoprocessor(Class<T> cls) {<a name="line.308"></a> -<span class="sourceLineNo">309</span> for (E env: coprocEnvironments) {<a name="line.309"></a> -<span class="sourceLineNo">310</span> if (cls.isAssignableFrom(env.getInstance().getClass())) {<a name="line.310"></a> -<span class="sourceLineNo">311</span> return (T) env.getInstance();<a name="line.311"></a> -<span class="sourceLineNo">312</span> }<a name="line.312"></a> -<span class="sourceLineNo">313</span> }<a name="line.313"></a> -<span class="sourceLineNo">314</span> return null;<a name="line.314"></a> -<span class="sourceLineNo">315</span> }<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> * Find list of coprocessors that extend/implement the given class/interface<a name="line.318"></a> -<span class="sourceLineNo">319</span> * @param cls the class/interface to look for<a name="line.319"></a> -<span class="sourceLineNo">320</span> * @return the list of coprocessors, or null if not found<a name="line.320"></a> -<span class="sourceLineNo">321</span> */<a name="line.321"></a> -<span class="sourceLineNo">322</span> public <T extends C> List<T> findCoprocessors(Class<T> cls) {<a name="line.322"></a> -<span class="sourceLineNo">323</span> ArrayList<T> ret = new ArrayList<>();<a name="line.323"></a> -<span class="sourceLineNo">324</span><a name="line.324"></a> -<span class="sourceLineNo">325</span> for (E env: coprocEnvironments) {<a name="line.325"></a> -<span class="sourceLineNo">326</span> C cp = env.getInstance();<a name="line.326"></a> -<span class="sourceLineNo">327</span><a name="line.327"></a> -<span class="sourceLineNo">328</span> if(cp != null) {<a name="line.328"></a> -<span class="sourceLineNo">329</span> if (cls.isAssignableFrom(cp.getClass())) {<a name="line.329"></a> -<span class="sourceLineNo">330</span> ret.add((T)cp);<a name="line.330"></a> -<span class="sourceLineNo">331</span> }<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> return ret;<a name="line.334"></a> -<span class="sourceLineNo">335</span> }<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> * Find a coprocessor environment by class name<a name="line.338"></a> -<span class="sourceLineNo">339</span> * @param className the class name<a name="line.339"></a> -<span class="sourceLineNo">340</span> * @return the coprocessor, or null if not found<a name="line.340"></a> -<span class="sourceLineNo">341</span> */<a name="line.341"></a> -<span class="sourceLineNo">342</span> @VisibleForTesting<a name="line.342"></a> -<span class="sourceLineNo">343</span> public E findCoprocessorEnvironment(String className) {<a name="line.343"></a> -<span class="sourceLineNo">344</span> for (E env: coprocEnvironments) {<a name="line.344"></a> -<span class="sourceLineNo">345</span> if (env.getInstance().getClass().getName().equals(className) ||<a name="line.345"></a> -<span class="sourceLineNo">346</span> env.getInstance().getClass().getSimpleName().equals(className)) {<a name="line.346"></a> -<span class="sourceLineNo">347</span> return env;<a name="line.347"></a> -<span class="sourceLineNo">348</span> }<a name="line.348"></a> -<span class="sourceLineNo">349</span> }<a name="line.349"></a> -<span class="sourceLineNo">350</span> return null;<a name="line.350"></a> -<span class="sourceLineNo">351</span> }<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> * Retrieves the set of classloaders used to instantiate Coprocessor classes defined in external<a name="line.354"></a> -<span class="sourceLineNo">355</span> * jar files.<a name="line.355"></a> -<span class="sourceLineNo">356</span> * @return A set of ClassLoader instances<a name="line.356"></a> -<span class="sourceLineNo">357</span> */<a name="line.357"></a> -<span class="sourceLineNo">358</span> Set<ClassLoader> getExternalClassLoaders() {<a name="line.358"></a> -<span class="sourceLineNo">359</span> Set<ClassLoader> externalClassLoaders = new HashSet<>();<a name="line.359"></a> -<span class="sourceLineNo">360</span> final ClassLoader systemClassLoader = this.getClass().getClassLoader();<a name="line.360"></a> -<span class="sourceLineNo">361</span> for (E env : coprocEnvironments) {<a name="line.361"></a> -<span class="sourceLineNo">362</span> ClassLoader cl = env.getInstance().getClass().getClassLoader();<a name="line.362"></a> -<span class="sourceLineNo">363</span> if (cl != systemClassLoader){<a name="line.363"></a> -<span class="sourceLineNo">364</span> //do not include system classloader<a name="line.364"></a> -<span class="sourceLineNo">365</span> externalClassLoaders.add(cl);<a name="line.365"></a> -<span class="sourceLineNo">366</span> }<a name="line.366"></a> -<span class="sourceLineNo">367</span> }<a name="line.367"></a> -<span class="sourceLineNo">368</span> return externalClassLoaders;<a name="line.368"></a> -<span class="sourceLineNo">369</span> }<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> * Environment priority comparator.<a name="line.372"></a> -<span class="sourceLineNo">373</span> * Coprocessors are chained in sorted order.<a name="line.373"></a> -<span class="sourceLineNo">374</span> */<a name="line.374"></a> -<span class="sourceLineNo">375</span> static class EnvironmentPriorityComparator implements Comparator<CoprocessorEnvironment> {<a name="line.375"></a> -<span class="sourceLineNo">376</span> @Override<a name="line.376"></a> -<span class="sourceLineNo">377</span> public int compare(final CoprocessorEnvironment env1,<a name="line.377"></a> -<span class="sourceLineNo">378</span> final CoprocessorEnvironment env2) {<a name="line.378"></a> -<span class="sourceLineNo">379</span> if (env1.getPriority() < env2.getPriority()) {<a name="line.379"></a> -<span class="sourceLineNo">380</span> return -1;<a name="line.380"></a> -<span class="sourceLineNo">381</span> } else if (env1.getPriority() > env2.getPriority()) {<a name="line.381"></a> -<span class="sourceLineNo">382</span> return 1;<a name="line.382"></a> -<span class="sourceLineNo">383</span> }<a name="line.383"></a> -<span class="sourceLineNo">384</span> if (env1.getLoadSequence() < env2.getLoadSequence()) {<a name="line.384"></a> -<span class="sourceLineNo">385</span> return -1;<a name="line.385"></a> -<span class="sourceLineNo">386</span> } else if (env1.getLoadSequence() > env2.getLoadSequence()) {<a name="line.386"></a> -<span class="sourceLineNo">387</span> return 1;<a name="line.387"></a> -<span class="sourceLineNo">388</span> }<a name="line.388"></a> -<span class="sourceLineNo">389</span> return 0;<a name="line.389"></a> -<span class="sourceLineNo">390</span> }<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> protected void abortServer(final E environment, final Throwable e) {<a name="line.393"></a> -<span class="sourceLineNo">394</span> abortServer(environment.getInstance().getClass().getName(), e);<a name="line.394"></a> -<span class="sourceLineNo">395</span> }<a name="line.395"></a> -<span class="sourceLineNo">396</span><a name="line.396"></a> -<span class="sourceLineNo">397</span> protected void abortServer(final String coprocessorName, final Throwable e) {<a name="line.397"></a> -<span class="sourceLineNo">398</span> String message = "The coprocessor " + coprocessorName + " threw " + e.toString();<a name="line.398"></a> -<span class="sourceLineNo">399</span> LOG.error(message, e);<a name="line.399"></a> -<span class="sourceLineNo">400</span> if (abortable != null) {<a name="line.400"></a> -<span class="sourceLineNo">401</span> abortable.abort(message, e);<a name="line.401"></a> -<span class="sourceLineNo">402</span> } else {<a name="line.402"></a> -<span class="sourceLineNo">403</span> LOG.warn("No available Abortable, process was not aborted");<a name="line.403"></a> -<span class="sourceLineNo">404</span> }<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> * This is used by coprocessor hooks which are declared to throw IOException<a name="line.408"></a> -<span class="sourceLineNo">409</span> * (or its subtypes). For such hooks, we should handle throwable objects<a name="line.409"></a> -<span class="sourceLineNo">410</span> * depending on the Throwable's type. Those which are instances of<a name="line.410"></a> -<span class="sourceLineNo">411</span> * IOException should be passed on to the client. This is in conformance with<a name="line.411"></a> -<span class="sourceLineNo">412</span> * the HBase idiom regarding IOException: that it represents a circumstance<a name="line.412"></a> -<span class="sourceLineNo">413</span> * that should be passed along to the client for its own handling. For<a name="line.413"></a> -<span class="sourceLineNo">414</span> * example, a coprocessor that implements access controls would throw a<a name="line.414"></a> -<span class="sourceLineNo">415</span> * subclass of IOException, such as AccessDeniedException, in its preGet()<a name="line.415"></a> -<span class="sourceLineNo">416</span> * method to prevent an unauthorized client's performing a Get on a particular<a name="line.416"></a> -<span class="sourceLineNo">417</span> * table.<a name="line.417"></a> -<span class="sourceLineNo">418</span> * @param env Coprocessor Environment<a name="line.418"></a> -<span class="sourceLineNo">419</span> * @param e Throwable object thrown by coprocessor.<a name="line.419"></a> -<span class="sourceLineNo">420</span> * @exception IOException Exception<a name="line.420"></a> -<span class="sourceLineNo">421</span> */<a name="line.421"></a> -<span class="sourceLineNo">422</span> // Note to devs: Class comments of all observers ({@link MasterObserver}, {@link WALObserver},<a name="line.422"></a> -<span class="sourceLineNo">423</span> // etc) mention this nuance of our exception handling so that coprocessor can throw appropriate<a name="line.423"></a> -<span class="sourceLineNo">424</span> // exceptions depending on situation. If any changes are made to this logic, make sure to<a name="line.424"></a> -<span class="sourceLineNo">425</span> // update all classes' comments.<a name="line.425"></a> -<span class="sourceLineNo">426</span> protected void handleCoprocessorThrowable(final E env, final Throwable e) throws IOException {<a name="line.426"></a> -<span class="sourceLineNo">427</span> if (e instanceof IOException) {<a name="line.427"></a> -<span class="sourceLineNo">428</span> throw (IOException)e;<a name="line.428"></a> -<span class="sourceLineNo">429</span> }<a name="line.429"></a> -<span class="sourceLineNo">430</span> // If we got here, e is not an IOException. A loaded coprocessor has a<a name="line.430"></a> -<span class="sourceLineNo">431</span> // fatal bug, and the server (master or regionserver) should remove the<a name="line.431"></a> -<span class="sourceLineNo">432</span> // faulty coprocessor from its set of active coprocessors. Setting<a name="line.432"></a> -<span class="sourceLineNo">433</span> // 'hbase.coprocessor.abortonerror' to true will cause abortServer(),<a name="line.433"></a> -<span class="sourceLineNo">434</span> // which may be useful in development and testing environments where<a name="line.434"></a> -<span class="sourceLineNo">435</span> // 'failing fast' for error analysis is desired.<a name="line.435"></a> -<span class="sourceLineNo">436</span> if (env.getConfiguration().getBoolean(ABORT_ON_ERROR_KEY, DEFAULT_ABORT_ON_ERROR)) {<a name="line.436"></a> -<span class="sourceLineNo">437</span> // server is configured to abort.<a name="line.437"></a> -<span class="sourceLineNo">438</span> abortServer(env, e);<a name="line.438"></a> -<span class="sourceLineNo">439</span> } else {<a name="line.439"></a> -<span class="sourceLineNo">440</span> // If available, pull a table name out of the environment<a name="line.440"></a> -<span class="sourceLineNo">441</span> if(env instanceof RegionCoprocessorEnvironment) {<a name="line.441"></a> -<span class="sourceLineNo">442</span> String tableName = ((RegionCoprocessorEnvironment)env).getRegionInfo().getTable().getNameAsString();<a name="line.442"></a> -<span class="sourceLineNo">443</span> LOG.error("Removing coprocessor '" + env.toString() + "' from table '"+ tableName + "'", e);<a name="line.443"></a> -<span class="sourceLineNo">444</span> } else {<a name="line.444"></a> -<span class="sourceLineNo">445</span> LOG.error("Removing coprocessor '" + env.toString() + "' from " +<a name="line.445"></a> -<span class="sourceLineNo">446</span> "environment",e);<a name="line.446"></a> -<span class="sourceLineNo">447</span> }<a name="line.447"></a> -<span class="sourceLineNo">448</span><a name="line.448"></a> -<span class="sourceLineNo">449</span> coprocEnvironments.remove(env);<a name="line.449"></a> -<span class="sourceLineNo">450</span> try {<a name="line.450"></a> -<span class="sourceLineNo">451</span> shutdown(env);<a name="line.451"></a> -<span class="sourceLineNo">452</span> } catch (Exception x) {<a name="line.452"></a> -<span class="sourceLineNo">453</span> LOG.error("Uncaught exception when shutting down coprocessor '"<a name="line.453"></a> -<span class="sourceLineNo">454</span> + env.toString() + "'", x);<a name="line.454"></a> -<span class="sourceLineNo">455</span> }<a name="line.455"></a> -<span class="sourceLineNo">456</span> throw new DoNotRetryIOException("Coprocessor: '" + env.toString() +<a name="line.456"></a> -<span class="sourceLineNo">457</span> "' threw: '" + e + "' and has been removed from the active " +<a name="line.457"></a> -<span class="sourceLineNo">458</span> "coprocessor set.", e);<a name="line.458"></a> -<span class="sourceLineNo">459</span> }<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> * Used to limit legacy handling to once per Coprocessor class per classloader.<a name="line.463"></a> -<span class="sourceLineNo">464</span> */<a name="line.464"></a> -<span class="sourceLineNo">465</span> private static final Set<Class<? extends Coprocessor>> legacyWarning =<a name="line.465"></a> -<span class="sourceLineNo">466</span> new ConcurrentSkipListSet<>(<a name="line.466"></a> -<span class="sourceLineNo">467</span> new Comparator<Class<? extends Coprocessor>>() {<a name="line.467"></a> -<span class="sourceLineNo">468</span> @Override<a name="line.468"></a> -<span class="sourceLineNo">469</span> public int compare(Class<? extends Coprocessor> c1, Class<? extends Coprocessor> c2) {<a name="line.469"></a> -<span class="sourceLineNo">470</span> if (c1.equals(c2)) {<a name="line.470"></a> -<span class="sourceLineNo">471</span> return 0;<a name="line.471"></a> -<span class="sourceLineNo">472</span> }<a name="line.472"></a> -<span class="sourceLineNo">473</span> return c1.getName().compareTo(c2.getName());<a name="line.473"></a> -<span class="sourceLineNo">474</span> }<a name="line.474"></a> -<span class="sourceLineNo">475</span> });<a name="line.475"></a> -<span class="sourceLineNo">476</span><a name="line.476"></a> -<span class="sourceLineNo">477</span> /**<a name="line.477"></a> -<span class="sourceLineNo">478</span> * Implementations defined function to get an observer of type {@code O} from a coprocessor of<a name="line.478"></a> -<span class="sourceLineNo">479</span> * type {@code C}. Concrete implementations of CoprocessorHost define one getter for each<a name="line.479"></a> -<span class="sourceLineNo">480</span> * observer they can handle. For e.g. RegionCoprocessorHost will use 3 getters, one for<a name="line.480"></a> -<span class="sourceLineNo">481</span> * each of RegionObserver, EndpointObserver and BulkLoadObserver.<a name="line.481"></a> -<span class="sourceLineNo">482</span> * These getters are used by {@code ObserverOperation} to get appropriate observer from the<a name="line.482"></a> -<span class="sourceLineNo">483</span> * coprocessor.<a name="line.483"></a> -<span class="sourceLineNo">484</span> */<a name="line.484"></a> -<span class="sourceLineNo">485</span> @FunctionalInterface<a name="line.485"></a> -<span class="sourceLineNo">486</span> public interface ObserverGetter<C, O> extends Function<C, Optional<O>> {}<a name="line.486"></a> -<span class="sourceLineNo">487</span><a name="line.487"></a> -<span class="sourceLineNo">488</span> private abstract class ObserverOperation<O> extends ObserverContextImpl<E> {<a name="line.488"></a> -<span class="sourceLineNo">489</span> ObserverGetter<C, O> observerGetter;<a name="line.489"></a> -<span class="sourceLineNo">490</span><a name="line.490"></a> -<span class="sourceLineNo">491</span> ObserverOperation(ObserverGetter<C, O> observerGetter) {<a name="line.491"></a> -<span class="sourceLineNo">492</span> this(observerGetter, null);<a name="line.492"></a> -<span class="sourceLineNo">493</span> }<a name="line.493"></a> -<span class="sourceLineNo">494</span><a name="line.494"></a> -<span class="sourceLineNo">495</span> ObserverOperation(ObserverGetter<C, O> observerGetter, User user) {<a name="line.495"></a> -<span class="sourceLineNo">496</span> this(observerGetter, user, false);<a name="line.496"></a> -<span class="sourceLineNo">497</span> }<a name="line.497"></a> -<span class="sourceLineNo">498</span><a name="line.498"></a> -<span class="sourceLineNo">499</span> ObserverOperation(ObserverGetter<C, O> observerGetter, boolean bypassable) {<a name="line.499"></a> -<span class="sourceLineNo">500</span> this(observerGetter, null, bypassable);<a name="line.500"></a> -<span class="sourceLineNo">501</span> }<a name="line.501"></a> -<span class="sourceLineNo">502</span><a name="line.502"></a> -<span class="sourceLineNo">503</span> ObserverOperation(ObserverGetter<C, O> observerGetter, User user, boolean bypassable) {<a name="line.503"></a> -<span class="sourceLineNo">504</span> super(user != null? user: RpcServer.getRequestUser().orElse(null), bypassable);<a name="line.504"></a> -<span class="sourceLineNo">505</span> this.observerGetter = observerGetter;<a name="line.505"></a> -<span class="sourceLineNo">506</span> }<a name="line.506"></a> -<span class="sourceLineNo">507</span><a name="line.507"></a> -<span class="sourceLineNo">508</span> abstract void callObserver() throws IOException;<a name="line.508"></a> -<span class="sourceLineNo">509</span> protected void postEnvCall() {}<a name="line.509"></a> -<span class="sourceLineNo">510</span> }<a name="line.510"></a> -<span class="sourceLineNo">511</span><a name="line.511"></a> -<span class="sourceLineNo">512</span> // Can't derive ObserverOperation from ObserverOperationWithResult (R = Void) because then all<a name="line.512"></a> -<span class="sourceLineNo">513</span> // ObserverCaller implementations will have to have a return statement.<a name="line.513"></a> -<span class="sourceLineNo">514</span> // O = observer, E = environment, C = coprocessor, R=result type<a name="line.514"></a> -<span class="sourceLineNo">515</span> public abstract class ObserverOperationWithoutResult<O> extends ObserverOperation<O> {<a name="line.515"></a> -<span class="sourceLineNo">516</span> protected abstract void call(O observer) throws IOException;<a name="line.516"></a> -<span class="sourceLineNo">517</span><a name="line.517"></a> -<span class="sourceLineNo">518</span> public ObserverOperationWithoutResult(ObserverGetter<C, O> observerGetter) {<a name="line.518"></a> -<span class="sourceLineNo">519</span> super(observerGetter);<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> public ObserverOperationWithoutResult(ObserverGetter<C, O> observerGetter, User user) {<a name="line.522"></a> -<span class="sourceLineNo">523</span> super(observerGetter, user);<a name="line.523"></a> -<span class="sourceLineNo">524</span> }<a name="line.524"></a> -<span class="sourceLineNo">525</span><a name="line.525"></a> -<span class="sourceLineNo">526</span> public ObserverOperationWithoutResult(ObserverGetter<C, O> observerGetter, User user,<a name="line.526"></a> -<span class="sourceLineNo">527</span> boolean bypassable) {<a name="line.527"></a> -<span class="sourceLineNo">528</span> super(observerGetter, user, bypassable);<a name="line.528"></a> -<span class="sourceLineNo">529</span> }<a name="line.529"></a> -<span class="sourceLineNo">530</span><a name="line.530"></a> -<span class="sourceLineNo">531</span> /**<a name="line.531"></a> -<span class="sourceLineNo">532</span> * In case of coprocessors which have many kinds of observers (for eg, {@link RegionCoprocessor}<a name="line.532"></a> -<span class="sourceLineNo">533</span> * has BulkLoadObserver, RegionObserver, etc), some implementations may not need all<a name="line.533"></a> -<span class="sourceLineNo">534</span> * observers, in which case they will return null for that observer's getter.<a name="line.534"></a> -<span class="sourceLineNo">535</span> * We simply ignore such cases.<a name="line.535"></a> -<span class="sourceLineNo">536</span> */<a name="line.536"></a> -<span class="sourceLineNo">537</span> @Override<a name="line.537"></a> -<span class="sourceLineNo">538</span> void callObserver() throws IOException {<a name="line.538"></a> -<span class="sourceLineNo">539</span> Optional<O> observer = observerGetter.apply(getEnvironment().getInstance());<a name="line.539"></a> -<span class="sourceLineNo">540</span> if (observer.isPresent()) {<a name="line.540"></a> -<span class="sourceLineNo">541</span> call(observer.get());<a name="line.541"></a> -<span class="sourceLineNo">542</span> }<a name="line.542"></a> -<span class="sourceLineNo">543</span> }<a name="line.543"></a> -<span class="sourceLineNo">544</span> }<a name="line.544"></a> -<span class="sourceLineNo">545</span><a name="line.545"></a> -<span class="sourceLineNo">546</span> public abstract class ObserverOperationWithResult<O, R> extends ObserverOperation<O> {<a name="line.546"></a> -<span class="sourceLineNo">547</span> protected abstract R call(O observer) throws IOException;<a name="line.547"></a> -<span class="sourceLineNo">548</span><a name="line.548"></a> -<span class="sourceLineNo">549</span> private R result;<a name="line.549"></a> -<span class="sourceLineNo">550</span><a name="line.550"></a> -<span class="sourceLineNo">551</span> public ObserverOperationWithResult(ObserverGetter<C, O> observerGetter, R result) {<a name="line.551"></a> -<span class="sourceLineNo">552</span> this(observerGetter, result, false);<a name="line.552"></a> -<span class="sourceLineNo">553</span> }<a name="line.553"></a> -<span class="sourceLineNo">554</span><a name="line.554"></a> -<span class="sourceLineNo">555</span> public ObserverOperationWithResult(ObserverGetter<C, O> observerGetter, R result,<a name="line.555"></a> -<span class="sourceLineNo">556</span> boolean bypassable) {<a name="line.556"></a> -<span class="sourceLineNo">557</span> this(observerGetter, result, null, bypassable);<a name="line.557"></a> -<span class="sourceLineNo">558</span> }<a name="line.558"></a> -<span class="sourceLineNo">559</span><a name="line.559"></a> -<span class="sourceLineNo">560</span> public ObserverOperationWithResult(ObserverGetter<C, O> observerGetter, R result,<a name="line.560"></a> -<span class="sourceLineNo">561</span> User user) {<a name="line.561"></a> -<span class="sourceLineNo">562</span> this(observerGetter, result, user, false);<a name="line.562"></a> -<span class="sourceLineNo">563</span> }<a name="line.563"></a> -<span class="sourceLineNo">564</span><a name="line.564"></a> -<span class="sourceLineNo">565</span> private ObserverOperationWithResult(ObserverGetter<C, O> observerGetter, R result, User user,<a name="line.565"></a> -<span class="sourceLineNo">566</span> boolean bypassable) {<a name="line.566"></a> -<span class="sourceLineNo">567</span> super(observerGetter, user, bypassable);<a name="line.567"></a> -<span class="sourceLineNo">568</span> this.result = result;<a name="line.568"></a> -<span class="sourceLineNo">569</span> }<a name="line.569"></a> -<span class="sourceLineNo">570</span><a name="line.570"></a> -<span class="sourceLineNo">571</span> protected R getResult() {<a name="line.571"></a> -<span class="sourceLineNo">572</span> return this.result;<a name="line.572"></a> -<span class="sourceLineNo">573</span> }<a name="line.573"></a> -<span class="sourceLineNo">574</span><a name="line.574"></a> -<span class="sourceLineNo">575</span> @Override<a name="line.575"></a> -<span class="sourceLineNo">576</span> void callObserver() throws IOException {<a name="line.576"></a> -<span class="sourceLineNo">577</span> Optional<O> observer = observerGetter.apply(getEnvironment().getInstance());<a name="line.577"></a> -<span class="sourceLineNo">578</span> if (observer.isPresent()) {<a name="line.578"></a> -<span class="sourceLineNo">579</span> result = call(observer.get());<a name="line.579"></a> -<span class="sourceLineNo">580</span> }<a name="line.580"></a> -<span class="sourceLineNo">581</span> }<a name="line.581"></a> -<span class="sourceLineNo">582</span> }<a name="line.582"></a> -<span class="sourceLineNo">583</span><a name="line.583"></a> -<span class="sourceLineNo">584</span> //////////////////////////////////////////////////////////////////////////////////////////<a name="line.584"></a> -<span class="sourceLineNo">585</span> // Functions to execute observer hooks and handle results (if any)<a name="line.585"></a> -<span class="sourceLineNo">586</span> //////////////////////////////////////////////////////////////////////////////////////////<a name="line.586"></a> -<span class="sourceLineNo">587</span><a name="line.587"></a> -<span class="sourceLineNo">588</span> /**<a name="line.588"></a> -<span class="sourceLineNo">589</span> * Do not call with an observerOperation that is null! Have the caller check.<a name="line.589"></a> -<span class="sourceLineNo">590</span> */<a name="line.590"></a> -<span class="sourceLineNo">591</span> protected <O, R> R execOperationWithResult(<a name="line.591"></a> -<span class="sourceLineNo">592</span> final ObserverOperationWithResult<O, R> observerOperation) throws IOException {<a name="line.592"></a> -<span class="sourceLineNo">593</span> boolean bypass = execOperation(observerOperation);<a name="line.593"></a> -<span class="sourceLineNo">594</span> R result = observerOperation.getResult();<a name="line.594"></a> -<span class="sourceLineNo">595</span> return bypass == observerOperation.isBypassable()? result: null;<a name="line.595"></a> -<span class="sourceLineNo">596</span> }<a name="line.596"></a> -<span class="sourceLineNo">597</span><a name="line.597"></a> -<span class="sourceLineNo">598</span> /**<a name="line.598"></a> -<span class="sourceLineNo">599</span> * @return True if we are to bypass (Can only be <code>true</code> if<a name="line.599"></a> -<span class="sourceLineNo">600</span> * ObserverOperation#isBypassable().<a name="line.600"></a> -<span class="sourceLineNo">601</span> */<a name="line.601"></a> -<span class="sourceLineNo">602</span> protected <O> boolean execOperation(final ObserverOperation<O> observerOperation)<a name="line.602"></a> -<span class="sourceLineNo">603</span> throws IOException {<a name="line.603"></a> -<span class="sourceLineNo">604</span> boolean bypass = false;<a name="line.604"></a> -<span class="sourceLineNo">605</span> if (observerOperation == null) {<a name="line.605"></a> -<span class="sourceLineNo">606</span> return bypass;<a name="line.606"></a> -<span class="sourceLineNo">607</span> }<a name="line.607"></a> -<span class="sourceLineNo">608</span> List<E> envs = coprocEnvironments.get();<a name="line.608"></a> -<span class="sourceLineNo">609</span> for (E env : envs) {<a name="line.609"></a> -<span class="sourceLineNo">610</span> observerOperation.prepare(env);<a name="line.610"></a> -<span class="sourceLineNo">611</span> Thread currentThread = Thread.currentThread();<a name="line.611"></a> -<span class="sourceLineNo">612</span> ClassLoader cl = currentThread.getContextClassLoader();<a name="line.612"></a> -<span class="sourceLineNo">613</span> try {<a name="line.613"></a> -<span class="sourceLineNo">614</span> currentThread.setContextClassLoader(env.getClassLoader());<a name="line.614"></a> -<span class="sourceLineNo">615</span> observerOperation.callObserver();<a name="line.615"></a> -<span class="sourceLineNo">616</span> } catch (Throwable e) {<a name="line.616"></a> -<span class="sourceLineNo">617</span> handleCoprocessorThrowable(env, e);<a name="line.617"></a> -<span class="sourceLineNo">618</span> } finally {<a name="line.618"></a> -<span class="sourceLineNo">619</span> currentThread.setContextClassLoader(cl);<a name="line.619"></a> -<span class="sourceLineNo">620</span> }<a name="line.620"></a> -<span class="sourceLineNo">621</span> // Internal to shouldBypass, it checks if obeserverOperation#isBypassable().<a name="line.621"></a> -<span class="sourceLineNo">622</span> bypass |= observerOperation.shouldBypass();<a name="line.622"></a> -<span class="sourceLineNo">623</span> observerOperation.postEnvCall();<a name="line.623"></a> -<span class="sourceLineNo">624</span> if (bypass) {<a name="line.624"></a> -<span class="sourceLineNo">625</span> // If CP says bypass, skip out w/o calling any following CPs; they might ruin our response.<a name="line.625"></a> -<span class="sourceLineNo">626</span> // In hbase1, this used to be called 'complete'. In hbase2, we unite bypass and 'complete'.<a name="line.626"></a> -<span class="sourceLineNo">627</span> break;<a name="line.627"></a> -<span class="sourceLineNo">628</span> }<a name="line.628"></a> -<span class="sourceLineNo">629</span> }<a name="line.629"></a> -<span class="sourceLineNo">630</span> return bypass;<a name="line.630"></a> -<span class="sourceLineNo">631</span> }<a name="line.631"></a> -<span class="sourceLineNo">632</span><a name="line.632"></a> -<span class="sourceLineNo">633</span> /**<a name="line.633"></a> -<span class="sourceLineNo">634</span> * Coprocessor classes can be configured in any order, based on that priority is set and<a name="line.634"></a> -<span class="sourceLineNo">635</span> * chained in a sorted order. Should be used preStop*() hooks i.e. when master/regionserver is<a name="line.635"></a> -<span class="sourceLineNo">636</span> * going down. This function first calls coprocessor methods (using ObserverOperation.call())<a name="line.636"></a> -<span class="sourceLineNo">637</span> * and then shutdowns the environment in postEnvCall(). <br><a name="line.637"></a> -<span class="sourceLineNo">638</span> * Need to execute all coprocessor methods first then postEnvCall(), otherwise some coprocessors<a name="line.638"></a> -<span class="sourceLineNo">639</span> * may remain shutdown if any exception occurs during next coprocessor execution which prevent<a name="line.639"></a> -<span class="sourceLineNo">640</span> * master/regionserver stop or cluster shutdown. (Refer:<a name="line.640"></a> -<span class="sourceLineNo">641</span> * <a href="https://issues.apache.org/jira/browse/HBASE-16663">HBASE-16663</a><a name="line.641"></a> -<span class="sourceLineNo">642</span> * @return true if bypaas coprocessor execution, false if not.<a name="line.642"></a> -<span class="sourceLineNo">643</span> * @throws IOException<a name="line.643"></a> -<span class="sourceLineNo">644</span> */<a name="line.644"></a> -<span class="sourceLineNo">645</span> protected <O> boolean execShutdown(final ObserverOperation<O> observerOperation)<a name="line.645"></a> -<span class="sourceLineNo">646</span> throws IOException {<a name="line.646"></a> -<span class="sourceLineNo">647</span> if (observerOperation == null) return false;<a name="line.647"></a> -<span class="sourceLineNo">648</span> boolean bypass = false;<a name="line.648"></a> -<span class="sourceLineNo">649</span> List<E> envs = coprocEnvironments.get();<a name="line.649"></a> -<span class="sourceLineNo">650</span> // Iterate the coprocessors and execute ObserverOperation's call()<a name="line.650"></a> -<span class="sourceLineNo">651</span> for (E env : envs) {<a name="line.651"></a> -<span class="sourceLineNo">652</span> observerOperation.prepare(env);<a name="line.652"></a> -<span class="sourceLineNo">653</span> Thread currentThread = Thread.currentThread();<a name="line.653"></a> -<span class="sourceLineNo">654</span> ClassLoader cl = currentThread.getContextClassLoader();<a name="line.654"></a> -<span class="sourceLineNo">655</span> try {<a name="line.655"></a> -<span class="sourceLineNo">656</span> currentThread.setContextClassLoader(env.getClassLoader());<a name="line.656"></a> -<span class="sourceLineNo">657</span> observerOperation.callObserver();<a name="line.657"></a> -<span class="sourceLineNo">658</span> } catch (Throwable e) {<a name="line.658"></a> -<span class="sourceLineNo">659</span> handleCoprocessorThrowable(env, e);<a name="line.659"></a> -<span class="sourceLineNo">660</span> } finally {<a name="line.660"></a> -<span class="sourceLineNo">661</span> currentThread.setContextClassLoader(cl);<a name="line.661"></a> -<span class="sourceLineNo">662</span> }<a name="line.662"></a> -<span class="sourceLineNo">663</span> bypass |= observerOperation.shouldBypass();<a name="line.663"></a> -<span class="sourceLineNo">664</span> }<a name="line.664"></a> -<span class="sourceLineNo">665</span><a name="line.665"></a> -<span class="sourceLineNo">666</span> // Iterate the coprocessors and execute ObserverOperation's postEnvCall()<a name="line.666"></a> -<span class="sourceLineNo">667</span> for (E env : envs) {<a name="line.667"></a> -<span class="sourceLineNo">668</span> observerOperation.prepare(env);<a name="line.668"></a> -<span class="sourceLineNo">669</span> observerOperation.postEnvCall();<a name="line.669"></a> -<span class="sourceLineNo">670</span> }<a name="line.670"></a> -<span class="sourceLineNo">671</span> return bypass;<a name="line.671"></a> -<span class="sourceLineNo">672</span> }<a name="line.672"></a> -<span class="sourceLineNo">673</span>}<a name="line.673"></a> +<span class="sourceLineNo">160</span> LOG.info("System coprocessor {} loaded, priority={}.", className, priority);<a name="line.160"></a> +<span class="sourceLineNo">161</span> ++priority;<a name="line.161"></a> +<span class="sourceLineNo">162</span> }<a name="line.162"></a> +<span class="sourceLineNo">163</span> } catch (Throwable t) {<a name="line.163"></a> +<span class="sourceLineNo">164</span> // We always abort if system coprocessors cannot be loaded<a name="line.164"></a> +<span class="sourceLineNo">165</span> abortServer(className, t);<a name="line.165"></a> +<span class="sourceLineNo">166</span> }<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> * Load a coprocessor implementation into the host<a name="line.171"></a> +<span class="sourceLineNo">172</span> * @param path path to implementation jar<a name="line.172"></a> +<span class="sourceLineNo">173</span> * @param className the main class name<a name="line.173"></a> +<span class="sourceLineNo">174</span> * @param priority chaining priority<a name="line.174"></a> +<span class="sourceLineNo">175</span> * @param conf configuration for coprocessor<a name="line.175"></a> +<span class="sourceLineNo">176</span> * @throws java.io.IOException Exception<a name="line.176"></a> +<span class="sourceLineNo">177</span> */<a name="line.177"></a> +<span class="sourceLineNo">178</span> public E load(Path path, String className, int priority,<a name="line.178"></a> +<span class="sourceLineNo">179</span> Configuration conf) throws IOException {<a name="line.179"></a> +<span class="sourceLineNo">180</span> String[] includedClassPrefixes = null;<a name="line.180"></a> +<span class="sourceLineNo">181</span> if (conf.get(HConstants.CP_HTD_ATTR_INCLUSION_KEY) != null){<a name="line.181"></a> +<span class="sourceLineNo">182</span> String prefixes = conf.get(HConstants.CP_HTD_ATTR_INCLUSION_KEY);<a name="line.182"></a> +<span class="sourceLineNo">183</span> includedClassPrefixes = prefixes.split(";");<a name="line.183"></a> +<span class="sourceLineNo">184</span> }<a name="line.184"></a> +<span class="sourceLineNo">185</span> return load(path, className, priority, conf, includedClassPrefixes);<a name="line.185"></a> +<span class="sourceLineNo">186</span> }<a name="line.186"></a> +<span class="sourceLineNo">187</span><a name="line.187"></a> +<span class="sourceLineNo">188</span> /**<a name="line.188"></a> +<span class="sourceLineNo">189</span> * Load a coprocessor implementation into the host<a name="line.189"></a> +<span class="sourceLineNo">190</span> * @param path path to implementation jar<a name="line.190"></a> +<span class="sourceLineNo">191</span> * @param className the main class name<a name="line.191"></a> +<span class="sourceLineNo">192</span> * @param priority chaining priority<a name="line.192"></a> +<span class="sourceLineNo">193</span> * @param conf configuration for coprocessor<a name="line.193"></a> +<span class="sourceLineNo">194</span> * @param includedClassPrefixes class name prefixes to include<a name="line.194"></a> +<span class="sourceLineNo">195</span> * @throws java.io.IOException Exception<a name="line.195"></a> +<span class="sourceLineNo">196</span> */<a name="line.196"></a> +<span class="sourceLineNo">197</span> public E load(Path path, String className, int priority,<a name="line.197"></a> +<span class="sourceLineNo">198</span> Configuration conf, String[] includedClassPrefixes) throws IOException {<a name="line.198"></a> +<span class="sourceLineNo">199</span> Class<?> implClass;<a name="line.199"></a> +<span class="sourceLineNo">200</span> LOG.debug("Loading coprocessor class " + className + " with path " +<a name="line.200"></a> +<span class="sourceLineNo">201</span> path + " and priority " + priority);<a name="line.201"></a> +<span class="sourceLineNo">202</span><a name="line.202"></a> +<span class="sourceLineNo">203</span> ClassLoader cl = null;<a name="line.203"></a> +<span class="sourceLineNo">204</span> if (path == null) {<a name="line.204"></a> +<span class="sourceLineNo">205</span> try {<a name="line.205"></a> +<span class="sourceLineNo">206</span> implClass = getClass().getClassLoader().loadClass(className);<a name="line.206"></a> +<span class="sourceLineNo">207</span> } catch (ClassNotFoundException e) {<a name="line.207"></a> +<span class="sourceLineNo">208</span> throw new IOException("No jar path specified for " + className);<a name="line.208"></a> +<span class="sourceLineNo">209</span> }<a name="line.209"></a> +<span class="sourceLineNo">210</span> } else {<a name="line.210"></a> +<span class="sourceLineNo">211</span> cl = CoprocessorClassLoader.getClassLoader(<a name="line.211"></a> +<span class="sourceLineNo">212</span> path, getClass().getClassLoader(), pathPrefix, conf);<a name="line.212"></a> +<span class="sourceLineNo">213</span> try {<a name="line.213"></a> +<span class="sourceLineNo">214</span> implClass = ((CoprocessorClassLoader)cl).loadClass(className, includedClassPrefixes);<a name="line.214"></a> +<span class="sourceLineNo">215</span> } catch (ClassNotFoundException e) {<a name="line.215"></a> +<span class="sourceLineNo">216</span> throw new IOException("Cannot load external coprocessor class " + className, e);<a name="line.216"></a> +<span class="sourceLineNo">217</span> }<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> //load custom code for coprocessor<a name="line.220"></a> +<span class="sourceLineNo">221</span> Thread currentThread = Thread.currentThread();<a name="line.221"></a> +<span class="sourceLineNo">222</span> ClassLoader hostClassLoader = currentThread.getContextClassLoader();<a name="line.222"></a> +<span class="sourceLineNo">223</span> try{<a name="line.223"></a> +<span class="sourceLineNo">224</span> // switch temporarily to the thread classloader for custom CP<a name="line.224"></a> +<span class="sourceLineNo">225</span> currentThread.setContextClassLoader(cl);<a name="line.225"></a> +<span class="sourceLineNo">226</span> E cpInstance = checkAndLoadInstance(implClass, priority, conf);<a name="line.226"></a> +<span class="sourceLineNo">227</span> return cpInstance;<a name="line.227"></a> +<span class="sourceLineNo">228</span> } finally {<a name="line.228"></a> +<span class="sourceLineNo">229</span> // restore the fresh (host) classloader<a name="line.229"></a> +<span class="sourceLineNo">230</span> currentThread.setContextClassLoader(hostClassLoader);<a name="line.230"></a> +<span class="sourceLineNo">231</span> }<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> @VisibleForTesting<a name="line.234"></a> +<span class="sourceLineNo">235</span> public void load(Class<? extends C> implClass, int priority, Configuration conf)<a name="line.235"></a> +<span class="sourceLineNo">236</span> throws IOException {<a name="line.236"></a> +<span class="sourceLineNo">237</span> E env = checkAndLoadInstance(implClass, priority, conf);<a name="line.237"></a> +<span class="sourceLineNo">238</span> coprocEnvironments.add(env);<a name="line.238"></a> +<span class="sourceLineNo">239</span> }<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> * @param implClass Implementation class<a name="line.242"></a> +<span class="sourceLineNo">243</span> * @param priority priority<a name="line.243"></a> +<span class="sourceLineNo">244</span> * @param conf configuration<a name="line.244"></a> +<span class="sourceLineNo">245</span> * @throws java.io.IOException Exception<a name="line.245"></a> +<span class="sourceLineNo">246</span> */<a name="line.246"></a> +<span class="sourceLineNo">247</span> public E checkAndLoadInstance(Class<?> implClass, int priority, Configuration conf)<a name="line.247"></a> +<span class="sourceLineNo">248</span> throws IOException {<a name="line.248"></a> +<span class="sourceLineNo">249</span> // create the instance<a name="line.249"></a> +<span class="sourceLineNo">250</span> C impl;<a name="line.250"></a> +<span class="sourceLineNo">251</span> try {<a name="line.251"></a> +<span class="sourceLineNo">252</span> impl = checkAndGetInstance(implClass);<a name="line.252"></a> +<span class="sourceLineNo">253</span> if (impl == null) {<a name="line.253"></a> +<span class="sourceLineNo">254</span> LOG.error("Cannot load coprocessor " + implClass.getSimpleName());<a name="line.254"></a> +<span class="sourceLineNo">255</span> return null;<a name="line.255"></a> +<span class="sourceLineNo">256</span> }<a name="line.256"></a> +<span class="sourceLineNo">257</span> } catch (InstantiationException|IllegalAccessException e) {<a name="line.257"></a> +<span class="sourceLineNo">258</span> throw new IOException(e);<a name="line.258"></a> +<span class="sourceLineNo">259</span> }<a name="line.259"></a> +<span class="sourceLineNo">260</span> // create the environment<a name="line.260"></a> +<span class="sourceLineNo">261</span> E env = createEnvironment(impl, priority, loadSequence.incrementAndGet(), conf);<a name="line.261"></a> +<span class="sourceLineNo">262</span> assert env instanceof BaseEnvironment;<a name="line.262"></a> +<span class="sourceLineNo">263</span> ((BaseEnvironment<C>) 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> assert e instanceof BaseEnvironment;<a name="line.286"></a> +<span class="sourceLineNo">287</span> if (LOG.isDebugEnabled()) {<a name="line.287"></a> +<span class="sourceLineNo">288</span> LOG.debug("Stop coprocessor " + e.getInstance().getClass().getName());<a name="line.288"></a> +<span class="sourceLineNo">289</span> }<a name="line.289"></a> +<span class="sourceLineNo">290</span> ((BaseEnvironment<C>) e).shutdown();<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> /**<a name="line.293"></a> +<span class="sourceLineNo">294</span> * Find coprocessors by full class name or simple name.<a name="line.294"></a> +<span class="sourceLineNo">295</span> */<a name="line.295"></a> +<span class="sourceLineNo">296</span> public C findCoprocessor(String className) {<a name="line.296"></a> +<span class="sourceLineNo">297</span> for (E env: coprocEnvironments) {<a name="line.297"></a> +<span class="sourceLineNo">298</span> if (env.getInstance().getClass().getName().equals(className) ||<a name="line.298"></a> +<span class="sourceLineNo">299</span> env.getInstance().getClass().getSimpleName().equals(className)) {<a name="line.299"></a> +<span class="sourceLineNo">300</span> return env.getInstance();<a name="line.300"></a> +<span class="sourceLineNo">301</span> }<a name="line.301"></a> +<span class="sourceLineNo">302</span> }<a name="line.302"></a> +<span class="sourceLineNo">303</span> return null;<a name="line.303"></a> +<span class="sourceLineNo">304</span> }<a name="line.304"></a> +<span class="sourceLineNo">305</span><a name="line.305"></a> +<span class="sourceLineNo">306</span> @VisibleForTesting<a name="line.306"></a> +<span class="sourceLineNo">307</span> public <T extends C> T findCoprocessor(Class<T> cls) {<a name="line.307"></a> +<span class="sourceLineNo">308</span> for (E env: coprocEnvironments) {<a name="line.308"></a> +<span class="sourceLineNo">309</span> if (cls.isAssignableFrom(env.getInstance().getClass())) {<a name="line.309"></a> +<span class="sourceLineNo">310</span> return (T) env.getInstance();<a name="line.310"></a> +<span class="sourceLineNo">311</span> }<a name="line.311"></a> +<span class="sourceLineNo">312</span> }<a name="line.312"></a> +<span class="sourceLineNo">313</span> return null;<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> /**<a name="line.316"></a> +<span class="sourceLineNo">317</span> * Find list of coprocessors that extend/implement the given class/interface<a name="line.317"></a> +<span class="sourceLineNo">318</span> * @param cls the class/interface to look for<a name="line.318"></a> +<span class="sourceLineNo">319</span> * @return the list of coprocessors, or null if not found<a name="line.319"></a> +<span class="sourceLineNo">320</span> */<a name="line.320"></a> +<span class="sourceLineNo">321</span> public <T extends C> List<T> findCoprocessors(Class<T> cls) {<a name="line.321"></a> +<span class="sourceLineNo">322</span> ArrayList<T> ret = new ArrayList<>();<a name="line.322"></a> +<span class="sourceLineNo">323</span><a name="line.323"></a> +<span class="sourceLineNo">324</span> for (E env: coprocEnvironments) {<a name="line.324"></a> +<span class="sourceLineNo">325</span> C cp = env.getInstance();<a name="line.325"></a> +<span class="sourceLineNo">326</span><a name="line.326"></a> +<span class="sourceLineNo">327</span> if(cp != null) {<a name="line.327"></a> +<span class="sourceLineNo">328</span> if (cls.isAssignableFrom(cp.getClass())) {<a name="line.328"></a> +<span class="sourceLineNo">329</span> ret.add((T)cp);<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> }<a name="line.332"></a> +<span class="sourceLineNo">333</span> return ret;<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> /**<a name="line.336"></a> +<span class="sourceLineNo">337</span> * Find a coprocessor environment by class name<a name="line.337"></a> +<span class="sourceLineNo">338</span> * @param className the class name<a name="line.338"></a> +<span class="sourceLineNo">339</span> * @return the coprocessor, or null if not found<a name="line.339"></a> +<span class="sourceLineNo">340</span> */<a name="line.340"></a> +<span class="sourceLineNo">341</span> @VisibleForTesting<a name="line.341"></a> +<span class="sourceLineNo">342</span> public E findCoprocessorEnvironment(String className) {<a name="line.342"></a> +<span class="sourceLineNo">343</span> for (E env: coprocEnvironments) {<a name="line.343"></a> +<span class="sourceLineNo">344</span> if (env.getInstance().getClass().getName().equals(className) ||<a name="line.344"></a> +<span class="sourceLineNo">345</span> env.getInstance().getClass().getSimpleName().equals(className)) {<a name="line.345"></a> +<span class="sourceLineNo">346</span> return env;<a name="line.346"></a> +<span class="sourceLineNo">347</span> }<a name="line.347"></a> +<span class="sourceLineNo">348</span> }<a name="line.348"></a> +<span class="sourceLineNo">349</span> return null;<a name="line.349"></a> +<span class="sourceLineNo">350</span> }<a name="line.350"></a> +<span class="sourceLineNo">351</span><a name="line.351"></a> +<span class="sourceLineNo">352</span> /**<a name="line.352"></a> +<span class="sourceLineNo">353</span> * Retrieves the set of classloaders used to instantiate Coprocessor classes defined in external<a name="line.353"></a> +<span class="sourceLineNo">354</span> * jar files.<a name="line.354"></a> +<span class="sourceLineNo">355</span> * @return A set of ClassLoader instances<a name="line.355"></a> +<span class="sourceLineNo">356</span> */<a name="line.356"></a> +<span class="sourceLineNo">357</span> Set<ClassLoader> getExternalClassLoaders() {<a name="line.357"></a> +<span class="sourceLineNo">358</span> Set<ClassLoader> externalClassLoaders = new HashSet<>();<a name="line.358"></a> +<span class="sourceLineNo">359</span> final ClassLoader systemClassLoader = this.getClass().getClassLoader();<a name="line.359"></a> +<span class="sourceLineNo">360</span> for (E env : coprocEnvironments) {<a name="line.360"></a> +<span class="sourceLineNo">361</span> ClassLoader cl = env.getInstance().getClass().getClassLoader();<a name="line.361"></a> +<span class="sourceLineNo">362</span> if (cl != systemClassLoader){<a name="line.362"></a> +<span class="sourceLineNo">363</span> //do not include system classloader<a name="line.363"></a> +<span class="sourceLineNo">364</span> externalClassLoaders.add(cl);<a name="line.364"></a> +<span class="sourceLineNo">365</span> }<a name="line.365"></a> +<span class="sourceLineNo">366</span> }<a name="line.366"></a> +<span class="sourceLineNo">367</span> return externalClassLoaders;<a name="line.367"></a> +<span class="sourceLineNo">368</span> }<a name="line.368"></a> +<span class="sourceLineNo">369</span><a name="line.369"></a> +<span class="sourceLineNo">370</span> /**<a name="line.370"></a> +<span class="sourceLineNo">371</span> * Environment priority comparator.<a name="line.371"></a> +<span class="sourceLineNo">372</span> * Coprocessors are chained in sorted order.<a name="line.372"></a> +<span class="sourceLineNo">373</span> */<a name="line.373"></a> +<span class="sourceLineNo">374</span> static class EnvironmentPriorityComparator implements Comparator<CoprocessorEnvironment> {<a name="line.374"></a> +<span class="sourceLineNo">375</span> @Override<a name="line.375"></a> +<span class="sourceLineNo">376</span> public int compare(final CoprocessorEnvironment env1,<a name="line.376"></a> +<span class="sourceLineNo">377</span> final CoprocessorEnvironment env2) {<a name="line.377"></a> +<span class="sourceLineNo">378</span> if (env1.getPriority() < env2.getPriority()) {<a name="line.378"></a> +<span class="sourceLineNo">379</span> return -1;<a name="line.379"></a> +<span class="sourceLineNo">380</span> } else 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> }<a name="line.382"></a> +<span class="sourceLineNo">383</span> if (env1.getLoadSequence() < env2.getLoadSequence()) {<a name="line.383"></a> +<span class="sourceLineNo">384</span> return -1;<a name="line.384"></a> +<span class="sourceLineNo">385</span> } else 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> }<a name="line.387"></a> +<span class="sourceLineNo">388</span> return 0;<a name="line.388"></a> +<span class="sourceLineNo">389</span> }<a name="line.389"></a> +<span class="sourceLineNo">390</span> }<a name="line.390"></a> +<span class="sourceLineNo">391</span><a name="line.391"></a> +<span class="sourceLineNo">392</span> protected void abortServer(final E environment, final Throwable e) {<a name="line.392"></a> +<span class="sourceLineNo">393</span> abortServer(environment.getInstance().getClass().getName(), e);<a name="line.393"></a> +<span class="sourceLineNo">394</span> }<a name="line.394"></a> +<span class="sourceLineNo">395</span><a name="line.395"></a> +<span class="sourceLineNo">396</span> protected void abortServer(final String coprocessorName, final Throwable e) {<a name="line.396"></a> +<span class="sourceLineNo">397</span> String message = "The coprocessor " + coprocessorName + " threw " + e.toString();<a name="line.397"></a> +<span class="sourceLineNo">398</span> LOG.error(message, e);<a name="line.398"></a> +<span class="sourceLineNo">399</span> if (abortable != null) {<a name="line.399"></a> +<span class="sourceLineNo">400</span> abortable.abort(message, e);<a name="line.400"></a> +<span class="sourceLineNo">401</span> } else {<a name="line.401"></a> +<span class="sourceLineNo">402</span> LOG.warn("No available Abortable, process was not aborted");<a name="line.402"></a> +<span class="sourceLineNo">403</span> }<a name="line.403"></a> +<span class="sourceLineNo">404</span> }<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> * This is used by coprocessor hooks which are declared to throw IOException<a name="line.407"></a> +<span class="sourceLineNo">408</span> * (or its subtypes). For such hooks, we should handle throwable objects<a name="line.408"></a> +<span class="sourceLineNo">409</span> * depending on the Throwable's type. Those which are instances of<a name="line.409"></a> +<span class="sourceLineNo">410</span> * IOException should be passed on to the client. This is in conformance with<a name="line.410"></a> +<span class="sourceLineNo">411</span> * the HBase idiom regarding IOException: that it represents a circumstance<a name="line.411"></a> +<span class="sourceLineNo">412</span> * that should be passed along to the client for its own handling. For<a name="line.412"></a> +<span class="sourceLineNo">413</span> * example, a coprocessor that implements access controls would throw a<a name="line.413"></a> +<span class="sourceLineNo">414</span> * subclass of IOException, such as AccessDeniedException, in its preGet()<a name="line.414"></a> +<span class="sourceLineNo">415</span> * method to prevent an unauthorized client's performing a Get on a particular<a name="line.415"></a> +<span class="sourceLineNo">416</span> * table.<a name="line.416"></a> +<span class="sourceLineNo">417</span> * @param env Coprocessor Environment<a name="line.417"></a> +<span class="sourceLineNo">418</span> * @param e Throwable object thrown by coprocessor.<a name="line.418"></a> +<span class="sourceLineNo">419</span> * @exception IOException Exception<a name="line.419"></a> +<span class="sourceLineNo">420</span> */<a name="line.420"></a> +<span class="sourceLineNo">421</span> // Note to devs: Class comments of all observers ({@link MasterObserver}, {@link WALObserver},<a name="line.421"></a> +<span class="sourceLineNo">422</span> // etc) mention this nuance of our exception handling so that coprocessor can throw appropriate<a name="line.422"></a> +<span class="sourceLineNo">423</span> // exceptions depending on situation. If any changes are made to this logic, make sure to<a name="line.423"></a> +<span class="sourceLineNo">424</span> // update all classes' comments.<a name="line.424"></a> +<span class="sourceLineNo">425</span> protected void handleCoprocessorThrowable(final E env, final Throwable e) throws IOException {<a name="line.425"></a> +<span class="sourceLineNo">426</span> if (e instanceof IOException) {<a name="line.426"></a> +<span class="sourceLineNo">427</span> throw (IOException)e;<a name="line.427"></a> +<span class="sourceLineNo">428</span> }<a name="line.428"></a> +<span class="sourceLineNo">429</span> // If we got here, e is not an IOException. A loaded coprocessor has a<a name="line.429"></a> +<span class="sourceLineNo">430</span> // fatal bug, and the server (master or regionserver) should remove the<a name="line.430"></a> +<span class="sourceLineNo">431</span> // faulty coprocessor from its set of active coprocessors. Setting<a name="line.431"></a> +<span class="sourceLineNo">432</span> // 'hbase.coprocessor.abortonerror' to true will cause abortServer(),<a name="line.432"></a> +<span class="sourceLineNo">433</span> // which may be useful in development and testing environments where<a name="line.433"></a> +<span class="sourceLineNo">434</span> // 'failing fast' for error analysis is desired.<a name="line.434"></a> +<span class="sourceLineNo">435</span> if (env.getConfiguration().getBoolean(ABORT_ON_ERROR_KEY, DEFAULT_ABORT_ON_ERROR)) {<a name="line.435"></a> +<span class="sourceLineNo">436</span> // server is configured to abort.<a name="line.436"></a> +<span class="sourceLineNo">437</span> abortServer(env, e);<a name="line.437"></a> +<span class="sourceLineNo">438</span> } else {<a name="line.438"></a> +<span class="sourceLineNo">439</span> // If available, pull a table name out of the environment<a name="line.439"></a> +<span class="sourceLineNo">440</span> if(env instanceof RegionCoprocessorEnvironment) {<a name="line.440"></a> +<span class="sourceLineNo">441</span> String tableName = ((RegionCoprocessorEnvironment)env).getRegionInfo().getTable().getNameAsString();<a name="line.441"></a> +<span class="sourceLineNo">442</span> LOG.error("Removing coprocessor '" + env.toString() + "' from table '"+ tableName + "'", e);<a name="line.442"></a> +<span class="sourceLineNo">443</span> } else {<a name="line.443"></a> +<span class="sourceLineNo">444</span> LOG.error("Removing coprocessor '" + env.toString() + "' from " +<a name="line.444"></a> +<span class="sourceLineNo">445</span> "environment",e);<a name="line.445"></a> +<span class="sourceLineNo">446</span> }<a name="line.446"></a> +<span class="sourceLineNo">447</span><a name="line.447"></a> +<span class="sourceLineNo">448</span> coprocEnvironments.remove(env);<a name="line.448"></a> +<span class="sourceLineNo">449</span> try {<a name="line.449"></a> +<span class="sourceLineNo">450</span> shutdown(env);<a name="line.450"></a> +<span class="sourceLineNo">451</span> } catch (Exception x) {<a name="line.451"></a> +<span class="sourceLineNo">452</span> LOG.error("Uncaught exception when shutting down coprocessor '"<a name="line.452"></a> +<span class="sourceLineNo">453</span> + env.toString() + "'", x);<a name="line.453"></a> +<span class="sourceLineNo">454</span> }<a name="line.454"></a> +<span class="sourceLineNo">455</span> throw new DoNotRetryIOException("Coprocessor: '" + env.toString() +<a name="line.455"></a> +<span class="sourceLineNo">456</span> "' threw: '" + e + "' and has been removed from the active " +<a name="line.456"></a> +<span class="sourceLineNo">457</span> "coprocessor set.", e);<a name="line.457"></a> +<span class="sourceLineNo">458</span> }<a name="line.458"></a> +<span class="sourceLineNo">459</span> }<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> * Used to limit legacy handling to once per Coprocessor class per classloader.<a name="line.462"></a> +<span class="sourceLineNo">463</span> */<a name="line.463"></a> +<span class="sourceLineNo">464</span> private static final Set<Class<? extends Coprocessor>> legacyWarning =<a name="line.464"></a> +<span class="sourceLineNo">465</span> new ConcurrentSkipListSet<>(<a name="line.465"></a> +<span class="sourceLineNo">466</span> new Comparator<Class<? extends Coprocessor>>() {<a name="line.466"></a> +<span class="sourceLineNo">467</span> @Override<a name="line.467"></a> +<span class="sourceLineNo">468</span> public int compare(Class<? extends Coprocessor> c1, Class<? extends Coprocessor> c2) {<a name="line.468"></a> +<span class="sourceLineNo">469</span> if (c1.equals(c2)) {<a name="line.469"></a> +<span class="sourceLineNo">470</span> return 0;<a name="line.470"></a> +<span class="sourceLineNo">471</span> }<a name="line.471"></a> +<span class="sourceLineNo">472</span> return c1.getName().compareTo(c2.getName());<a name="line.472"></a> +<span class="sourceLineNo">473</span> }<a name="line.473"></a> +<span class="sourceLineNo">474</span> });<a name="line.474"></a> +<span class="sourceLineNo">475</span><a name="line.475"></a> +<span class="sourceLineNo">476</span> /**<a name="line.476"></a> +<span class="sourceLineNo">477</span> * Implementations defined function to get an observer of type {@code O} from a coprocessor of<a name="line.477"></a> +<span class="sourceLineNo">478</span> * type {@code C}. Concrete implementations of CoprocessorHost define one getter for each<a name="line.478"></a> +<span class="sourceLineNo">479</span> * observer they can handle. For e.g. RegionCoprocessorHost will use 3 getters, one for<a name="line.479"></a> +<span class="sourceLineNo">480</span> * each of RegionObserver, EndpointObserver and BulkLoadObserver.<a name="line.480"></a> +<span class="sourceLineNo">481</span> * These getters are used by {@code ObserverOperation} to get appropriate observer from the<a name="line.481"></a> +<span class="sourceLineNo">482</span> * coprocessor.<a name="line.482"></a> +<span class="sourceLineNo">483</span> */<a name="line.483"></a> +<span class="sourceLineNo">484</span> @FunctionalInterface<a name="line.484"></a> +<span class="sourceLineNo">485</span> public interface ObserverGetter<C, O> extends Function<C, Optional<O>> {}<a name="line.485"></a> +<span class="sourceLineNo">486</span><a name="line.486"></a> +<span class="sourceLineNo">487</span> private abstract class ObserverOperation<O> extends ObserverContextImpl<E> {<a name="line.487"></a> +<span class="sourceLineNo">488</span> ObserverGetter<C, O> observerGetter;<a name="line.488"></a> +<span class="sourceLineNo">489</span><a name="line.489"></a> +<span class="sourceLineNo">490</span> ObserverOperation(ObserverGetter<C, O> observerGetter) {<a name="line.490"></a> +<span class="sourceLineNo">491</span> this(observerGetter, null);<a name="line.491"></a> +<span class="sourceLineNo">492</span> }<a name="line.492"></a> +<span class="sourceLineNo">493</span><a name="line.493"></a> +<span class="sourceLineNo">494</span> ObserverOperation(ObserverGetter<C, O> observerGetter, User user) {<a name="line.494"></a> +<span class="sourceLineNo">495</span> this(observerGetter, user, false);<a name="line.495"></a> +<span class="sourceLineNo">496</span> }<a name="line.496"></a> +<span class="sourceLineNo">497</span><a name="line.497"></a> +<span class="sourceLineNo">498</span> ObserverOperation(ObserverGetter<C, O> observerGetter, boolean bypassable) {<a name="line.498"></a> +<span class="sourceLineNo">499</span> this(observerGetter, null, bypassable);<a name="line.499"></a> +<span class="sourceLineNo">500</span> }<a name="line.500"></a> +<span class="sourceLineNo">501</span><a name="line.501"></a> +<span class="sourceLineNo">502</span> ObserverOperation(ObserverGetter<C, O> observerGetter, User user, boolean bypassable) {<a name="line.502"></a> +<span class="sourceLineNo">503</span> super(user != null? user: RpcServer.getRequestUser().orElse(null), bypassable);<a name="line.503"></a> +<span class="sourceLineNo">504</span> this.observerGetter = observerGetter;<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> abstract void callObserver() throws IOException;<a name="line.507"></a> +<span class="sourceLineNo">508</span> protected void postEnvCall() {}<a name="line.508"></a> +<span class="sourceLineNo">509</span> }<a name="line.509"></a> +<span class="sourceLineNo">510</span><a name="line.510"></a> +<span class="sourceLineNo">511</span> // Can't derive ObserverOperation from ObserverOperationWithResult (R = Void) because then all<a name="line.511"></a> +<span class="sourceLineNo">512</span> // ObserverCaller implementations will have to have a return statement.<a name="line.512"></a> +<span class="sourceLineNo">513</span> // O = observer, E = environment, C = coprocessor, R=result type<a name="line.513"></a> +<span class="sourceLineNo">514</span> public abstract class ObserverOperationWithoutResult<O> extends ObserverOperation<O> {<a name="line.514"></a> +<span class="sourceLineNo">515</span> protected abstract void call(O observer) throws IOException;<a name="line.515"></a> +<span class="sourceLineNo">516</span><a name="line.516"></a> +<span class="sourceLineNo">517</span> public ObserverOperationWithoutResult(ObserverGetter<C, O> observerGetter) {<a name="line.517"></a> +<span class="sourceLineNo">518</span> super(observerGetter);<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> public ObserverOperationWithoutResult(ObserverGetter<C, O> observerGetter, User user) {<a name="line.521"></a> +<span class="sourceLineNo">522</span> super(observerGetter, user);<a name="line.522"></a> +<span class="sourceLineNo">523</span> }<a name="line.523"></a> +<span class="sourceLineNo">524</span><a name="line.524"></a> +<span class="sourceLineNo">525</span> public ObserverOperationWithoutResult(ObserverGetter<C, O> observerGetter, User user,<a name="line.525"></a> +<span class="sourceLineNo">526</span> boolean bypassable) {<a name="line.526"></a> +<span class="sourceLineNo">527</span> super(observerGetter, user, bypassable);<a name="line.527"></a> +<span class="sourceLineNo">528</span> }<a name="line.528"></a> +<span class="sourceLineNo">529</span><a name="line.529"></a> +<span class="sourceLineNo">530</span> /**<a name="line.530"></a> +<span class="sourceLineNo">531</span> * In case of coprocessors which have many kinds of observers (for eg, {@link RegionCoprocessor}<a name="line.531"></a> +<span class="sourceLineNo">532</span> * has BulkLoadObserver, RegionObserver, etc), some implementations may not need all<a name="line.532"></a> +<span class="sourceLineNo">533</span> * observers, in which case they will return null for that observer's getter.<a name="line.533"></a> +<span class="sourceLineNo">534</span> * We simply ignore such cases.<a name="line.534"></a> +<span class="sourceLineNo">535</span> */<a name="line.535"></a> +<span class="s
<TRUNCATED>
