<?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://www.cs.york.ac.uk/fp/darcs/hscolour/ -->
<title>Data/Primitive/Addr.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-# LANGUAGE MagicHash, UnboxedTuples #-}</span>
<a name="line-2"></a>
<a name="line-3"></a><span class='hs-comment'>-- |</span>
<a name="line-4"></a><span class='hs-comment'>-- Module : Data.Primitive.Addr</span>
<a name="line-5"></a><span class='hs-comment'>-- Copyright : (c) Roman Leshchinskiy 2009-2010</span>
<a name="line-6"></a><span class='hs-comment'>-- License : BSD-style</span>
<a name="line-7"></a><span class='hs-comment'>--</span>
<a name="line-8"></a><span class='hs-comment'>-- Maintainer : Roman Leshchinskiy <rl@cse.unsw.edu.au></span>
<a name="line-9"></a><span class='hs-comment'>-- Portability : non-portable</span>
<a name="line-10"></a><span class='hs-comment'>-- </span>
<a name="line-11"></a><span class='hs-comment'>-- Primitive operations on machine addresses</span>
<a name="line-12"></a><span class='hs-comment'>--</span>
<a name="line-13"></a>
<a name="line-14"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Primitive</span><span class='hs-varop'>.</span><span class='hs-conid'>Addr</span> <span class='hs-layout'>(</span>
<a name="line-15"></a> <span class='hs-conid'>Addr</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span>
<a name="line-16"></a>
<a name="line-17"></a> <span class='hs-varid'>nullAddr</span><span class='hs-layout'>,</span> <span class='hs-varid'>plusAddr</span><span class='hs-layout'>,</span> <span class='hs-varid'>minusAddr</span><span class='hs-layout'>,</span> <span class='hs-varid'>remAddr</span><span class='hs-layout'>,</span>
<a name="line-18"></a> <span class='hs-varid'>indexOffAddr</span><span class='hs-layout'>,</span> <span class='hs-varid'>readOffAddr</span><span class='hs-layout'>,</span> <span class='hs-varid'>writeOffAddr</span><span class='hs-layout'>,</span>
<a name="line-19"></a> <span class='hs-varid'>memcpyAddr</span>
<a name="line-20"></a><span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-21"></a>
<a name="line-22"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Monad</span><span class='hs-varop'>.</span><span class='hs-conid'>Primitive</span>
<a name="line-23"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Primitive</span><span class='hs-varop'>.</span><span class='hs-conid'>Types</span>
<a name="line-24"></a>
<a name="line-25"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>GHC</span><span class='hs-varop'>.</span><span class='hs-conid'>Base</span> <span class='hs-layout'>(</span> <span class='hs-conid'>Int</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span> <span class='hs-layout'>)</span>
<a name="line-26"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>GHC</span><span class='hs-varop'>.</span><span class='hs-conid'>Prim</span>
<a name="line-27"></a>
<a name="line-28"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>GHC</span><span class='hs-varop'>.</span><span class='hs-conid'>Ptr</span>
<a name="line-29"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Foreign</span><span class='hs-varop'>.</span><span class='hs-conid'>Marshal</span><span class='hs-varop'>.</span><span class='hs-conid'>Utils</span>
<a name="line-30"></a>
<a name="line-31"></a>
<a name="line-32"></a><a name="nullAddr"></a><span class='hs-comment'>-- | The null address</span>
<a name="line-33"></a><span class='hs-definition'>nullAddr</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Addr</span>
<a name="line-34"></a><span class='hs-definition'>nullAddr</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Addr</span> <span class='hs-varid'>nullAddr</span><span class='hs-cpp'>#</span>
<a name="line-35"></a>
<a name="line-36"></a><span class='hs-keyword'>infixl</span> <span class='hs-num'>6</span> <span class='hs-varop'>`plusAddr`</span><span class='hs-layout'>,</span> <span class='hs-varop'>`minusAddr`</span>
<a name="line-37"></a><span class='hs-keyword'>infixl</span> <span class='hs-num'>7</span> <span class='hs-varop'>`remAddr`</span>
<a name="line-38"></a>
<a name="line-39"></a><a name="plusAddr"></a><span class='hs-comment'>-- | Offset an address by the given number of bytes</span>
<a name="line-40"></a><span class='hs-definition'>plusAddr</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Addr</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Int</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Addr</span>
<a name="line-41"></a><span class='hs-definition'>plusAddr</span> <span class='hs-layout'>(</span><span class='hs-conid'>Addr</span> <span class='hs-varid'>a</span><span class='hs-cpp'>#</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-conid'>I</span><span class='hs-cpp'>#</span> <span class='hs-varid'>i</span><span class='hs-cpp'>#</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Addr</span> <span class='hs-layout'>(</span><span class='hs-varid'>plusAddr</span><span class='hs-cpp'>#</span> <span class='hs-varid'>a</span><span class='hs-cpp'>#</span> <span class='hs-varid'>i</span><span class='hs-cpp'>#</span><span class='hs-layout'>)</span>
<a name="line-42"></a>
<a name="line-43"></a><a name="minusAddr"></a><span class='hs-comment'>-- | Distance in bytes between two addresses. The result is only valid if the</span>
<a name="line-44"></a><span class='hs-comment'>-- difference fits in an 'Int'.</span>
<a name="line-45"></a><span class='hs-definition'>minusAddr</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Addr</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Addr</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Int</span>
<a name="line-46"></a><span class='hs-definition'>minusAddr</span> <span class='hs-layout'>(</span><span class='hs-conid'>Addr</span> <span class='hs-varid'>a</span><span class='hs-cpp'>#</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-conid'>Addr</span> <span class='hs-varid'>b</span><span class='hs-cpp'>#</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>I</span><span class='hs-cpp'>#</span> <span class='hs-layout'>(</span><span class='hs-varid'>minusAddr</span><span class='hs-cpp'>#</span> <span class='hs-varid'>a</span><span class='hs-cpp'>#</span> <span class='hs-varid'>b</span><span class='hs-cpp'>#</span><span class='hs-layout'>)</span>
<a name="line-47"></a>
<a name="line-48"></a><a name="remAddr"></a><span class='hs-definition'>remAddr</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Addr</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Int</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Int</span>
<a name="line-49"></a><span class='hs-definition'>remAddr</span> <span class='hs-layout'>(</span><span class='hs-conid'>Addr</span> <span class='hs-varid'>a</span><span class='hs-cpp'>#</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-conid'>I</span><span class='hs-cpp'>#</span> <span class='hs-varid'>i</span><span class='hs-cpp'>#</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>I</span><span class='hs-cpp'>#</span> <span class='hs-layout'>(</span><span class='hs-varid'>remAddr</span><span class='hs-cpp'>#</span> <span class='hs-varid'>a</span><span class='hs-cpp'>#</span> <span class='hs-varid'>i</span><span class='hs-cpp'>#</span><span class='hs-layout'>)</span>
<a name="line-50"></a>
<a name="line-51"></a><a name="indexOffAddr"></a><span class='hs-comment'>-- | Read a value from a memory position given by an address and an offset.</span>
<a name="line-52"></a><span class='hs-comment'>-- The memory block the address refers to must be immutable. The offset is in</span>
<a name="line-53"></a><span class='hs-comment'>-- elements of type @a@ rather than in bytes.</span>
<a name="line-54"></a><span class='hs-definition'>indexOffAddr</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Prim</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>Addr</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Int</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span>
<a name="line-55"></a><span class='hs-comment'>{-# INLINE indexOffAddr #-}</span>
<a name="line-56"></a><span class='hs-definition'>indexOffAddr</span> <span class='hs-layout'>(</span><span class='hs-conid'>Addr</span> <span class='hs-varid'>addr</span><span class='hs-cpp'>#</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-conid'>I</span><span class='hs-cpp'>#</span> <span class='hs-varid'>i</span><span class='hs-cpp'>#</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>indexOffAddr</span><span class='hs-cpp'>#</span> <span class='hs-varid'>addr</span><span class='hs-cpp'>#</span> <span class='hs-varid'>i</span><span class='hs-cpp'>#</span>
<a name="line-57"></a>
<a name="line-58"></a><a name="readOffAddr"></a><span class='hs-comment'>-- | Read a value from a memory position given by an address and an offset.</span>
<a name="line-59"></a><span class='hs-comment'>-- The offset is in elements of type @a@ rather than in bytes.</span>
<a name="line-60"></a><span class='hs-definition'>readOffAddr</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>Prim</span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span> <span class='hs-conid'>PrimMonad</span> <span class='hs-varid'>m</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>Addr</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Int</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-varid'>a</span>
<a name="line-61"></a><span class='hs-comment'>{-# INLINE readOffAddr #-}</span>
<a name="line-62"></a><span class='hs-definition'>readOffAddr</span> <span class='hs-layout'>(</span><span class='hs-conid'>Addr</span> <span class='hs-varid'>addr</span><span class='hs-cpp'>#</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-conid'>I</span><span class='hs-cpp'>#</span> <span class='hs-varid'>i</span><span class='hs-cpp'>#</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>primitive</span> <span class='hs-layout'>(</span><span class='hs-varid'>readOffAddr</span><span class='hs-cpp'>#</span> <span class='hs-varid'>addr</span><span class='hs-cpp'>#</span> <span class='hs-varid'>i</span><span class='hs-cpp'>#</span><span class='hs-layout'>)</span>
<a name="line-63"></a>
<a name="line-64"></a><a name="writeOffAddr"></a><span class='hs-comment'>-- | Write a value to a memory position given by an address and an offset.</span>
<a name="line-65"></a><span class='hs-comment'>-- The offset is in elements of type @a@ rather than in bytes.</span>
<a name="line-66"></a><span class='hs-definition'>writeOffAddr</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>Prim</span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span> <span class='hs-conid'>PrimMonad</span> <span class='hs-varid'>m</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>Addr</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Int</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-conid'>()</span>
<a name="line-67"></a><span class='hs-comment'>{-# INLINE writeOffAddr #-}</span>
<a name="line-68"></a><span class='hs-definition'>writeOffAddr</span> <span class='hs-layout'>(</span><span class='hs-conid'>Addr</span> <span class='hs-varid'>addr</span><span class='hs-cpp'>#</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-conid'>I</span><span class='hs-cpp'>#</span> <span class='hs-varid'>i</span><span class='hs-cpp'>#</span><span class='hs-layout'>)</span> <span class='hs-varid'>x</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>primitive_</span> <span class='hs-layout'>(</span><span class='hs-varid'>writeOffAddr</span><span class='hs-cpp'>#</span> <span class='hs-varid'>addr</span><span class='hs-cpp'>#</span> <span class='hs-varid'>i</span><span class='hs-cpp'>#</span> <span class='hs-varid'>x</span><span class='hs-layout'>)</span>
<a name="line-69"></a>
<a name="line-70"></a><a name="memcpyAddr"></a><span class='hs-definition'>memcpyAddr</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PrimMonad</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>Addr</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Addr</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Int</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-conid'>()</span>
<a name="line-71"></a><span class='hs-definition'>memcpyAddr</span> <span class='hs-layout'>(</span><span class='hs-conid'>Addr</span> <span class='hs-varid'>dst</span><span class='hs-cpp'>#</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-conid'>Addr</span> <span class='hs-varid'>src</span><span class='hs-cpp'>#</span><span class='hs-layout'>)</span> <span class='hs-varid'>n</span>
<a name="line-72"></a> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>unsafePrimToPrim</span> <span class='hs-varop'>$</span> <span class='hs-varid'>copyBytes</span> <span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-varid'>dst</span><span class='hs-cpp'>#</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-varid'>src</span><span class='hs-cpp'>#</span><span class='hs-layout'>)</span> <span class='hs-varid'>n</span>
<a name="line-73"></a>
</pre></body>
</html>
