blob: 8ae4d69ed8968b5efa6bc65491cb1cd521e29e17 [file] [log] [blame]
<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT> /*<a name="line.1"></a>
<FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT> * the License. You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT> *<a name="line.8"></a>
<FONT color="green">009</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT> *<a name="line.10"></a>
<FONT color="green">011</FONT> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT> * See the license for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT> * limitations under the license.<a name="line.15"></a>
<FONT color="green">016</FONT> */<a name="line.16"></a>
<FONT color="green">017</FONT> package org.apache.logging.log4j.core.helpers;<a name="line.17"></a>
<FONT color="green">018</FONT> <a name="line.18"></a>
<FONT color="green">019</FONT> import java.lang.reflect.Method;<a name="line.19"></a>
<FONT color="green">020</FONT> import java.net.InetAddress;<a name="line.20"></a>
<FONT color="green">021</FONT> import java.net.NetworkInterface;<a name="line.21"></a>
<FONT color="green">022</FONT> import java.net.UnknownHostException;<a name="line.22"></a>
<FONT color="green">023</FONT> import java.nio.ByteBuffer;<a name="line.23"></a>
<FONT color="green">024</FONT> import java.security.SecureRandom;<a name="line.24"></a>
<FONT color="green">025</FONT> import java.util.Enumeration;<a name="line.25"></a>
<FONT color="green">026</FONT> import java.util.Random;<a name="line.26"></a>
<FONT color="green">027</FONT> import java.util.UUID;<a name="line.27"></a>
<FONT color="green">028</FONT> import java.util.concurrent.atomic.AtomicInteger;<a name="line.28"></a>
<FONT color="green">029</FONT> <a name="line.29"></a>
<FONT color="green">030</FONT> /**<a name="line.30"></a>
<FONT color="green">031</FONT> * Generates a unique id. The generated UUID will be unique for approximately 8,925 years so long as<a name="line.31"></a>
<FONT color="green">032</FONT> * less than 4095 ids are generated per millisecond on the same device (as identified by its MAC adddress).<a name="line.32"></a>
<FONT color="green">033</FONT> */<a name="line.33"></a>
<FONT color="green">034</FONT> public final class UUIDUtil {<a name="line.34"></a>
<FONT color="green">035</FONT> /**<a name="line.35"></a>
<FONT color="green">036</FONT> * System property that may be used to seed the uuid generation with an integer value.<a name="line.36"></a>
<FONT color="green">037</FONT> */<a name="line.37"></a>
<FONT color="green">038</FONT> public static final String UUID_SEQUENCE = "org.apache.logging.log4j.uuidSequence";<a name="line.38"></a>
<FONT color="green">039</FONT> <a name="line.39"></a>
<FONT color="green">040</FONT> private static final String ASSIGNED_SEQUENCES = "org.apache.logging.log4j.assignedSequences";<a name="line.40"></a>
<FONT color="green">041</FONT> <a name="line.41"></a>
<FONT color="green">042</FONT> private static AtomicInteger count = new AtomicInteger(0);<a name="line.42"></a>
<FONT color="green">043</FONT> <a name="line.43"></a>
<FONT color="green">044</FONT> private static final long TYPE1 = 0x1000L;<a name="line.44"></a>
<FONT color="green">045</FONT> <a name="line.45"></a>
<FONT color="green">046</FONT> private static final byte VARIANT = (byte) 0x80;<a name="line.46"></a>
<FONT color="green">047</FONT> <a name="line.47"></a>
<FONT color="green">048</FONT> private static final int SEQUENCE_MASK = 0x3FFF;<a name="line.48"></a>
<FONT color="green">049</FONT> <a name="line.49"></a>
<FONT color="green">050</FONT> private static final long NUM_100NS_INTERVALS_SINCE_UUID_EPOCH = 0x01b21dd213814000L;<a name="line.50"></a>
<FONT color="green">051</FONT> <a name="line.51"></a>
<FONT color="green">052</FONT> private static long uuidSequence = Long.getLong(UUID_SEQUENCE, 0);<a name="line.52"></a>
<FONT color="green">053</FONT> <a name="line.53"></a>
<FONT color="green">054</FONT> private static long least;<a name="line.54"></a>
<FONT color="green">055</FONT> <a name="line.55"></a>
<FONT color="green">056</FONT> private static final long LOW_MASK = 0xffffffffL;<a name="line.56"></a>
<FONT color="green">057</FONT> private static final long MID_MASK = 0xffff00000000L;<a name="line.57"></a>
<FONT color="green">058</FONT> private static final long HIGH_MASK = 0xfff000000000000L;<a name="line.58"></a>
<FONT color="green">059</FONT> private static final int NODE_SIZE = 8;<a name="line.59"></a>
<FONT color="green">060</FONT> private static final int SHIFT_2 = 16;<a name="line.60"></a>
<FONT color="green">061</FONT> private static final int SHIFT_4 = 32;<a name="line.61"></a>
<FONT color="green">062</FONT> private static final int SHIFT_6 = 48;<a name="line.62"></a>
<FONT color="green">063</FONT> private static final int HUNDRED_NANOS_PER_MILLI = 10000;<a name="line.63"></a>
<FONT color="green">064</FONT> <a name="line.64"></a>
<FONT color="green">065</FONT> static {<a name="line.65"></a>
<FONT color="green">066</FONT> byte[] mac = null;<a name="line.66"></a>
<FONT color="green">067</FONT> try {<a name="line.67"></a>
<FONT color="green">068</FONT> InetAddress address = InetAddress.getLocalHost();<a name="line.68"></a>
<FONT color="green">069</FONT> try {<a name="line.69"></a>
<FONT color="green">070</FONT> NetworkInterface ni = NetworkInterface.getByInetAddress(address);<a name="line.70"></a>
<FONT color="green">071</FONT> if (ni != null &amp;&amp; !ni.isLoopback() &amp;&amp; ni.isUp()) {<a name="line.71"></a>
<FONT color="green">072</FONT> Method method = ni.getClass().getMethod("getHardwareAddress");<a name="line.72"></a>
<FONT color="green">073</FONT> if (method != null) {<a name="line.73"></a>
<FONT color="green">074</FONT> mac = (byte[]) method.invoke(ni);<a name="line.74"></a>
<FONT color="green">075</FONT> }<a name="line.75"></a>
<FONT color="green">076</FONT> }<a name="line.76"></a>
<FONT color="green">077</FONT> <a name="line.77"></a>
<FONT color="green">078</FONT> if (mac == null) {<a name="line.78"></a>
<FONT color="green">079</FONT> Enumeration&lt;NetworkInterface&gt; enumeration = NetworkInterface.getNetworkInterfaces();<a name="line.79"></a>
<FONT color="green">080</FONT> while (enumeration.hasMoreElements() &amp;&amp; mac == null) {<a name="line.80"></a>
<FONT color="green">081</FONT> ni = enumeration.nextElement();<a name="line.81"></a>
<FONT color="green">082</FONT> if (ni != null &amp;&amp; ni.isUp() &amp;&amp; !ni.isLoopback()) {<a name="line.82"></a>
<FONT color="green">083</FONT> Method method = ni.getClass().getMethod("getHardwareAddress");<a name="line.83"></a>
<FONT color="green">084</FONT> if (method != null) {<a name="line.84"></a>
<FONT color="green">085</FONT> mac = (byte[]) method.invoke(ni);<a name="line.85"></a>
<FONT color="green">086</FONT> }<a name="line.86"></a>
<FONT color="green">087</FONT> }<a name="line.87"></a>
<FONT color="green">088</FONT> }<a name="line.88"></a>
<FONT color="green">089</FONT> }<a name="line.89"></a>
<FONT color="green">090</FONT> } catch (Exception ex) {<a name="line.90"></a>
<FONT color="green">091</FONT> ex.printStackTrace();<a name="line.91"></a>
<FONT color="green">092</FONT> // Ignore exception<a name="line.92"></a>
<FONT color="green">093</FONT> }<a name="line.93"></a>
<FONT color="green">094</FONT> if (mac == null || mac.length == 0) {<a name="line.94"></a>
<FONT color="green">095</FONT> mac = address.getAddress();<a name="line.95"></a>
<FONT color="green">096</FONT> }<a name="line.96"></a>
<FONT color="green">097</FONT> } catch (UnknownHostException e) {<a name="line.97"></a>
<FONT color="green">098</FONT> // Ignore exception<a name="line.98"></a>
<FONT color="green">099</FONT> }<a name="line.99"></a>
<FONT color="green">100</FONT> Random randomGenerator = new SecureRandom();<a name="line.100"></a>
<FONT color="green">101</FONT> if (mac == null || mac.length == 0) {<a name="line.101"></a>
<FONT color="green">102</FONT> mac = new byte[6];<a name="line.102"></a>
<FONT color="green">103</FONT> randomGenerator.nextBytes(mac);<a name="line.103"></a>
<FONT color="green">104</FONT> }<a name="line.104"></a>
<FONT color="green">105</FONT> int length = mac.length &gt;= 6 ? 6 : mac.length;<a name="line.105"></a>
<FONT color="green">106</FONT> int index = mac.length &gt;= 6 ? mac.length - 6 : 0;<a name="line.106"></a>
<FONT color="green">107</FONT> byte[] node = new byte[NODE_SIZE];<a name="line.107"></a>
<FONT color="green">108</FONT> node[0] = VARIANT;<a name="line.108"></a>
<FONT color="green">109</FONT> node[1] = 0;<a name="line.109"></a>
<FONT color="green">110</FONT> for (int i = 2; i &lt; NODE_SIZE; ++i) {<a name="line.110"></a>
<FONT color="green">111</FONT> node[i] = 0;<a name="line.111"></a>
<FONT color="green">112</FONT> }<a name="line.112"></a>
<FONT color="green">113</FONT> System.arraycopy(mac, index, node, index + 2, length);<a name="line.113"></a>
<FONT color="green">114</FONT> ByteBuffer buf = ByteBuffer.wrap(node);<a name="line.114"></a>
<FONT color="green">115</FONT> long rand = uuidSequence;<a name="line.115"></a>
<FONT color="green">116</FONT> Runtime runtime = Runtime.getRuntime();<a name="line.116"></a>
<FONT color="green">117</FONT> synchronized (runtime) {<a name="line.117"></a>
<FONT color="green">118</FONT> String assigned = System.getProperty(ASSIGNED_SEQUENCES);<a name="line.118"></a>
<FONT color="green">119</FONT> long[] sequences;<a name="line.119"></a>
<FONT color="green">120</FONT> if (assigned == null) {<a name="line.120"></a>
<FONT color="green">121</FONT> sequences = new long[0];<a name="line.121"></a>
<FONT color="green">122</FONT> } else {<a name="line.122"></a>
<FONT color="green">123</FONT> String[] array = assigned.split(",");<a name="line.123"></a>
<FONT color="green">124</FONT> sequences = new long[array.length];<a name="line.124"></a>
<FONT color="green">125</FONT> int i = 0;<a name="line.125"></a>
<FONT color="green">126</FONT> for (String value : array) {<a name="line.126"></a>
<FONT color="green">127</FONT> sequences[i] = Long.parseLong(value);<a name="line.127"></a>
<FONT color="green">128</FONT> ++i;<a name="line.128"></a>
<FONT color="green">129</FONT> }<a name="line.129"></a>
<FONT color="green">130</FONT> }<a name="line.130"></a>
<FONT color="green">131</FONT> if (rand == 0) {<a name="line.131"></a>
<FONT color="green">132</FONT> rand = randomGenerator.nextLong();<a name="line.132"></a>
<FONT color="green">133</FONT> }<a name="line.133"></a>
<FONT color="green">134</FONT> rand &amp;= SEQUENCE_MASK;<a name="line.134"></a>
<FONT color="green">135</FONT> boolean duplicate;<a name="line.135"></a>
<FONT color="green">136</FONT> do {<a name="line.136"></a>
<FONT color="green">137</FONT> duplicate = false;<a name="line.137"></a>
<FONT color="green">138</FONT> for (long sequence : sequences) {<a name="line.138"></a>
<FONT color="green">139</FONT> if (sequence == rand) {<a name="line.139"></a>
<FONT color="green">140</FONT> duplicate = true;<a name="line.140"></a>
<FONT color="green">141</FONT> }<a name="line.141"></a>
<FONT color="green">142</FONT> }<a name="line.142"></a>
<FONT color="green">143</FONT> if (duplicate) {<a name="line.143"></a>
<FONT color="green">144</FONT> rand = (rand + 1) &amp; SEQUENCE_MASK;<a name="line.144"></a>
<FONT color="green">145</FONT> }<a name="line.145"></a>
<FONT color="green">146</FONT> } while (duplicate);<a name="line.146"></a>
<FONT color="green">147</FONT> assigned = assigned == null ? Long.toString(rand) : assigned + "," + Long.toString(rand);<a name="line.147"></a>
<FONT color="green">148</FONT> System.setProperty(ASSIGNED_SEQUENCES, assigned);<a name="line.148"></a>
<FONT color="green">149</FONT> }<a name="line.149"></a>
<FONT color="green">150</FONT> <a name="line.150"></a>
<FONT color="green">151</FONT> least = buf.getLong() | rand &lt;&lt; SHIFT_6;<a name="line.151"></a>
<FONT color="green">152</FONT> }<a name="line.152"></a>
<FONT color="green">153</FONT> <a name="line.153"></a>
<FONT color="green">154</FONT> <a name="line.154"></a>
<FONT color="green">155</FONT> /* This class cannot be instantiated */<a name="line.155"></a>
<FONT color="green">156</FONT> private UUIDUtil() {<a name="line.156"></a>
<FONT color="green">157</FONT> }<a name="line.157"></a>
<FONT color="green">158</FONT> <a name="line.158"></a>
<FONT color="green">159</FONT> /**<a name="line.159"></a>
<FONT color="green">160</FONT> * Generates Type 1 UUID. The time contains the number of 100NS intervals that have occurred<a name="line.160"></a>
<FONT color="green">161</FONT> * since 00:00:00.00 UTC, 10 October 1582. Each UUID on a particular machine is unique to the 100NS interval<a name="line.161"></a>
<FONT color="green">162</FONT> * until they rollover around 3400 A.D.<a name="line.162"></a>
<FONT color="green">163</FONT> * &lt;ol&gt;<a name="line.163"></a>
<FONT color="green">164</FONT> * &lt;li&gt;Digits 1-12 are the lower 48 bits of the number of 100 ns increments since the start of the UUID<a name="line.164"></a>
<FONT color="green">165</FONT> * epoch.&lt;/li&gt;<a name="line.165"></a>
<FONT color="green">166</FONT> * &lt;li&gt;Digit 13 is the version (with a value of 1).&lt;/li&gt;<a name="line.166"></a>
<FONT color="green">167</FONT> * &lt;li&gt;Digits 14-16 are a sequence number that is incremented each time a UUID is generated.&lt;/li&gt;<a name="line.167"></a>
<FONT color="green">168</FONT> * &lt;li&gt;Digit 17 is the variant (with a value of binary 10) and 10 bits of the sequence number&lt;/li&gt;<a name="line.168"></a>
<FONT color="green">169</FONT> * &lt;li&gt;Digit 18 is final 16 bits of the sequence number.&lt;/li&gt;<a name="line.169"></a>
<FONT color="green">170</FONT> * &lt;li&gt;Digits 19-32 represent the system the application is running on.<a name="line.170"></a>
<FONT color="green">171</FONT> * &lt;/ol&gt;<a name="line.171"></a>
<FONT color="green">172</FONT> *<a name="line.172"></a>
<FONT color="green">173</FONT> * @return universally unique identifiers (UUID)<a name="line.173"></a>
<FONT color="green">174</FONT> */<a name="line.174"></a>
<FONT color="green">175</FONT> public static UUID getTimeBasedUUID() {<a name="line.175"></a>
<FONT color="green">176</FONT> <a name="line.176"></a>
<FONT color="green">177</FONT> long time = ((System.currentTimeMillis() * HUNDRED_NANOS_PER_MILLI) + NUM_100NS_INTERVALS_SINCE_UUID_EPOCH) +<a name="line.177"></a>
<FONT color="green">178</FONT> (count.incrementAndGet() % HUNDRED_NANOS_PER_MILLI);<a name="line.178"></a>
<FONT color="green">179</FONT> long timeLow = (time &amp; LOW_MASK) &lt;&lt; SHIFT_4;<a name="line.179"></a>
<FONT color="green">180</FONT> long timeMid = (time &amp; MID_MASK) &gt;&gt; SHIFT_2;<a name="line.180"></a>
<FONT color="green">181</FONT> long timeHi = (time &amp; HIGH_MASK) &gt;&gt; SHIFT_6;<a name="line.181"></a>
<FONT color="green">182</FONT> long most = timeLow | timeMid | TYPE1 | timeHi;<a name="line.182"></a>
<FONT color="green">183</FONT> return new UUID(most, least);<a name="line.183"></a>
<FONT color="green">184</FONT> }<a name="line.184"></a>
<FONT color="green">185</FONT> }<a name="line.185"></a>
<FONT color="green">186</FONT> <a name="line.186"></a>
</PRE>
</BODY>
</HTML>