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