diff options
Diffstat (limited to 'src/Data')
-rw-r--r-- | src/Data/Bitfield.hs | 443 | ||||
-rw-r--r-- | src/Data/Bitfield/Mutable.hs | 177 |
2 files changed, 149 insertions, 471 deletions
diff --git a/src/Data/Bitfield.hs b/src/Data/Bitfield.hs index f7240c8a..546c68e9 100644 --- a/src/Data/Bitfield.hs +++ b/src/Data/Bitfield.hs | |||
@@ -5,341 +5,196 @@ | |||
5 | -- Stability : experimental | 5 | -- Stability : experimental |
6 | -- Portability : portable | 6 | -- Portability : portable |
7 | -- | 7 | -- |
8 | -- | 8 | -- This modules provides all necessary machinery to work with |
9 | -- This module provides Bitfield datatype used to represent sets of | 9 | -- bitfields. Bitfields are used to keep track indices of complete |
10 | -- piece indexes any peer have. All associated operations should be | 10 | -- pieces either peer have or client have. |
11 | -- defined here as well. | ||
12 | -- | 11 | -- |
13 | {-# LANGUAGE BangPatterns #-} | 12 | {-# LANGUAGE BangPatterns #-} |
14 | {-# LANGUAGE RankNTypes #-} | 13 | {-# LANGUAGE RecordWildCards #-} |
15 | module Data.Bitfield | 14 | module Data.Bitfield |
16 | -- TODO: move to Data.Bitfield | 15 | ( Bitfield, PieceCount |
17 | ( Bitfield(..) | ||
18 | 16 | ||
19 | -- * Construction | 17 | -- * Construction |
20 | , empty, full | 18 | , empty |
19 | , insert | ||
20 | , haveAll, haveNone, have | ||
21 | 21 | ||
22 | -- * Query | 22 | -- * Query |
23 | , bitfieldByteCount, bitfieldBitCount | 23 | , haveCount, totalCount, completeness |
24 | |||
25 | , haveCount, completeness | ||
26 | , findMin, findMax | 24 | , findMin, findMax |
27 | , union, intersection, difference, combine | 25 | , frequencies, rarest |
28 | , frequencies | 26 | |
27 | -- * Combine | ||
28 | , union | ||
29 | , intersection | ||
30 | , difference | ||
29 | 31 | ||
30 | -- * Serialization | 32 | -- * Serialization |
31 | , getBitfield, putBitfield | 33 | , getBitfield, putBitfield |
34 | , bitfieldByteCount | ||
32 | 35 | ||
33 | -- * Conversion | 36 | , -- * Debug |
34 | , toList | 37 | mkBitfield |
35 | , fromByteString, toByteString | ||
36 | |||
37 | -- * Debug | ||
38 | , aligned, alignLow, alignedZip | ||
39 | ) where | 38 | ) where |
40 | 39 | ||
41 | import Control.Applicative hiding (empty) | 40 | import Control.Monad |
42 | import Data.Bits | 41 | import Control.Monad.ST |
43 | import Data.ByteString (ByteString) | 42 | import Data.Vector.Unboxed (Vector) |
44 | import qualified Data.ByteString as B | 43 | import qualified Data.Vector.Unboxed as V |
45 | import qualified Data.ByteString.Internal as B | 44 | import qualified Data.Vector.Unboxed.Mutable as VM |
46 | import Data.List as L hiding (union) | 45 | import Data.IntervalSet (IntSet) |
47 | import Data.Serialize | 46 | import qualified Data.IntervalSet as S |
48 | import Data.Word | 47 | import Data.List (foldl') |
48 | import Data.Monoid | ||
49 | import Data.Ratio | ||
50 | import Data.Serialize | ||
51 | import Network.BitTorrent.PeerWire.Block | ||
49 | 52 | ||
50 | import Foreign | ||
51 | 53 | ||
52 | --import Network.BitTorrent.PeerWire.Block | 54 | type PieceCount = Int |
53 | import Data.Torrent | ||
54 | 55 | ||
55 | -- TODO: one good idea is to aggregate frequently used stats in reducer | 56 | -- TODO cache some operations |
56 | -- it should give a big boost | ||
57 | newtype Bitfield = MkBitfield { | ||
58 | bfBits :: ByteString | ||
59 | -- , bfSize :: Int | ||
60 | } deriving (Show, Eq, Ord) | ||
61 | 57 | ||
58 | -- | Bitfields are represented just as integer sets but with | ||
59 | -- restriction: the each set should be within given interval (or | ||
60 | -- subset of). Size is used to specify interval, so bitfield of size | ||
61 | -- 10 might contain only indices in interval [0..9]. | ||
62 | -- | ||
63 | data Bitfield = Bitfield { | ||
64 | bfSize :: !PieceCount | ||
65 | , bfSet :: !IntSet | ||
66 | } deriving (Show, Read, Eq) | ||
62 | 67 | ||
63 | empty :: Int -> Bitfield | 68 | -- Invariants: all elements of bfSet lie in [0..bfSize - 1]; |
64 | empty n = MkBitfield $ B.replicate (sizeInBase n 8) 0 | ||
65 | {-# INLINE empty #-} | ||
66 | 69 | ||
67 | full :: Int -> Bitfield | 70 | instance Monoid Bitfield where |
68 | full n = MkBitfield $ B.replicate (sizeInBase n 8) (complement 0) | 71 | {-# SPECIALIZE instance Monoid Bitfield #-} |
69 | {-# INLINE full #-} | 72 | mempty = empty 0 |
73 | mappend = union | ||
74 | mconcat = unions | ||
70 | 75 | ||
71 | toList :: Bitfield -> [Bool] | 76 | -- TODO documentation |
72 | toList (MkBitfield bs) = concatMap unpkg (B.unpack bs) | 77 | {----------------------------------------------------------------------- |
73 | where | 78 | Construction |
74 | unpkg :: Word8 -> [Bool] | 79 | -----------------------------------------------------------------------} |
75 | unpkg byte = L.map (testBit byte) [0..bitSize (undefined :: Word8) - 1] | ||
76 | {-# INLINE toList #-} | ||
77 | 80 | ||
78 | fromByteString :: ByteString -> Bitfield | 81 | empty :: PieceCount -> Bitfield |
79 | fromByteString = MkBitfield | 82 | empty s = Bitfield s S.empty |
80 | {-# INLINE fromByteString #-} | ||
81 | 83 | ||
82 | toByteString :: Bitfield -> ByteString | 84 | insert :: PieceIx -> Bitfield -> Bitfield |
83 | toByteString = bfBits | 85 | insert ix Bitfield {..} |
84 | {-# INLINE toByteString #-} | 86 | | 0 <= ix && ix < bfSize = Bitfield bfSize (S.insert ix bfSet) |
87 | | otherwise = Bitfield bfSize bfSet | ||
85 | 88 | ||
86 | getBitfield :: Int -> Get Bitfield | 89 | haveNone :: PieceCount -> Bitfield |
87 | getBitfield n = MkBitfield <$> getBytes n | 90 | haveNone = empty |
88 | {-# INLINE getBitfield #-} | ||
89 | 91 | ||
90 | putBitfield :: Bitfield -> Put | 92 | haveAll :: PieceCount -> Bitfield |
91 | putBitfield = putByteString . bfBits | 93 | haveAll s = Bitfield s (S.interval 0 (s - 1)) |
92 | {-# INLINE putBitfield #-} | ||
93 | 94 | ||
94 | bitfieldByteCount :: Bitfield -> Int | 95 | have :: PieceIx -> Bitfield -> Bitfield |
95 | bitfieldByteCount = B.length . bfBits | 96 | have = insert |
96 | {-# INLINE bitfieldByteCount #-} | ||
97 | 97 | ||
98 | -- WARN | 98 | {----------------------------------------------------------------------- |
99 | -- TODO | 99 | Query |
100 | bitfieldBitCount :: Bitfield -> Int | 100 | -----------------------------------------------------------------------} |
101 | bitfieldBitCount bf = bitSize (undefined :: Word8) * bitfieldByteCount bf | ||
102 | {-# INLINE bitfieldBitCount #-} | ||
103 | 101 | ||
104 | align :: Storable a => Ptr a -> (Ptr a, Int) | 102 | haveCount :: Bitfield -> PieceCount |
105 | align p = tie (alignPtr p) undefined | 103 | haveCount = S.size . bfSet |
106 | where | 104 | |
107 | tie :: Storable a => (Int -> Ptr a) -> a -> (Ptr a, Int) | 105 | totalCount :: Bitfield -> PieceCount |
108 | tie f a = (f (alignment a), (alignment a)) | 106 | totalCount = bfSize |
109 | |||
110 | alignLow :: Ptr Word8 -> Ptr Word | ||
111 | alignLow ptr = | ||
112 | let alg = alignment (undefined :: Word) | ||
113 | aptr = alignPtr (castPtr ptr) alg :: Ptr Word | ||
114 | in | ||
115 | if ptr == castPtr aptr | ||
116 | then aptr | ||
117 | else castPtr ((castPtr aptr :: Ptr Word8) `advancePtr` negate alg) | ||
118 | |||
119 | isAlignedBy :: Storable a => Ptr a -> Int -> Bool | ||
120 | isAlignedBy ptr alg = alignPtr ptr alg == ptr | ||
121 | |||
122 | type Mem a = (Ptr a, Int) | ||
123 | |||
124 | aligned :: Storable a => Mem Word8 -> (Mem Word8, Mem a, Mem Word8) | ||
125 | aligned (ptr, len) = | ||
126 | let lowPtr = ptr | ||
127 | lowLen = midPtr `minusPtr` ptr | ||
128 | midOff = lowLen | ||
129 | (midPtr, alg) = align (castPtr ptr) | ||
130 | midLen = alg * div (len - midOff) alg | ||
131 | midLenA = midLen `div` alg | ||
132 | hghOff = midOff + midLen | ||
133 | hghPtr = ptr `advancePtr` hghOff | ||
134 | hghLen = len - hghOff | ||
135 | in | ||
136 | ((lowPtr, lowLen), (midPtr, midLenA), (hghPtr, hghLen)) | ||
137 | where | ||
138 | {-# INLINE aligned #-} | ||
139 | |||
140 | type Mem3 a = (Ptr a, Ptr a, Ptr a, Int) | ||
141 | |||
142 | emptyMem3 :: Mem3 a | ||
143 | emptyMem3 = (nullPtr, nullPtr, nullPtr, 0) | ||
144 | |||
145 | -- assume resulting memory is aligned | ||
146 | alignedZip :: Ptr Word8 -> Ptr Word8 -> Ptr Word8 -> Int | ||
147 | -> (Mem3 Word, Mem3 Word8) | ||
148 | alignedZip aptr bptr cptr size = | ||
149 | let alg = alignment (undefined :: Word) in | ||
150 | if (aptr `isAlignedBy` alg) && (bptr `isAlignedBy` alg) | ||
151 | then | ||
152 | let asize = alignLow (nullPtr `plusPtr` size) `minusPtr` nullPtr | ||
153 | in | ||
154 | ( (castPtr aptr, castPtr bptr, castPtr cptr, asize `div` alg) | ||
155 | , ( aptr `advancePtr` asize | ||
156 | , bptr `advancePtr` asize | ||
157 | , cptr `advancePtr` asize | ||
158 | , (size - asize) | ||
159 | ) | ||
160 | ) | ||
161 | else (emptyMem3, (aptr, bptr, cptr, size)) | ||
162 | |||
163 | -- force specialization | ||
164 | zipWithBS :: (Word -> Word -> Word) | ||
165 | -> (Word8 -> Word8 -> Word8) | ||
166 | -> ByteString -> ByteString -> ByteString | ||
167 | zipWithBS f g a b = | ||
168 | let (afptr, aoff, asize) = B.toForeignPtr a | ||
169 | (bfptr, boff, bsize) = B.toForeignPtr b | ||
170 | size = min asize bsize in | ||
171 | B.unsafeCreate size $ \rptr -> do | ||
172 | withForeignPtr afptr $ \_aptr -> do | ||
173 | withForeignPtr bfptr $ \_bptr -> do | ||
174 | let aptr = _aptr `advancePtr` aoff | ||
175 | let bptr = _bptr `advancePtr` boff | ||
176 | |||
177 | let (mid, hgh) = alignedZip aptr bptr rptr size | ||
178 | zipWords mid | ||
179 | zipBytes hgh | ||
180 | where | ||
181 | zipBytes :: (Ptr Word8, Ptr Word8, Ptr Word8, Int) -> IO () | ||
182 | zipBytes (aptr, bptr, rptr, n) = go 0 | ||
183 | where | ||
184 | go :: Int -> IO () | ||
185 | go i | i < n = do -- TODO unfold | ||
186 | av <- peekElemOff aptr i | ||
187 | bv <- peekElemOff bptr i | ||
188 | pokeElemOff rptr i (g av bv) | ||
189 | go (succ i) | ||
190 | | otherwise = return () | ||
191 | |||
192 | zipWords :: (Ptr Word, Ptr Word, Ptr Word, Int) -> IO () | ||
193 | zipWords (aptr, bptr, rptr, n) = go 0 | ||
194 | where | ||
195 | go :: Int -> IO () | ||
196 | go i | i < n = do -- TODO unfold | ||
197 | av <- peekElemOff aptr i | ||
198 | bv <- peekElemOff bptr i | ||
199 | pokeElemOff rptr i (f av bv) | ||
200 | go (succ i) | ||
201 | | otherwise = return () | ||
202 | |||
203 | |||
204 | |||
205 | zipWithBF :: (forall a. Bits a => a -> a -> a) -> Bitfield -> Bitfield -> Bitfield | ||
206 | zipWithBF f a b = MkBitfield $ zipWithBS f f (bfBits a) (bfBits b) | ||
207 | {-# INLINE zipWithBF #-} | ||
208 | |||
209 | findSet :: ByteString -> Maybe Int | ||
210 | findSet b = | ||
211 | let (fptr, off, len) = B.toForeignPtr b in | ||
212 | B.inlinePerformIO $ withForeignPtr fptr $ \_ptr -> do | ||
213 | let ptr = _ptr `advancePtr` off | ||
214 | |||
215 | let (low, mid, hgh) = aligned (ptr, len) | ||
216 | let lowOff = fst low `minusPtr` ptr | ||
217 | let midOff = fst mid `minusPtr` ptr | ||
218 | let hghOff = fst hgh `minusPtr` ptr | ||
219 | |||
220 | let resL = (lowOff +) <$> goFind low | ||
221 | let resM = (midOff +) <$> goFind (mid :: Mem Word) -- tune size here | ||
222 | -- TODO: with Word8 | ||
223 | -- bytestring findIndex works 2 | ||
224 | -- times faster. | ||
225 | let resH = (hghOff +) <$> goFind hgh | ||
226 | |||
227 | let res = resL <|> resM <|> resH | ||
228 | |||
229 | -- computation of res should not escape withForeignPtr | ||
230 | case res of | ||
231 | Nothing -> return () | ||
232 | Just _ -> return () | ||
233 | |||
234 | return res | ||
235 | 107 | ||
108 | -- | | ||
109 | -- | ||
110 | -- > forall bf. 0 <= completeness bf <= 1 | ||
111 | -- | ||
112 | completeness :: Bitfield -> Ratio PieceCount | ||
113 | completeness b = haveCount b % totalCount b | ||
114 | |||
115 | findMin :: Bitfield -> Maybe PieceIx | ||
116 | findMin Bitfield {..} | ||
117 | | S.null bfSet = Nothing | ||
118 | | otherwise = Just (S.findMin bfSet) | ||
119 | |||
120 | findMax :: Bitfield -> Maybe PieceIx | ||
121 | findMax Bitfield {..} | ||
122 | | S.null bfSet = Nothing | ||
123 | | otherwise = Just (S.findMax bfSet) | ||
124 | |||
125 | type Frequency = Int | ||
126 | |||
127 | frequencies :: [Bitfield] -> Vector Frequency | ||
128 | frequencies [] = V.fromList [] | ||
129 | frequencies xs = runST $ do | ||
130 | v <- VM.new size | ||
131 | VM.set v 0 | ||
132 | forM_ xs $ \ Bitfield {..} -> do | ||
133 | forM_ (S.toList bfSet) $ \ x -> do | ||
134 | fr <- VM.read v x | ||
135 | VM.write v x (succ fr) | ||
136 | V.unsafeFreeze v | ||
236 | where | 137 | where |
237 | goFind :: (Storable a, Eq a, Num a) => Mem a -> Maybe Int | 138 | size = maximum (map bfSize xs) |
238 | goFind (ptr, n) = go 0 | ||
239 | where | ||
240 | go :: Int -> Maybe Int | ||
241 | go i | i < n = | ||
242 | let v = B.inlinePerformIO (peekElemOff ptr i) in | ||
243 | if v /= 0 | ||
244 | then Just i | ||
245 | else go (succ i) | ||
246 | | otherwise = Nothing | ||
247 | |||
248 | foldBS :: (Word8 -> Int -> Int) -> (Word -> Int -> Int) -> Int -> ByteString -> Int | ||
249 | foldBS f g acc b = | ||
250 | let (fptr, off, len) = B.toForeignPtr b in | ||
251 | B.inlinePerformIO $ withForeignPtr fptr $ \_ptr -> do | ||
252 | let ptr = _ptr `advancePtr` off | ||
253 | |||
254 | let (low, mid, hgh) = aligned (ptr, len) | ||
255 | let resL = goFold low acc | ||
256 | let resM = goFoldW (mid :: Mem Word) resL | ||
257 | let resH = goFold hgh resM | ||
258 | |||
259 | -- computation of res should not escape withForeignPtr | ||
260 | case resH of | ||
261 | 0 -> return () | ||
262 | _ -> return () | ||
263 | |||
264 | return resH | ||
265 | 139 | ||
140 | rarest :: [Bitfield] -> Maybe PieceIx | ||
141 | rarest xs | ||
142 | | V.null freqMap = Nothing | ||
143 | | otherwise = Just $ fst $ V.ifoldr minIx (0, freqMap V.! 0) freqMap | ||
266 | where | 144 | where |
267 | goFold :: Mem Word8 -> Int -> Int | 145 | freqMap = frequencies xs |
268 | goFold (ptr, n) = go 0 | 146 | |
269 | where | 147 | minIx :: PieceIx -> Frequency -> (PieceIx, Frequency) -> (PieceIx, Frequency) |
270 | go :: Int -> Int -> Int | 148 | minIx ix fr acc@(_, fra) |
271 | go i !a | 149 | | fr < fra && fr > 0 = (ix, fr) |
272 | | i < n = | 150 | | otherwise = acc |
273 | let v = B.inlinePerformIO (peekElemOff ptr i) | 151 | |
274 | in go (succ i) (f v a) | 152 | |
275 | | otherwise = a | 153 | |
276 | 154 | {----------------------------------------------------------------------- | |
277 | goFoldW :: Mem Word -> Int -> Int | 155 | Combine |
278 | goFoldW (ptr, n) = go 0 | 156 | -----------------------------------------------------------------------} |
279 | where | ||
280 | go :: Int -> Int -> Int | ||
281 | go i !a | ||
282 | | i < n = | ||
283 | let v = B.inlinePerformIO (peekElemOff ptr i) | ||
284 | in go (succ i) (g v a) | ||
285 | | otherwise = a | ||
286 | 157 | ||
287 | union :: Bitfield -> Bitfield -> Bitfield | 158 | union :: Bitfield -> Bitfield -> Bitfield |
288 | union = zipWithBF (.|.) | 159 | union a b = Bitfield { |
289 | {-# INLINE union #-} | 160 | bfSize = bfSize a `max` bfSize b |
161 | , bfSet = bfSet a `S.union` bfSet b | ||
162 | } | ||
290 | 163 | ||
291 | intersection :: Bitfield -> Bitfield -> Bitfield | 164 | intersection :: Bitfield -> Bitfield -> Bitfield |
292 | intersection = zipWithBF (.&.) | 165 | intersection a b = Bitfield { |
293 | {-# INLINE intersection #-} | 166 | bfSize = bfSize a `min` bfSize b |
167 | , bfSet = bfSet a `S.intersection` bfSet b | ||
168 | } | ||
294 | 169 | ||
295 | difference :: Bitfield -> Bitfield -> Bitfield | 170 | difference :: Bitfield -> Bitfield -> Bitfield |
296 | difference = zipWithBF diffWord8 | 171 | difference a b = Bitfield { |
297 | where | 172 | bfSize = bfSize a -- FIXME is it more reasonable? |
298 | diffWord8 :: Bits a => a -> a -> a | 173 | , bfSet = bfSet a `S.difference` bfSet b |
299 | diffWord8 a b = a .&. (a `xor` b) | 174 | } |
300 | {-# INLINE diffWord8 #-} | ||
301 | {-# INLINE difference #-} | ||
302 | 175 | ||
303 | combine :: [Bitfield] -> Maybe Bitfield | 176 | unions :: [Bitfield] -> Bitfield |
304 | combine [] = Nothing | 177 | unions = foldl' union (empty 0) |
305 | combine as = return $ foldr1 intersection as | ||
306 | 178 | ||
307 | haveCount :: Bitfield -> Int | 179 | {----------------------------------------------------------------------- |
308 | haveCount (MkBitfield b) = foldBS f f 0 b | 180 | Serialization |
309 | where | 181 | -----------------------------------------------------------------------} |
310 | f byte count = popCount byte + count | ||
311 | 182 | ||
312 | completeness :: Bitfield -> (Int, Int) | 183 | getBitfield :: Int -> Get Bitfield |
313 | completeness bf = (haveCount bf, bitfieldBitCount bf) | 184 | getBitfield = error "getBitfield" |
314 | 185 | ||
315 | -- | Get min index of piece that the peer have. | 186 | putBitfield :: Bitfield -> Put |
316 | findMin :: Bitfield -> Maybe Int | 187 | putBitfield = error "putBitfield" |
317 | findMin (MkBitfield b) = do | 188 | |
318 | byteIx <- findSet b | 189 | bitfieldByteCount :: Bitfield -> Int |
319 | bitIx <- findMinWord8 (B.index b byteIx) | 190 | bitfieldByteCount = error "bitfieldByteCount" |
320 | return $ byteIx * bitSize (undefined :: Word8) + bitIx | ||
321 | where | ||
322 | -- TODO: bit tricks | ||
323 | findMinWord8 :: Word8 -> Maybe Int | ||
324 | findMinWord8 byte = L.find (testBit byte) [0..bitSize (undefined :: Word8) - 1] | ||
325 | {-# INLINE findMinWord8 #-} | ||
326 | {-# INLINE findMin #-} | ||
327 | |||
328 | |||
329 | findMax :: Bitfield -> Maybe Int | ||
330 | findMax (MkBitfield b) = do | ||
331 | -- TODO avoid reverse | ||
332 | byteIx <- (pred (B.length b) -) <$> findSet (B.reverse b) | ||
333 | bitIx <- findMaxWord8 (B.index b byteIx) | ||
334 | return $ byteIx * bitSize (undefined :: Word8) + bitIx | ||
335 | where | ||
336 | -- TODO: bit tricks | ||
337 | findMaxWord8 :: Word8 -> Maybe Int | ||
338 | findMaxWord8 byte = L.find (testBit byte) | ||
339 | (reverse [0 :: Int .. | ||
340 | bitSize (undefined :: Word8) - 1]) | ||
341 | 191 | ||
342 | {-# INLINE findMax #-} | 192 | {----------------------------------------------------------------------- |
193 | Debug | ||
194 | -----------------------------------------------------------------------} | ||
343 | 195 | ||
344 | frequencies :: [Bitfield] -> [Int] | 196 | mkBitfield :: PieceCount -> [PieceIx] -> Bitfield |
345 | frequencies xs = foldr1 (zipWith (+)) $ map (map fromEnum . toList) xs | 197 | mkBitfield s ixs = Bitfield { |
198 | bfSize = s | ||
199 | , bfSet = S.splitLT s $ S.fromList ixs | ||
200 | } \ No newline at end of file | ||
diff --git a/src/Data/Bitfield/Mutable.hs b/src/Data/Bitfield/Mutable.hs deleted file mode 100644 index a2f736e9..00000000 --- a/src/Data/Bitfield/Mutable.hs +++ /dev/null | |||
@@ -1,177 +0,0 @@ | |||
1 | -- TODO: update documentation | ||
2 | -- | | ||
3 | -- Copyright : (c) Sam T. 2013 | ||
4 | -- License : MIT | ||
5 | -- Maintainer : pxqr.sta@gmail.com | ||
6 | -- Stability : experimental | ||
7 | -- Portability : portable | ||
8 | -- | ||
9 | -- | ||
10 | -- Set of integers with atomic modification. Internally IntSet | ||
11 | -- represented as array of tightly packed bits. | ||
12 | -- | ||
13 | -- Note that: | ||
14 | -- | ||
15 | -- * Insertion, deletion are atomic, waitfree and failfree. | ||
16 | -- | ||
17 | -- * You can avoid copying in conversion if you don't care about | ||
18 | -- referencial transparency or sure that after conversion | ||
19 | -- bitfields never modified. | ||
20 | -- | ||
21 | -- | ||
22 | {-# OPTIONS -fno-warn-unused-do-bind #-} | ||
23 | module Data.Bitfield.Mutable | ||
24 | ( Bitfield | ||
25 | |||
26 | -- * Construction | ||
27 | , empty, full | ||
28 | , create, releaseIntSet | ||
29 | |||
30 | -- * Query | ||
31 | -- , lookup, member, notMember | ||
32 | -- , size | ||
33 | , maxSize | ||
34 | , lookupUnsafe | ||
35 | |||
36 | -- * Modification | ||
37 | -- , insert, delete | ||
38 | , insertUnsafe, deleteUnsafe | ||
39 | |||
40 | -- * Conversion | ||
41 | , fromByteString, toByteString | ||
42 | , fromByteStringUnsafe, toByteStringUnsafe | ||
43 | ) where | ||
44 | |||
45 | import Control.Applicative hiding (empty) | ||
46 | import Data.Bits.Atomic | ||
47 | import Data.ByteString (ByteString) | ||
48 | import qualified Data.ByteString as B | ||
49 | import qualified Data.ByteString.Internal as B | ||
50 | import Foreign | ||
51 | |||
52 | |||
53 | -- | Basically 'BitSet' is a wrapper on the 'ForeignPtr'. | ||
54 | data Bitfield = Bitfield { | ||
55 | bfBasePtr :: {-# UNPACK #-} !(ForeignPtr Word8) | ||
56 | , bfOffset :: {-# UNPACK #-} !Int | ||
57 | , bfByteSize :: {-# UNPACK #-} !Int | ||
58 | , bfMaxSize :: {-# UNPACK #-} !Int | ||
59 | } deriving Show | ||
60 | |||
61 | |||
62 | maxSize :: Bitfield -> Int | ||
63 | maxSize = bfMaxSize | ||
64 | |||
65 | |||
66 | create :: Int -> (Int -> Ptr Word8 -> IO a) -> IO Bitfield | ||
67 | create n f = do | ||
68 | let byteSize = sizeInBytes n | ||
69 | fptr <- mallocForeignPtrBytes byteSize | ||
70 | withForeignPtr fptr (f byteSize) | ||
71 | return (Bitfield fptr 0 byteSize n) | ||
72 | |||
73 | -- | Create a 'IntSet' with a given size in /bits/. | ||
74 | empty :: Int -> IO Bitfield | ||
75 | empty n = create n $ \bn ptr -> | ||
76 | B.memset ptr 0 (fromIntegral bn) | ||
77 | |||
78 | full :: Int -> IO Bitfield | ||
79 | full n = create n $ \bn ptr -> | ||
80 | B.memset ptr (error "IntSet.full") (fromIntegral bn) | ||
81 | |||
82 | |||
83 | -- | Should be used to free scarce resources immediately. | ||
84 | -- | ||
85 | -- WARNING: After this call 'BitField' should not be used. Also you | ||
86 | -- can avoid using it at all if resource is not too scarce. | ||
87 | -- | ||
88 | releaseIntSet :: Bitfield -> IO () | ||
89 | releaseIntSet = finalizeForeignPtr . bfBasePtr | ||
90 | |||
91 | -- | Set nth bit in the given BifField to 1. | ||
92 | -- | ||
93 | -- UNSAFE: no bound checking. | ||
94 | -- | ||
95 | insertUnsafe :: Int -> Bitfield -> IO () | ||
96 | insertUnsafe i s = | ||
97 | withByte s i $ \ptr -> do | ||
98 | fetchAndOr ptr (bit (bitLoc i)) | ||
99 | return () | ||
100 | {-# INLINE insertUnsafe #-} | ||
101 | |||
102 | |||
103 | deleteUnsafe :: Int -> Bitfield -> IO () | ||
104 | deleteUnsafe i s = | ||
105 | withByte s i $ \ptr -> do | ||
106 | fetchAndAnd ptr (complement (bit (bitLoc i))) | ||
107 | return () | ||
108 | {-# INLINE deleteUnsafe #-} | ||
109 | |||
110 | -- | Get nth bit in the given BitField. | ||
111 | -- | ||
112 | -- UNSAFE: no bound checking. | ||
113 | -- | ||
114 | lookupUnsafe :: Int -> Bitfield -> IO Bool | ||
115 | lookupUnsafe n s = withByte s n $ \ptr -> (`testBit` bitLoc n) <$> peek ptr | ||
116 | {-# INLINE lookupUnsafe #-} | ||
117 | |||
118 | fromByteString :: Int -> ByteString -> Bitfield | ||
119 | fromByteString n = fromByteStringUnsafe n . B.copy | ||
120 | {-# INLINE fromByteString #-} | ||
121 | |||
122 | toByteString :: Bitfield -> ByteString | ||
123 | toByteString = B.copy . toByteStringUnsafe | ||
124 | {-# INLINE toByteString #-} | ||
125 | |||
126 | -- | Convert a 'BitField' to the 'ByteString' /without/ copying, | ||
127 | -- so we can write it to a socket or a file for exsample. | ||
128 | -- | ||
129 | -- WARNING: Note that using the resulting 'ByteString' might (and | ||
130 | -- even should) BREAK REFERENCIAL TRANSPARENCY since we can change | ||
131 | -- bits using 'setBitN' after the conversion. Use this function | ||
132 | -- wisely and if and only if you understand the consequences, | ||
133 | -- otherwise the really BAD THINGS WILL HAPPEN or use safe version | ||
134 | -- instead. | ||
135 | -- | ||
136 | toByteStringUnsafe :: Bitfield -> ByteString | ||
137 | toByteStringUnsafe = B.fromForeignPtr <$> bfBasePtr <*> pure 0 <*> bfByteSize | ||
138 | |||
139 | |||
140 | -- | Convert a 'ByteString' to 'BitField' /without/ copying, so we can | ||
141 | -- read it from a file or a socket. | ||
142 | -- | ||
143 | -- WARNING: Please see 'toByteString' doc, the same apply to this function. | ||
144 | -- | ||
145 | fromByteStringUnsafe :: Int -> ByteString -> Bitfield | ||
146 | fromByteStringUnsafe n (B.PS fptr a b) = Bitfield fptr a b n | ||
147 | |||
148 | baseSize :: (Bits a, Integral a) => | ||
149 | a -- ^ Base, should be power of two. | ||
150 | -> a -- ^ Size. | ||
151 | -> a -- ^ Size in base. | ||
152 | baseSize base n = (n `div` base) + fromIntegral (fromEnum ((n .&. 0x7) > 0)) | ||
153 | {-# SPECIALIZE baseSize :: Int -> Int -> Int #-} | ||
154 | {-# SPECIALIZE baseSize :: Word64 -> Word64 -> Word64 #-} | ||
155 | |||
156 | -------------------------------- internal -------------------------------------- | ||
157 | sizeInBytes :: Int -- ^ Length in bits. | ||
158 | -> Int -- ^ Length in bytes aligned by size of word. | ||
159 | sizeInBytes = baseSize 8 | ||
160 | {-# INLINE sizeInBytes #-} | ||
161 | |||
162 | -- TODO: see if shifts and bitwise ands are faster | ||
163 | -- and make portable version if not | ||
164 | byteLoc :: Int -> Int | ||
165 | byteLoc i = i `div` 8 * sizeOf (error "byteLoc" :: Word8) | ||
166 | {-# INLINE bitLoc #-} | ||
167 | |||
168 | bitLoc :: Int -> Int | ||
169 | bitLoc i = i `mod` 8 * sizeOf (error "bitLoc" :: Word8) | ||
170 | {-# INLINE byteLoc #-} | ||
171 | |||
172 | withByte :: Bitfield -> Int -> (Ptr Word8 -> IO a) -> IO a | ||
173 | withByte s n action = do | ||
174 | let offset = bfOffset s + byteLoc n | ||
175 | withForeignPtr (bfBasePtr s) $ \ptr -> | ||
176 | action (ptr `advancePtr` offset) | ||
177 | {-# INLINE withByte #-} \ No newline at end of file | ||