<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<!-- Generated by HsColour, http://code.haskell.org/~malcolm/hscolour/ -->
<title>Data/UUID/V1.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-# OPTIONS_GHC -fno-cse #-}</span>
<a name="line-2"></a><span class='hs-comment'>{-# LANGUAGE TypeFamilies #-}</span>
<a name="line-3"></a>
<a name="line-4"></a><span class='hs-comment'>{- |
<a name="line-5"></a>Module : Data.UUID.V1
<a name="line-6"></a>Copyright : (c) 2008 Jason Dusek
<a name="line-7"></a> (c) 2009 Mark Lentczner
<a name="line-8"></a> (c) 2009-2010,2012 Antoine Latter
<a name="line-9"></a>
<a name="line-10"></a>License : BSD-style
<a name="line-11"></a>
<a name="line-12"></a>Maintainer : aslatter@gmail.com
<a name="line-13"></a>Stability : experimental
<a name="line-14"></a>Portability : portable
<a name="line-15"></a>
<a name="line-16"></a>RFC 4122 Version 1 UUID state machine.
<a name="line-17"></a>
<a name="line-18"></a>The generated UUID is based on the hardware MAC
<a name="line-19"></a>address and the system clock.
<a name="line-20"></a>
<a name="line-21"></a>If we cannot lookup the MAC address we seed the
<a name="line-22"></a>generator with a psuedo-random number.
<a name="line-23"></a>-}</span>
<a name="line-24"></a>
<a name="line-25"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>UUID</span><span class='hs-varop'>.</span><span class='hs-conid'>V1</span><span class='hs-layout'>(</span><span class='hs-varid'>nextUUID</span><span class='hs-layout'>)</span>
<a name="line-26"></a><span class='hs-keyword'>where</span>
<a name="line-27"></a>
<a name="line-28"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Time</span>
<a name="line-29"></a>
<a name="line-30"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Bits</span>
<a name="line-31"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Word</span>
<a name="line-32"></a>
<a name="line-33"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Applicative</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-varop'><$></span><span class='hs-layout'>)</span><span class='hs-layout'>,</span><span class='hs-layout'>(</span><span class='hs-varop'><*></span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-34"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Concurrent</span><span class='hs-varop'>.</span><span class='hs-conid'>MVar</span>
<a name="line-35"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>IO</span><span class='hs-varop'>.</span><span class='hs-conid'>Unsafe</span>
<a name="line-36"></a>
<a name="line-37"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>Random</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>R</span>
<a name="line-38"></a>
<a name="line-39"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>Info</span><span class='hs-varop'>.</span><span class='hs-conid'>MAC</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>SysMAC</span>
<a name="line-40"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>MAC</span>
<a name="line-41"></a>
<a name="line-42"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>UUID</span><span class='hs-varop'>.</span><span class='hs-conid'>Builder</span>
<a name="line-43"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>UUID</span><span class='hs-varop'>.</span><span class='hs-conid'>Internal</span>
<a name="line-44"></a>
<a name="line-45"></a><a name="nextUUID"></a><span class='hs-comment'>-- | Returns a new UUID derived from the local hardware MAC</span>
<a name="line-46"></a><span class='hs-comment'>-- address and the current system time.</span>
<a name="line-47"></a><span class='hs-comment'>-- Is generated according to the Version 1 UUID sepcified in</span>
<a name="line-48"></a><span class='hs-comment'>-- RFC 4122.</span>
<a name="line-49"></a><span class='hs-comment'>--</span>
<a name="line-50"></a><span class='hs-comment'>-- Returns 'Nothing' if you request UUIDs too quickly.</span>
<a name="line-51"></a><span class='hs-definition'>nextUUID</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-conid'>Maybe</span> <span class='hs-conid'>UUID</span><span class='hs-layout'>)</span>
<a name="line-52"></a><span class='hs-definition'>nextUUID</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-53"></a> <span class='hs-varid'>res</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>stepTime</span>
<a name="line-54"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>res</span> <span class='hs-keyword'>of</span>
<a name="line-55"></a> <span class='hs-conid'>Just</span> <span class='hs-layout'>(</span><span class='hs-varid'>mac</span><span class='hs-layout'>,</span> <span class='hs-varid'>c</span><span class='hs-layout'>,</span> <span class='hs-varid'>t</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-conid'>Just</span> <span class='hs-varop'>$</span> <span class='hs-varid'>makeUUID</span> <span class='hs-varid'>t</span> <span class='hs-varid'>c</span> <span class='hs-varid'>mac</span>
<a name="line-56"></a> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>return</span> <span class='hs-conid'>Nothing</span>
<a name="line-57"></a>
<a name="line-58"></a>
<a name="line-59"></a><a name="makeUUID"></a><span class='hs-definition'>makeUUID</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Word64</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Word16</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>MAC</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>UUID</span>
<a name="line-60"></a><span class='hs-definition'>makeUUID</span> <span class='hs-varid'>time</span> <span class='hs-varid'>clock</span> <span class='hs-varid'>mac</span> <span class='hs-keyglyph'>=</span>
<a name="line-61"></a> <span class='hs-varid'>buildFromBytes</span> <span class='hs-num'>1</span> <span class='hs-varop'>/-/</span> <span class='hs-varid'>tLow</span> <span class='hs-varop'>/-/</span> <span class='hs-varid'>tMid</span> <span class='hs-varop'>/-/</span> <span class='hs-varid'>tHigh</span> <span class='hs-varop'>/-/</span> <span class='hs-varid'>clock</span> <span class='hs-varop'>/-/</span> <span class='hs-layout'>(</span><span class='hs-conid'>MACSource</span> <span class='hs-varid'>mac</span><span class='hs-layout'>)</span>
<a name="line-62"></a> <span class='hs-keyword'>where</span> <span class='hs-varid'>tLow</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-varid'>fromIntegral</span> <span class='hs-varid'>time</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Word32</span>
<a name="line-63"></a> <span class='hs-varid'>tMid</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-varid'>fromIntegral</span> <span class='hs-layout'>(</span><span class='hs-varid'>time</span> <span class='hs-varop'>`shiftR`</span> <span class='hs-num'>32</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Word16</span>
<a name="line-64"></a> <span class='hs-varid'>tHigh</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-varid'>fromIntegral</span> <span class='hs-layout'>(</span><span class='hs-varid'>time</span> <span class='hs-varop'>`shiftR`</span> <span class='hs-num'>48</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Word16</span>
<a name="line-65"></a>
<a name="line-66"></a><a name="MACSource"></a><span class='hs-keyword'>newtype</span> <span class='hs-conid'>MACSource</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>MACSource</span> <span class='hs-conid'>MAC</span>
<a name="line-67"></a><a name="instance%20ByteSource%20MACSource"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>ByteSource</span> <span class='hs-conid'>MACSource</span> <span class='hs-keyword'>where</span>
<a name="line-68"></a> <span class='hs-varid'>z</span> <span class='hs-varop'>/-/</span> <span class='hs-layout'>(</span><span class='hs-conid'>MACSource</span> <span class='hs-layout'>(</span><span class='hs-conid'>MAC</span> <span class='hs-varid'>a</span> <span class='hs-varid'>b</span> <span class='hs-varid'>c</span> <span class='hs-varid'>d</span> <span class='hs-varid'>e</span> <span class='hs-varid'>f</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>z</span> <span class='hs-varid'>a</span> <span class='hs-varid'>b</span> <span class='hs-varid'>c</span> <span class='hs-varid'>d</span> <span class='hs-varid'>e</span> <span class='hs-varid'>f</span>
<a name="line-69"></a><span class='hs-keyword'>type</span> <span class='hs-keyword'>instance</span> <span class='hs-conid'>ByteSink</span> <span class='hs-conid'>MACSource</span> <span class='hs-varid'>g</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Takes3Bytes</span> <span class='hs-layout'>(</span><span class='hs-conid'>Takes3Bytes</span> <span class='hs-varid'>g</span><span class='hs-layout'>)</span>
<a name="line-70"></a>
<a name="line-71"></a>
<a name="line-72"></a><a name="stepTime"></a><span class='hs-comment'>-- |Approximates the clock algorithm in RFC 4122, section 4.2</span>
<a name="line-73"></a><span class='hs-comment'>-- Isn't system wide or thread safe, nor does it properly randomize</span>
<a name="line-74"></a><span class='hs-comment'>-- the clock value on initialization.</span>
<a name="line-75"></a><span class='hs-definition'>stepTime</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-conid'>Maybe</span> <span class='hs-layout'>(</span><span class='hs-conid'>MAC</span><span class='hs-layout'>,</span> <span class='hs-conid'>Word16</span><span class='hs-layout'>,</span> <span class='hs-conid'>Word64</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-76"></a><span class='hs-definition'>stepTime</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-77"></a> <span class='hs-varid'>h1</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>fmap</span> <span class='hs-varid'>hundredsOfNanosSinceGregorianReform</span> <span class='hs-varid'>getCurrentTime</span>
<a name="line-78"></a> <span class='hs-varid'>modifyMVar</span> <span class='hs-varid'>state</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>s</span><span class='hs-keyglyph'>@</span><span class='hs-layout'>(</span><span class='hs-conid'>State</span> <span class='hs-varid'>mac</span> <span class='hs-varid'>c0</span> <span class='hs-varid'>h0</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span>
<a name="line-79"></a> <span class='hs-keyword'>if</span> <span class='hs-varid'>h1</span> <span class='hs-varop'>></span> <span class='hs-varid'>h0</span>
<a name="line-80"></a> <span class='hs-keyword'>then</span>
<a name="line-81"></a> <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-conid'>State</span> <span class='hs-varid'>mac</span> <span class='hs-varid'>c0</span> <span class='hs-varid'>h1</span><span class='hs-layout'>,</span> <span class='hs-conid'>Just</span> <span class='hs-layout'>(</span><span class='hs-varid'>mac</span><span class='hs-layout'>,</span> <span class='hs-varid'>c0</span><span class='hs-layout'>,</span> <span class='hs-varid'>h1</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-82"></a> <span class='hs-keyword'>else</span>
<a name="line-83"></a> <span class='hs-keyword'>let</span>
<a name="line-84"></a> <span class='hs-varid'>c1</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>succ</span> <span class='hs-varid'>c0</span>
<a name="line-85"></a> <span class='hs-keyword'>in</span> <span class='hs-keyword'>if</span> <span class='hs-varid'>c1</span> <span class='hs-varop'><=</span> <span class='hs-num'>0x3fff</span> <span class='hs-comment'>-- when clock is initially randomized,</span>
<a name="line-86"></a> <span class='hs-comment'>-- then this test will need to change</span>
<a name="line-87"></a> <span class='hs-keyword'>then</span>
<a name="line-88"></a> <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-conid'>State</span> <span class='hs-varid'>mac</span> <span class='hs-varid'>c1</span> <span class='hs-varid'>h1</span><span class='hs-layout'>,</span> <span class='hs-conid'>Just</span> <span class='hs-layout'>(</span><span class='hs-varid'>mac</span><span class='hs-layout'>,</span> <span class='hs-varid'>c1</span><span class='hs-layout'>,</span> <span class='hs-varid'>h1</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-89"></a> <span class='hs-keyword'>else</span>
<a name="line-90"></a> <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-varid'>s</span><span class='hs-layout'>,</span> <span class='hs-conid'>Nothing</span><span class='hs-layout'>)</span>
<a name="line-91"></a>
<a name="line-92"></a>
<a name="line-93"></a><a name="state"></a><span class='hs-comment'>{-# NOINLINE state #-}</span>
<a name="line-94"></a><span class='hs-definition'>state</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>MVar</span> <span class='hs-conid'>State</span>
<a name="line-95"></a><span class='hs-definition'>state</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>unsafePerformIO</span> <span class='hs-varop'>$</span> <span class='hs-keyword'>do</span>
<a name="line-96"></a> <span class='hs-varid'>h0</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>fmap</span> <span class='hs-varid'>hundredsOfNanosSinceGregorianReform</span> <span class='hs-varid'>getCurrentTime</span>
<a name="line-97"></a> <span class='hs-varid'>mac</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>getMac</span>
<a name="line-98"></a> <span class='hs-varid'>newMVar</span> <span class='hs-varop'>$</span> <span class='hs-conid'>State</span> <span class='hs-varid'>mac</span> <span class='hs-num'>0</span> <span class='hs-varid'>h0</span> <span class='hs-comment'>-- the 0 should be a random number</span>
<a name="line-99"></a>
<a name="line-100"></a><a name="getMac"></a><span class='hs-comment'>-- SysMAC.mac can fail on some machines.</span>
<a name="line-101"></a><span class='hs-comment'>-- In those cases we fake it with a random</span>
<a name="line-102"></a><span class='hs-comment'>-- 6 bytes seed.</span>
<a name="line-103"></a><span class='hs-definition'>getMac</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>MAC</span>
<a name="line-104"></a><span class='hs-definition'>getMac</span> <span class='hs-keyglyph'>=</span>
<a name="line-105"></a> <span class='hs-conid'>SysMAC</span><span class='hs-varop'>.</span><span class='hs-varid'>mac</span> <span class='hs-varop'>>>=</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>macM</span> <span class='hs-keyglyph'>-></span>
<a name="line-106"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>macM</span> <span class='hs-keyword'>of</span>
<a name="line-107"></a> <span class='hs-conid'>Just</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>return</span> <span class='hs-varid'>m</span>
<a name="line-108"></a> <span class='hs-conid'>Nothing</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>randomMac</span>
<a name="line-109"></a>
<a name="line-110"></a><a name="randomMac"></a><span class='hs-definition'>randomMac</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>MAC</span>
<a name="line-111"></a><span class='hs-definition'>randomMac</span> <span class='hs-keyglyph'>=</span>
<a name="line-112"></a> <span class='hs-comment'>-- I'm too lazy to thread through</span>
<a name="line-113"></a> <span class='hs-comment'>-- the random state ...</span>
<a name="line-114"></a> <span class='hs-conid'>MAC</span>
<a name="line-115"></a> <span class='hs-varop'><$></span> <span class='hs-conid'>R</span><span class='hs-varop'>.</span><span class='hs-varid'>randomIO</span>
<a name="line-116"></a> <span class='hs-varop'><*></span> <span class='hs-conid'>R</span><span class='hs-varop'>.</span><span class='hs-varid'>randomIO</span>
<a name="line-117"></a> <span class='hs-varop'><*></span> <span class='hs-conid'>R</span><span class='hs-varop'>.</span><span class='hs-varid'>randomIO</span>
<a name="line-118"></a> <span class='hs-varop'><*></span> <span class='hs-conid'>R</span><span class='hs-varop'>.</span><span class='hs-varid'>randomIO</span>
<a name="line-119"></a> <span class='hs-varop'><*></span> <span class='hs-conid'>R</span><span class='hs-varop'>.</span><span class='hs-varid'>randomIO</span>
<a name="line-120"></a> <span class='hs-varop'><*></span> <span class='hs-conid'>R</span><span class='hs-varop'>.</span><span class='hs-varid'>randomIO</span>
<a name="line-121"></a>
<a name="line-122"></a><a name="State"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>State</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>State</span>
<a name="line-123"></a> <span class='hs-comment'>{-# UNPACK #-}</span> <span class='hs-varop'>!</span><span class='hs-conid'>MAC</span>
<a name="line-124"></a> <span class='hs-comment'>{-# UNPACK #-}</span> <span class='hs-varop'>!</span><span class='hs-conid'>Word16</span>
<a name="line-125"></a> <span class='hs-comment'>{-# UNPACK #-}</span> <span class='hs-varop'>!</span><span class='hs-conid'>Word64</span>
<a name="line-126"></a> <span class='hs-keyword'>deriving</span> <span class='hs-layout'>(</span><span class='hs-conid'>Show</span><span class='hs-layout'>)</span>
<a name="line-127"></a>
<a name="line-128"></a>
<a name="line-129"></a>
<a name="line-130"></a><a name="hundredsOfNanosSinceGregorianReform"></a><span class='hs-definition'>hundredsOfNanosSinceGregorianReform</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>UTCTime</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Word64</span>
<a name="line-131"></a><span class='hs-definition'>hundredsOfNanosSinceGregorianReform</span> <span class='hs-varid'>t</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>floor</span> <span class='hs-varop'>$</span> <span class='hs-num'>10000000</span> <span class='hs-varop'>*</span> <span class='hs-varid'>dt</span>
<a name="line-132"></a> <span class='hs-keyword'>where</span>
<a name="line-133"></a> <span class='hs-varid'>gregorianReform</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>UTCTime</span> <span class='hs-layout'>(</span><span class='hs-varid'>fromGregorian</span> <span class='hs-num'>1582</span> <span class='hs-num'>10</span> <span class='hs-num'>15</span><span class='hs-layout'>)</span> <span class='hs-num'>0</span>
<a name="line-134"></a> <span class='hs-varid'>dt</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>t</span> <span class='hs-varop'>`diffUTCTime`</span> <span class='hs-varid'>gregorianReform</span>
<a name="line-135"></a>
<a name="line-136"></a>
<a name="line-137"></a>
</pre></body>
</html>
