blob: ad51561bdcd2dea119b6dfbe2c14fc71c6a1a30c [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Source code</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="source: package: org.apache.hadoop.hbase.io.asyncfs, class: ProtobufDecoder">
<meta name="generator" content="javadoc/SourceToHTMLConverter">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
</head>
<body class="source-page">
<main role="main">
<div class="source-container">
<pre><span class="source-line-no">001</span><span id="line-1">/*</span>
<span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span>
<span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span>
<span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span>
<span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span>
<span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span>
<span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span>
<span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span>
<span class="source-line-no">009</span><span id="line-9"> *</span>
<span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="source-line-no">011</span><span id="line-11"> *</span>
<span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span>
<span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
<span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span>
<span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span>
<span class="source-line-no">017</span><span id="line-17"> */</span>
<span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.io.asyncfs;</span>
<span class="source-line-no">019</span><span id="line-19"></span>
<span class="source-line-no">020</span><span id="line-20">import java.lang.reflect.InvocationTargetException;</span>
<span class="source-line-no">021</span><span id="line-21">import java.lang.reflect.Method;</span>
<span class="source-line-no">022</span><span id="line-22">import java.util.List;</span>
<span class="source-line-no">023</span><span id="line-23">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">024</span><span id="line-24">import org.slf4j.Logger;</span>
<span class="source-line-no">025</span><span id="line-25">import org.slf4j.LoggerFactory;</span>
<span class="source-line-no">026</span><span id="line-26"></span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.hbase.thirdparty.io.netty.buffer.ByteBuf;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.hbase.thirdparty.io.netty.buffer.ByteBufUtil;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.hbase.thirdparty.io.netty.channel.ChannelHandlerContext;</span>
<span class="source-line-no">030</span><span id="line-30">import org.apache.hbase.thirdparty.io.netty.handler.codec.MessageToMessageDecoder;</span>
<span class="source-line-no">031</span><span id="line-31">import org.apache.hbase.thirdparty.io.netty.util.internal.ObjectUtil;</span>
<span class="source-line-no">032</span><span id="line-32"></span>
<span class="source-line-no">033</span><span id="line-33">/**</span>
<span class="source-line-no">034</span><span id="line-34"> * Modified based on io.netty.handler.codec.protobuf.ProtobufDecoder. The Netty's ProtobufDecode</span>
<span class="source-line-no">035</span><span id="line-35"> * supports unshaded protobuf messages (com.google.protobuf). Hadoop 3.3.0 and above relocates</span>
<span class="source-line-no">036</span><span id="line-36"> * protobuf classes to a shaded jar (hadoop-thirdparty), and so we must use reflection to detect</span>
<span class="source-line-no">037</span><span id="line-37"> * which one (relocated or not) to use. Do not use this to process HBase's shaded protobuf messages.</span>
<span class="source-line-no">038</span><span id="line-38"> * This is meant to process the protobuf messages in HDFS for the asyncfs use case.</span>
<span class="source-line-no">039</span><span id="line-39"> */</span>
<span class="source-line-no">040</span><span id="line-40">@InterfaceAudience.Private</span>
<span class="source-line-no">041</span><span id="line-41">public class ProtobufDecoder extends MessageToMessageDecoder&lt;ByteBuf&gt; {</span>
<span class="source-line-no">042</span><span id="line-42"> private static final Logger LOG = LoggerFactory.getLogger(ProtobufDecoder.class);</span>
<span class="source-line-no">043</span><span id="line-43"></span>
<span class="source-line-no">044</span><span id="line-44"> private static Class&lt;?&gt; protobufMessageLiteClass = null;</span>
<span class="source-line-no">045</span><span id="line-45"> private static Class&lt;?&gt; protobufMessageLiteBuilderClass = null;</span>
<span class="source-line-no">046</span><span id="line-46"></span>
<span class="source-line-no">047</span><span id="line-47"> private static final boolean HAS_PARSER;</span>
<span class="source-line-no">048</span><span id="line-48"></span>
<span class="source-line-no">049</span><span id="line-49"> private static Method getParserForTypeMethod;</span>
<span class="source-line-no">050</span><span id="line-50"> private static Method newBuilderForTypeMethod;</span>
<span class="source-line-no">051</span><span id="line-51"></span>
<span class="source-line-no">052</span><span id="line-52"> private Method parseFromMethod;</span>
<span class="source-line-no">053</span><span id="line-53"> private Method mergeFromMethod;</span>
<span class="source-line-no">054</span><span id="line-54"> private Method buildMethod;</span>
<span class="source-line-no">055</span><span id="line-55"></span>
<span class="source-line-no">056</span><span id="line-56"> private Object parser;</span>
<span class="source-line-no">057</span><span id="line-57"> private Object builder;</span>
<span class="source-line-no">058</span><span id="line-58"></span>
<span class="source-line-no">059</span><span id="line-59"> public ProtobufDecoder(Object prototype) {</span>
<span class="source-line-no">060</span><span id="line-60"> try {</span>
<span class="source-line-no">061</span><span id="line-61"> Method getDefaultInstanceForTypeMethod =</span>
<span class="source-line-no">062</span><span id="line-62"> protobufMessageLiteClass.getMethod("getDefaultInstanceForType");</span>
<span class="source-line-no">063</span><span id="line-63"> Object prototype1 =</span>
<span class="source-line-no">064</span><span id="line-64"> getDefaultInstanceForTypeMethod.invoke(ObjectUtil.checkNotNull(prototype, "prototype"));</span>
<span class="source-line-no">065</span><span id="line-65"></span>
<span class="source-line-no">066</span><span id="line-66"> // parser = prototype.getParserForType()</span>
<span class="source-line-no">067</span><span id="line-67"> parser = getParserForTypeMethod.invoke(prototype1);</span>
<span class="source-line-no">068</span><span id="line-68"> parseFromMethod =</span>
<span class="source-line-no">069</span><span id="line-69"> parser.getClass().getMethod("parseFrom", byte[].class, int.class, int.class);</span>
<span class="source-line-no">070</span><span id="line-70"></span>
<span class="source-line-no">071</span><span id="line-71"> // builder = prototype.newBuilderForType();</span>
<span class="source-line-no">072</span><span id="line-72"> builder = newBuilderForTypeMethod.invoke(prototype1);</span>
<span class="source-line-no">073</span><span id="line-73"> mergeFromMethod =</span>
<span class="source-line-no">074</span><span id="line-74"> builder.getClass().getMethod("mergeFrom", byte[].class, int.class, int.class);</span>
<span class="source-line-no">075</span><span id="line-75"></span>
<span class="source-line-no">076</span><span id="line-76"> // All protobuf message builders inherits from MessageLite.Builder</span>
<span class="source-line-no">077</span><span id="line-77"> buildMethod = protobufMessageLiteBuilderClass.getDeclaredMethod("build");</span>
<span class="source-line-no">078</span><span id="line-78"></span>
<span class="source-line-no">079</span><span id="line-79"> } catch (IllegalAccessException | NoSuchMethodException e) {</span>
<span class="source-line-no">080</span><span id="line-80"> throw new RuntimeException(e);</span>
<span class="source-line-no">081</span><span id="line-81"> } catch (InvocationTargetException e) {</span>
<span class="source-line-no">082</span><span id="line-82"> throw new RuntimeException(e.getTargetException());</span>
<span class="source-line-no">083</span><span id="line-83"> }</span>
<span class="source-line-no">084</span><span id="line-84"> }</span>
<span class="source-line-no">085</span><span id="line-85"></span>
<span class="source-line-no">086</span><span id="line-86"> protected void decode(ChannelHandlerContext ctx, ByteBuf msg, List&lt;Object&gt; out) throws Exception {</span>
<span class="source-line-no">087</span><span id="line-87"> int length = msg.readableBytes();</span>
<span class="source-line-no">088</span><span id="line-88"> byte[] array;</span>
<span class="source-line-no">089</span><span id="line-89"> int offset;</span>
<span class="source-line-no">090</span><span id="line-90"> if (msg.hasArray()) {</span>
<span class="source-line-no">091</span><span id="line-91"> array = msg.array();</span>
<span class="source-line-no">092</span><span id="line-92"> offset = msg.arrayOffset() + msg.readerIndex();</span>
<span class="source-line-no">093</span><span id="line-93"> } else {</span>
<span class="source-line-no">094</span><span id="line-94"> array = ByteBufUtil.getBytes(msg, msg.readerIndex(), length, false);</span>
<span class="source-line-no">095</span><span id="line-95"> offset = 0;</span>
<span class="source-line-no">096</span><span id="line-96"> }</span>
<span class="source-line-no">097</span><span id="line-97"></span>
<span class="source-line-no">098</span><span id="line-98"> Object addObj;</span>
<span class="source-line-no">099</span><span id="line-99"> if (HAS_PARSER) {</span>
<span class="source-line-no">100</span><span id="line-100"> // addObj = parser.parseFrom(array, offset, length);</span>
<span class="source-line-no">101</span><span id="line-101"> addObj = parseFromMethod.invoke(parser, array, offset, length);</span>
<span class="source-line-no">102</span><span id="line-102"> } else {</span>
<span class="source-line-no">103</span><span id="line-103"> // addObj = builder.mergeFrom(array, offset, length).build();</span>
<span class="source-line-no">104</span><span id="line-104"> Object builderObj = mergeFromMethod.invoke(builder, array, offset, length);</span>
<span class="source-line-no">105</span><span id="line-105"> addObj = buildMethod.invoke(builderObj);</span>
<span class="source-line-no">106</span><span id="line-106"> }</span>
<span class="source-line-no">107</span><span id="line-107"> out.add(addObj);</span>
<span class="source-line-no">108</span><span id="line-108"> }</span>
<span class="source-line-no">109</span><span id="line-109"></span>
<span class="source-line-no">110</span><span id="line-110"> static {</span>
<span class="source-line-no">111</span><span id="line-111"> boolean hasParser = false;</span>
<span class="source-line-no">112</span><span id="line-112"> // These are the protobuf classes coming from Hadoop. Not the one from hbase-shaded-protobuf</span>
<span class="source-line-no">113</span><span id="line-113"> try {</span>
<span class="source-line-no">114</span><span id="line-114"> protobufMessageLiteClass = Class.forName("org.apache.hadoop.thirdparty.protobuf.MessageLite");</span>
<span class="source-line-no">115</span><span id="line-115"> protobufMessageLiteBuilderClass =</span>
<span class="source-line-no">116</span><span id="line-116"> Class.forName("org.apache.hadoop.thirdparty.protobuf.MessageLite$Builder");</span>
<span class="source-line-no">117</span><span id="line-117"> LOG.debug("Hadoop 3.3 and above shades protobuf.");</span>
<span class="source-line-no">118</span><span id="line-118"> } catch (ClassNotFoundException e) {</span>
<span class="source-line-no">119</span><span id="line-119"> LOG.debug("Hadoop 3.2 and below use unshaded protobuf.", e);</span>
<span class="source-line-no">120</span><span id="line-120"> try {</span>
<span class="source-line-no">121</span><span id="line-121"> protobufMessageLiteClass = Class.forName("com.google.protobuf.MessageLite");</span>
<span class="source-line-no">122</span><span id="line-122"> protobufMessageLiteBuilderClass = Class.forName("com.google.protobuf.MessageLite$Builder");</span>
<span class="source-line-no">123</span><span id="line-123"> } catch (ClassNotFoundException ex) {</span>
<span class="source-line-no">124</span><span id="line-124"> throw new RuntimeException("can not initialize protobuf related classes for hadoop", ex);</span>
<span class="source-line-no">125</span><span id="line-125"> }</span>
<span class="source-line-no">126</span><span id="line-126"> }</span>
<span class="source-line-no">127</span><span id="line-127"></span>
<span class="source-line-no">128</span><span id="line-128"> try {</span>
<span class="source-line-no">129</span><span id="line-129"> getParserForTypeMethod = protobufMessageLiteClass.getDeclaredMethod("getParserForType");</span>
<span class="source-line-no">130</span><span id="line-130"> newBuilderForTypeMethod = protobufMessageLiteClass.getDeclaredMethod("newBuilderForType");</span>
<span class="source-line-no">131</span><span id="line-131"> // TODO: If this is false then the class will fail to load? Can refactor it out?</span>
<span class="source-line-no">132</span><span id="line-132"> hasParser = true;</span>
<span class="source-line-no">133</span><span id="line-133"> } catch (NoSuchMethodException e) {</span>
<span class="source-line-no">134</span><span id="line-134"> // If the method is not found, we are in trouble. Abort.</span>
<span class="source-line-no">135</span><span id="line-135"> throw new RuntimeException("can not initialize protobuf related classes for hadoop", e);</span>
<span class="source-line-no">136</span><span id="line-136"> }</span>
<span class="source-line-no">137</span><span id="line-137"></span>
<span class="source-line-no">138</span><span id="line-138"> HAS_PARSER = hasParser;</span>
<span class="source-line-no">139</span><span id="line-139"> }</span>
<span class="source-line-no">140</span><span id="line-140">}</span>
</pre>
</div>
</main>
</body>
</html>