Google Git
Sign in
apache / mina-site / refs/heads/mina-gen-docs / . / 2.0.18 / apidocs / src-html / org / apache / mina / filter / executor / DefaultIoEventSizeEstimator.html
blob: 2064d74d20413bb712c58d0fb6f436645b983305 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * software distributed under the License is distributed on an<a name="line.13"></a>
<span class="sourceLineNo">014</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a>
<span class="sourceLineNo">015</span> * KIND, either express or implied. See the License for the<a name="line.15"></a>
<span class="sourceLineNo">016</span> * specific language governing permissions and limitations<a name="line.16"></a>
<span class="sourceLineNo">017</span> * under the License.<a name="line.17"></a>
<span class="sourceLineNo">018</span> *<a name="line.18"></a>
<span class="sourceLineNo">019</span> */<a name="line.19"></a>
<span class="sourceLineNo">020</span>package org.apache.mina.filter.executor;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.lang.reflect.Field;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.lang.reflect.Modifier;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.HashSet;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.Set;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.concurrent.ConcurrentHashMap;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.util.concurrent.ConcurrentMap;<a name="line.27"></a>
<span class="sourceLineNo">028</span><a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.mina.core.buffer.IoBuffer;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.mina.core.session.IoEvent;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.mina.core.write.WriteRequest;<a name="line.31"></a>
<span class="sourceLineNo">032</span><a name="line.32"></a>
<span class="sourceLineNo">033</span>/**<a name="line.33"></a>
<span class="sourceLineNo">034</span> * A default {@link IoEventSizeEstimator} implementation.<a name="line.34"></a>
<span class="sourceLineNo">035</span> * &lt;p&gt;<a name="line.35"></a>
<span class="sourceLineNo">036</span> * &lt;a href="http://martin.nobilitas.com/java/sizeof.html"&gt;Martin's Java Notes&lt;/a&gt;<a name="line.36"></a>
<span class="sourceLineNo">037</span> * was used for estimation. For unknown types, it inspects declaring fields of the<a name="line.37"></a>
<span class="sourceLineNo">038</span> * class of the specified event and the parameter of the event. The size of unknown<a name="line.38"></a>
<span class="sourceLineNo">039</span> * declaring fields are approximated to the specified &lt;tt&gt;averageSizePerField&lt;/tt&gt;<a name="line.39"></a>
<span class="sourceLineNo">040</span> * (default: 64).<a name="line.40"></a>
<span class="sourceLineNo">041</span> * &lt;p&gt;<a name="line.41"></a>
<span class="sourceLineNo">042</span> * All the estimated sizes of classes are cached for performance improvement.<a name="line.42"></a>
<span class="sourceLineNo">043</span> *<a name="line.43"></a>
<span class="sourceLineNo">044</span> * @author &lt;a href="http://mina.apache.org"&gt;Apache MINA Project&lt;/a&gt;<a name="line.44"></a>
<span class="sourceLineNo">045</span> */<a name="line.45"></a>
<span class="sourceLineNo">046</span>public class DefaultIoEventSizeEstimator implements IoEventSizeEstimator {<a name="line.46"></a>
<span class="sourceLineNo">047</span> /** A map containing the estimated size of each Java objects we know for */<a name="line.47"></a>
<span class="sourceLineNo">048</span> private final ConcurrentMap&lt;Class&lt;?&gt;, Integer&gt; class2size = new ConcurrentHashMap&lt;Class&lt;?&gt;, Integer&gt;();<a name="line.48"></a>
<span class="sourceLineNo">049</span><a name="line.49"></a>
<span class="sourceLineNo">050</span> /**<a name="line.50"></a>
<span class="sourceLineNo">051</span> * Create a new instance of this class, injecting the known size of<a name="line.51"></a>
<span class="sourceLineNo">052</span> * basic java types.<a name="line.52"></a>
<span class="sourceLineNo">053</span> */<a name="line.53"></a>
<span class="sourceLineNo">054</span> public DefaultIoEventSizeEstimator() {<a name="line.54"></a>
<span class="sourceLineNo">055</span> class2size.put(boolean.class, 4); // Probably an integer.<a name="line.55"></a>
<span class="sourceLineNo">056</span> class2size.put(byte.class, 1);<a name="line.56"></a>
<span class="sourceLineNo">057</span> class2size.put(char.class, 2);<a name="line.57"></a>
<span class="sourceLineNo">058</span> class2size.put(int.class, 4);<a name="line.58"></a>
<span class="sourceLineNo">059</span> class2size.put(short.class, 2);<a name="line.59"></a>
<span class="sourceLineNo">060</span> class2size.put(long.class, 8);<a name="line.60"></a>
<span class="sourceLineNo">061</span> class2size.put(float.class, 4);<a name="line.61"></a>
<span class="sourceLineNo">062</span> class2size.put(double.class, 8);<a name="line.62"></a>
<span class="sourceLineNo">063</span> class2size.put(void.class, 0);<a name="line.63"></a>
<span class="sourceLineNo">064</span> }<a name="line.64"></a>
<span class="sourceLineNo">065</span><a name="line.65"></a>
<span class="sourceLineNo">066</span> /**<a name="line.66"></a>
<span class="sourceLineNo">067</span> * {@inheritDoc}<a name="line.67"></a>
<span class="sourceLineNo">068</span> */<a name="line.68"></a>
<span class="sourceLineNo">069</span> public int estimateSize(IoEvent event) {<a name="line.69"></a>
<span class="sourceLineNo">070</span> return estimateSize((Object) event) + estimateSize(event.getParameter());<a name="line.70"></a>
<span class="sourceLineNo">071</span> }<a name="line.71"></a>
<span class="sourceLineNo">072</span><a name="line.72"></a>
<span class="sourceLineNo">073</span> /**<a name="line.73"></a>
<span class="sourceLineNo">074</span> * Estimate the size of an Object in number of bytes<a name="line.74"></a>
<span class="sourceLineNo">075</span> * @param message The object to estimate<a name="line.75"></a>
<span class="sourceLineNo">076</span> * @return The estimated size of the object<a name="line.76"></a>
<span class="sourceLineNo">077</span> */<a name="line.77"></a>
<span class="sourceLineNo">078</span> public int estimateSize(Object message) {<a name="line.78"></a>
<span class="sourceLineNo">079</span> if (message == null) {<a name="line.79"></a>
<span class="sourceLineNo">080</span> return 8;<a name="line.80"></a>
<span class="sourceLineNo">081</span> }<a name="line.81"></a>
<span class="sourceLineNo">082</span><a name="line.82"></a>
<span class="sourceLineNo">083</span> int answer = 8 + estimateSize(message.getClass(), null);<a name="line.83"></a>
<span class="sourceLineNo">084</span><a name="line.84"></a>
<span class="sourceLineNo">085</span> if (message instanceof IoBuffer) {<a name="line.85"></a>
<span class="sourceLineNo">086</span> answer += ((IoBuffer) message).remaining();<a name="line.86"></a>
<span class="sourceLineNo">087</span> } else if (message instanceof WriteRequest) {<a name="line.87"></a>
<span class="sourceLineNo">088</span> answer += estimateSize(((WriteRequest) message).getMessage());<a name="line.88"></a>
<span class="sourceLineNo">089</span> } else if (message instanceof CharSequence) {<a name="line.89"></a>
<span class="sourceLineNo">090</span> answer += ((CharSequence) message).length() &lt;&lt; 1;<a name="line.90"></a>
<span class="sourceLineNo">091</span> } else if (message instanceof Iterable) {<a name="line.91"></a>
<span class="sourceLineNo">092</span> for (Object m : (Iterable&lt;?&gt;) message) {<a name="line.92"></a>
<span class="sourceLineNo">093</span> answer += estimateSize(m);<a name="line.93"></a>
<span class="sourceLineNo">094</span> }<a name="line.94"></a>
<span class="sourceLineNo">095</span> }<a name="line.95"></a>
<span class="sourceLineNo">096</span><a name="line.96"></a>
<span class="sourceLineNo">097</span> return align(answer);<a name="line.97"></a>
<span class="sourceLineNo">098</span> }<a name="line.98"></a>
<span class="sourceLineNo">099</span><a name="line.99"></a>
<span class="sourceLineNo">100</span> private int estimateSize(Class&lt;?&gt; clazz, Set&lt;Class&lt;?&gt;&gt; visitedClasses) {<a name="line.100"></a>
<span class="sourceLineNo">101</span> Integer objectSize = class2size.get(clazz);<a name="line.101"></a>
<span class="sourceLineNo">102</span> <a name="line.102"></a>
<span class="sourceLineNo">103</span> if (objectSize != null) {<a name="line.103"></a>
<span class="sourceLineNo">104</span> return objectSize;<a name="line.104"></a>
<span class="sourceLineNo">105</span> }<a name="line.105"></a>
<span class="sourceLineNo">106</span><a name="line.106"></a>
<span class="sourceLineNo">107</span> if (visitedClasses != null) {<a name="line.107"></a>
<span class="sourceLineNo">108</span> if (visitedClasses.contains(clazz)) {<a name="line.108"></a>
<span class="sourceLineNo">109</span> return 0;<a name="line.109"></a>
<span class="sourceLineNo">110</span> }<a name="line.110"></a>
<span class="sourceLineNo">111</span> } else {<a name="line.111"></a>
<span class="sourceLineNo">112</span> visitedClasses = new HashSet&lt;Class&lt;?&gt;&gt;();<a name="line.112"></a>
<span class="sourceLineNo">113</span> }<a name="line.113"></a>
<span class="sourceLineNo">114</span><a name="line.114"></a>
<span class="sourceLineNo">115</span> visitedClasses.add(clazz);<a name="line.115"></a>
<span class="sourceLineNo">116</span><a name="line.116"></a>
<span class="sourceLineNo">117</span> int answer = 8; // Basic overhead.<a name="line.117"></a>
<span class="sourceLineNo">118</span> <a name="line.118"></a>
<span class="sourceLineNo">119</span> for (Class&lt;?&gt; c = clazz; c != null; c = c.getSuperclass()) {<a name="line.119"></a>
<span class="sourceLineNo">120</span> Field[] fields = c.getDeclaredFields();<a name="line.120"></a>
<span class="sourceLineNo">121</span> <a name="line.121"></a>
<span class="sourceLineNo">122</span> for (Field f : fields) {<a name="line.122"></a>
<span class="sourceLineNo">123</span> if ((f.getModifiers() &amp; Modifier.STATIC) != 0) {<a name="line.123"></a>
<span class="sourceLineNo">124</span> // Ignore static fields.<a name="line.124"></a>
<span class="sourceLineNo">125</span> continue;<a name="line.125"></a>
<span class="sourceLineNo">126</span> }<a name="line.126"></a>
<span class="sourceLineNo">127</span><a name="line.127"></a>
<span class="sourceLineNo">128</span> answer += estimateSize(f.getType(), visitedClasses);<a name="line.128"></a>
<span class="sourceLineNo">129</span> }<a name="line.129"></a>
<span class="sourceLineNo">130</span> }<a name="line.130"></a>
<span class="sourceLineNo">131</span><a name="line.131"></a>
<span class="sourceLineNo">132</span> visitedClasses.remove(clazz);<a name="line.132"></a>
<span class="sourceLineNo">133</span><a name="line.133"></a>
<span class="sourceLineNo">134</span> // Some alignment.<a name="line.134"></a>
<span class="sourceLineNo">135</span> answer = align(answer);<a name="line.135"></a>
<span class="sourceLineNo">136</span><a name="line.136"></a>
<span class="sourceLineNo">137</span> // Put the final answer.<a name="line.137"></a>
<span class="sourceLineNo">138</span> Integer tmpAnswer = class2size.putIfAbsent(clazz, answer);<a name="line.138"></a>
<span class="sourceLineNo">139</span><a name="line.139"></a>
<span class="sourceLineNo">140</span> if (tmpAnswer != null) {<a name="line.140"></a>
<span class="sourceLineNo">141</span> answer = tmpAnswer;<a name="line.141"></a>
<span class="sourceLineNo">142</span> }<a name="line.142"></a>
<span class="sourceLineNo">143</span><a name="line.143"></a>
<span class="sourceLineNo">144</span> return answer;<a name="line.144"></a>
<span class="sourceLineNo">145</span> }<a name="line.145"></a>
<span class="sourceLineNo">146</span><a name="line.146"></a>
<span class="sourceLineNo">147</span> private static int align(int size) {<a name="line.147"></a>
<span class="sourceLineNo">148</span> if (size % 8 != 0) {<a name="line.148"></a>
<span class="sourceLineNo">149</span> size /= 8;<a name="line.149"></a>
<span class="sourceLineNo">150</span> size++;<a name="line.150"></a>
<span class="sourceLineNo">151</span> size *= 8;<a name="line.151"></a>
<span class="sourceLineNo">152</span> }<a name="line.152"></a>
<span class="sourceLineNo">153</span> <a name="line.153"></a>
<span class="sourceLineNo">154</span> return size;<a name="line.154"></a>
<span class="sourceLineNo">155</span> }<a name="line.155"></a>
<span class="sourceLineNo">156</span>}<a name="line.156"></a>
</pre>
</div>
</body>
</html>