858e615..master · binary-bits

git.iko.soy/binary-bits

9 files changed+295−32

unifiedsplit

.gitignore+1 Data/Binary/Bits/BitOrder.hs+2−2 Data/Binary/Bits/Get.hs+33−11 Data/Binary/Bits/Internal.hs+27−6 Data/Binary/Bits/Put.hs+71−13 flake.lock+59 flake.nix+24 stack.yaml+66 stack.yaml.lock+12

.gitignore+1

@@ -1,3 +1,4 @@

11.cabal-sandbox

22cabal.sandbox.config

33dist/

4+.stack-work

Data/Binary/Bits/BitOrder.hs+2−2

@@ -19,9 +19,9 @@ where

1919--

2020-- E.g. two words of 5 bits: ABCDE, VWXYZ

2121-- - BB: ABCDEVWX YZxxxxxx

22−-- - LB: XYZABCDE xxxxxxVW

22+-- - LL: XYZABCDE xxxxxxVW

2323-- - BL: EDCBAZYX WVxxxxxx

24−-- - LL: XWVEDCBA xxxxxxZY

24+-- - LB: XWVEDCBA xxxxxxZY

2525data BitOrder

2626 = BB -- ^ Big-endian bytes and bits

2727 | LB -- ^ Little-endian bytes, big-endian bits

Data/Binary/Bits/Get.hs+33−11

@@ -60,6 +60,7 @@ module Data.Binary.Bits.Get

6060

6161 -- ** Get bytes

6262 , getBool

63+ , getBool#

6364 , getWord8

6465 , getWord16

6566 , getWord32

@@ -114,6 +115,8 @@ import Control.Applicative

114115import Control.Monad (when,foldM_)

115116

116117import Prelude as P

118+import GHC.Word

119+import GHC.Base (uncheckedShiftLWord8#, wordToWord8#, Int (..), andWord8#, Word8#, (-#), Int#, xorI#, eqWord8#, TYPE)

117120

118121-- $bitget

119122-- Parse bits using a monad.

@@ -179,8 +182,20 @@ readBool :: S -> Bool

179182readBool (S bs o bo) = case bo of

180183 BB -> testBit (unsafeHead bs) (7-o)

181184 BL -> testBit (unsafeHead bs) (7-o)

182− LB -> testBit (unsafeHead bs) o

183185 LL -> testBit (unsafeHead bs) o

186+ LB -> testBit (unsafeHead bs) o

187+

188+-- | Read a single bit

189+readBool# :: S -> Int

190+readBool# (S bs (I# o) bo) = case bo of

191+ BB -> testBit# (7# -# o)

192+ BL -> testBit# (7# -# o)

193+ LL -> testBit# o

194+ LB -> testBit# o

195+ where

196+ !(W8# w) = unsafeHead bs

197+ testBit# n = I# (((w `andWord8#` (wordToWord8# 1## `uncheckedShiftLWord8#` n)) `eqWord8#` wordToWord8# 0##) `xorI#` 1#)

198+

184199

185200-- | Extract a range of bits from (ws :: ByteString)

186201--

@@ -203,17 +218,17 @@ extract bo bs o n

203218

204219 -- shift offset depending on the byte position (0..B.length-1)

205220 off i = case bo of

206− LB -> 8*i - o

207221 LL -> 8*i - o

222+ LB -> 8*i - o

208223 BB -> (B.length bs -1 - i) * 8 - r

209224 BL -> (B.length bs -1 - i) * 8 - r

210225

211226 -- reverse bits if necessary

212227 rev = case bo of

213− LL -> reverseBits n

228+ LB -> reverseBits n

214229 BL -> reverseBits n

215230 BB -> id

216− LB -> id

231+ LL -> id

217232

218233

219234-- | Generic readWord

@@ -234,9 +249,9 @@ readWordChecked m n s

234249--

235250-- Examples:

236251-- BB: xxxABCDE FGHIJKLM NOPxxxxx -> ABCDEFGH IJKLMNOP

237−-- LB: LMNOPxxx DEFGHIJK xxxxxABC -> ABCDEFGH IJKLMNOP

252+-- LL: LMNOPxxx DEFGHIJK xxxxxABC -> ABCDEFGH IJKLMNOP

238253-- BL: xxxPONML KJIHGFED CBAxxxxx -> ABCDEFGH IJKLMNOP

239−-- LL: EDCBAxxx MLKJIHGF xxxxxPON -> ABCDEFGH IJKLMNOP

254+-- LB: EDCBAxxx MLKJIHGF xxxxxPON -> ABCDEFGH IJKLMNOP

240255readByteString :: Int -> S -> ByteString

241256readByteString n (S bs o bo) =

242257 let

@@ -245,12 +260,12 @@ readByteString n (S bs o bo) =

245260 rev = B.map (reverseBits 8)

246261 in case (o,bo) of

247262 (0,BB) -> bs''

248− (0,LB) -> B.reverse bs''

249− (0,LL) -> rev bs''

263+ (0,LL) -> B.reverse bs''

264+ (0,LB) -> rev bs''

250265 (0,BL) -> rev . B.reverse $ bs''

251− (_,LB) -> readByteString n (S (B.reverse bs') (8-o) BB)

266+ (_,LL) -> readByteString n (S (B.reverse bs') (8-o) BB)

252267 (_,BL) -> rev . B.reverse $ readByteString n (S bs' o BB)

253− (_,LL) -> rev . B.reverse $ readByteString n (S bs' o LB)

268+ (_,LB) -> rev . B.reverse $ readByteString n (S bs' o LL)

254269 (_,BB) -> unsafePerformIO $ do

255270 let len = n+1

256271 ptr <- mallocBytes len

@@ -272,7 +287,6 @@ newtype BitGet a = B { runState :: S -> Get (S,a) }

272287

273288instance Monad BitGet where

274289 return x = B $ \s -> return (s,x)

275− fail str = B $ \s -> putBackState s >> fail str

276290 (B f) >>= g = B $ \s -> do (s',a) <- f s

277291 runState (g a) s'

278292

@@ -364,6 +378,10 @@ isEmpty = B $ \ (S bs o bo) -> if B.null bs

364378getBool :: BitGet Bool

365379getBool = block bool

366380

381+-- | Get 1 bit as a 'Bool'.

382+getBool# :: BitGet Int

383+getBool# = block bool#

384+

367385-- | Get @n@ bits as a 'Word8'. @n@ must be within @[0..8]@.

368386getWord8 :: Int -> BitGet Word8

369387getWord8 n = block (word8 n)

@@ -439,6 +457,10 @@ block (Block i p) = do

439457bool :: Block Bool

440458bool = Block 1 readBool

441459

460+-- | Read a 1 bit 'Bool'.

461+bool# :: Block Int

462+bool# = Block 1 readBool#

463+

442464-- | Read @n@ bits as a 'Word8'. @n@ must be within @[0..8]@.

443465word8 :: Int -> Block Word8

444466word8 n = Block n (readWordChecked 8 n)

Data/Binary/Bits/Internal.hs+27−6

@@ -12,10 +12,13 @@

1212

1313module Data.Binary.Bits.Internal

1414 ( make_mask

15+ , make_mask#

1516 , mask

17+ , mask#

1618 , bit_offset

1719 , byte_offset

1820 , reverseBits

21+ , reverseBits#

1922 , FastBits(..)

2023 )

2124where

@@ -38,11 +41,18 @@ make_mask n = (1 `shiftL` fromIntegral n) - 1

3841{-# SPECIALIZE make_mask :: Int -> Word32 #-}

3942{-# SPECIALIZE make_mask :: Int -> Word64 #-}

4043

44+make_mask# :: Int# -> Word#

45+make_mask# n = (1## `shiftL#` n) `minusWord#` 1##

46+

4147-- | Keep only the n least-significant bits of the given value

4248mask :: (Bits a, Num a) => Int -> a -> a

4349mask n v = v .&. make_mask n

4450{-# INLINE mask #-}

4551

52+-- | Keep only the n least-significant bits of the given value

53+mask# :: Int# -> Word# -> Word#

54+mask# n v = v `and#` make_mask# n

55+

4656-- | Compute bit offset (equivalent to x `mod` 8 but faster)

4757bit_offset :: Int -> Int

4858bit_offset n = make_mask 3 .&. n

@@ -65,6 +75,17 @@ reverseBits n value = rec value n 0

6575 rec 0 i r = r `fastShiftL` i

6676 rec v i r = rec (v `fastShiftR` 1) (i-1) ((r `fastShiftL` 1) .|. (v .&. 0x1))

6777

78+reverseBits# :: Int# -> Word# -> Word#

79+reverseBits# n value = rec value n 0##

80+ where

81+ -- rec v i r, where

82+ -- v is orginal value shifted

83+ -- i is the remaining number of bits

84+ -- r is current value

85+ rec 0## 0# r = r

86+ rec 0## i r = r `shiftL#` i

87+ rec v i r = rec (v `shiftRL#` 1#) (i -# 1#) ((r `shiftL#` 1#) `or#` (v `and#` 0x1##))

88+

6889

6990---------------------------------------------------------------------

7091-- Unchecked shifts, from the "binary" package

@@ -116,13 +137,13 @@ shiftr_w32 :: Word32 -> Int -> Word32

116137shiftr_w64 :: Word64 -> Int -> Word64

117138

118139#if defined(__GLASGOW_HASKELL__) && !defined(__HADDOCK__)

119−shiftl_w8 (W8# w) (I# i) = W8# (w `uncheckedShiftL#` i)

120−shiftl_w16 (W16# w) (I# i) = W16# (w `uncheckedShiftL#` i)

121−shiftl_w32 (W32# w) (I# i) = W32# (w `uncheckedShiftL#` i)

140+shiftl_w8 w i = w `unsafeShiftL` i

141+shiftl_w16 w i = w `unsafeShiftL` i

142+shiftl_w32 w i = w `unsafeShiftL` i

122143

123−shiftr_w8 (W8# w) (I# i) = W8# (w `uncheckedShiftRL#` i)

124−shiftr_w16 (W16# w) (I# i) = W16# (w `uncheckedShiftRL#` i)

125−shiftr_w32 (W32# w) (I# i) = W32# (w `uncheckedShiftRL#` i)

144+shiftr_w8 w i = w `unsafeShiftR` i

145+shiftr_w16 w i = w `unsafeShiftR` i

146+shiftr_w32 w i = w `unsafeShiftR` i

126147

127148

128149#if WORD_SIZE_IN_BITS < 64

Data/Binary/Bits/Put.hs+71−13

@@ -1,3 +1,5 @@

1+{-# LANGUAGE MagicHash #-}

13-----------------------------------------------------------------------------

24-- |

35-- Module : Data.Binary.Bits.Put

@@ -20,8 +22,10 @@ module Data.Binary.Bits.Put

2022 -- * Data types

2123 -- ** Bool

2224 , putBool

25+ , putBool#

2326

2427 -- ** Words

28+ , putWord#

2529 , putWord8

2630 , putWord16

2731 , putWord32

@@ -46,11 +50,11 @@ import Data.Binary.Bits.Alignment

4650import Data.ByteString as BS

4751import Data.ByteString.Unsafe as BS

4852

49−import Control.Applicative

5053import Control.Monad (when)

5154import Data.Bits

52−import Data.Monoid

5355import Data.Word

56+import GHC.Base (Word#, shiftRL#, Int (..), Int#, (-#), (<#), isTrue#, (+#), shiftL#, wordToWord8#, orWord8#)

57+import GHC.Word (Word8(..))

5458

5559data BitPut a = BitPut { run :: (S -> PairS a) }

5660

@@ -62,11 +66,18 @@ data S = S !Builder !Word8 !Int !BitOrder

6266putBool :: Bool -> BitPut ()

6367putBool b = putWord8 1 (if b then 0xff else 0x00)

6468

69+-- | Put a 1 bit 'Bool'.

70+putBool# :: Word# -> BitPut ()

71+putBool# b = putWord# 1# b

72+

6573

6674-- | Generic putWord

6775putWord :: (Num a, FastBits a, Integral a) => Int -> a -> BitPut ()

6876putWord n w = BitPut $ \s -> PairS () (putWordS n w s)

6977

78+putWord# :: Int# -> Word# -> BitPut ()

79+putWord# n w = BitPut $ \s -> PairS () (putWordS# n w s)

80+

7081putWordS :: (Num a, FastBits a, Integral a) => Int -> a -> S -> S

7182putWordS n w s@(S builder b o bo) = s'

7283 where

@@ -85,8 +96,8 @@ putWordS n w s@(S builder b o bo) = s'

8596 w' = case bo of

8697 BB -> w

8798 BL -> w `fastShiftR` cn

88− LB -> w `fastShiftR` cn

89− LL -> w

99+ LL -> w `fastShiftR` cn

100+ LB -> w

90101

91102 -- Select bits to store in the current byte.

92103 -- Put them in the correct order and return them in the least-significant

@@ -94,8 +105,8 @@ putWordS n w s@(S builder b o bo) = s'

94105 selectBits :: (Num a, FastBits a, Integral a) => a -> Word8

95106 selectBits x = fromIntegral $ case bo of

96107 BB -> mask cn $ x `fastShiftR` (n-cn)

97− LL -> reverseBits cn $ mask cn $ x `fastShiftR` (n-cn)

98− LB -> mask cn x

108+ LB -> reverseBits cn $ mask cn $ x `fastShiftR` (n-cn)

109+ LL -> mask cn x

99110 BL -> reverseBits cn $ mask cn x

100111

101112 -- shift left at the correct position

@@ -103,8 +114,55 @@ putWordS n w s@(S builder b o bo) = s'

103114 shl x = case bo of

104115 BB -> x `fastShiftL` (8-o-cn)

105116 BL -> x `fastShiftL` (8-o-cn)

106− LB -> x `fastShiftL` o

107117 LL -> x `fastShiftL` o

118+ LB -> x `fastShiftL` o

119+

120+ flush s2@(S b2 w2 o2 bo2)

121+ | o2 == 8 = S (b2 `mappend` B.singleton w2) 0 0 bo2

122+ | otherwise = s2

123+

124+putWordS# :: Int# -> Word# -> S -> S

125+putWordS# n w s@(S builder (W8# b) (I# o) bo) = s'

126+ where

127+ min# :: Int# -> Int# -> Int#

128+ min# x y | isTrue# (x <# y) = x

129+ min# _ y = y

130+

131+ -- number of bits that will be stored in the current byte

132+ cn = min# (8# -# o) n

133+

134+ -- new state

135+ s' = case n of

136+ 0# -> s

137+ _ -> putWordS# (n -# cn) w' (flush (S builder (W8# b') (I# (o +# cn)) bo))

138+

139+ -- new current byte

140+ b' = wordToWord8# (shl (selectBits w)) `orWord8#` b

141+

142+ -- Word containing the remaining (n-cn) bits to store in its LSB

143+ w' = case bo of

144+ BB -> w

145+ BL -> w `shiftRL#` cn

146+ LL -> w `shiftRL#` cn

147+ LB -> w

148+

149+ -- Select bits to store in the current byte.

150+ -- Put them in the correct order and return them in the least-significant

151+ -- bits of the returned value

152+ selectBits :: Word# -> Word#

153+ selectBits x = case bo of

154+ BB -> mask# cn (x `shiftRL#` (n -# cn))

155+ LB -> reverseBits# cn (mask# cn (x `shiftRL#` (n -# cn)))

156+ LL -> mask# cn x

157+ BL -> reverseBits# cn (mask# cn x)

158+

159+ -- shift left at the correct position

160+ shl :: Word# -> Word#

161+ shl x = case bo of

162+ BB -> x `shiftL#` (8# -# o -# cn)

163+ BL -> x `shiftL#` (8# -# o -# cn)

164+ LL -> x `shiftL#` o

165+ LB -> x `shiftL#` o

108166

109167 flush s2@(S b2 w2 o2 bo2)

110168 | o2 == 8 = S (b2 `mappend` B.singleton w2) 0 0 bo2

@@ -143,9 +201,9 @@ putWord64be = putWord

143201--

144202-- Examples: 3 bits are already written in the current byte

145203-- BB: ABCDEFGH IJKLMNOP -> xxxABCDE FGHIJKLM NOPxxxxx

146−-- LB: ABCDEFGH IJKLMNOP -> LMNOPxxx DEFGHIJK xxxxxABC

204+-- LL: ABCDEFGH IJKLMNOP -> LMNOPxxx DEFGHIJK xxxxxABC

147205-- BL: ABCDEFGH IJKLMNOP -> xxxPONML KJIHGFED CBAxxxxx

148−-- LL: ABCDEFGH IJKLMNOP -> EDCBAxxx MLKJIHGF xxxxxPON

206+-- LB: ABCDEFGH IJKLMNOP -> EDCBAxxx MLKJIHGF xxxxxPON

149207putByteString :: ByteString -> BitPut ()

150208putByteString bs = BitPut $ \s -> PairS () (putByteStringS bs s)

151209

@@ -154,13 +212,13 @@ putByteStringS bs s

154212 | BS.null bs = s

155213 | otherwise = case s of

156214 (S builder b 0 BB) -> S (builder `mappend` B.fromByteString bs) b 0 BB

157− (S builder b 0 LB) -> S (builder `mappend` B.fromByteString (BS.reverse bs)) b 0 LB

158− (S builder b 0 LL) -> S (builder `mappend` B.fromByteString (rev bs)) b 0 LL

215+ (S builder b 0 LL) -> S (builder `mappend` B.fromByteString (BS.reverse bs)) b 0 LL

216+ (S builder b 0 LB) -> S (builder `mappend` B.fromByteString (rev bs)) b 0 LB

159217 (S builder b 0 BL) -> S (builder `mappend` B.fromByteString (rev (BS.reverse bs))) b 0 BL

160218 (S _ _ _ BB) -> putByteStringS (BS.unsafeTail bs) (putWordS 8 (BS.unsafeHead bs) s)

161− (S _ _ _ LB) -> putByteStringS (BS.unsafeInit bs) (putWordS 8 (BS.unsafeLast bs) s)

219+ (S _ _ _ LL) -> putByteStringS (BS.unsafeInit bs) (putWordS 8 (BS.unsafeLast bs) s)

162220 (S _ _ _ BL) -> putByteStringS (BS.unsafeInit bs) (putWordS 8 (BS.unsafeLast bs) s)

163− (S _ _ _ LL) -> putByteStringS (BS.unsafeTail bs) (putWordS 8 (BS.unsafeHead bs) s)

221+ (S _ _ _ LB) -> putByteStringS (BS.unsafeTail bs) (putWordS 8 (BS.unsafeHead bs) s)

164222 where

165223 rev = BS.map (reverseBits 8)

166224

flake.locknew file+59

@@ -0,0 +1,59 @@

1+{

2+ "nodes": {

3+ "flake-utils": {

4+ "inputs": {

5+ "systems": "systems"

6+ },

7+ "locked": {

8+ "lastModified": 1731533236,

9+ "narHash": "sha256-l0KFg5HjrsfsO/JpG+r7fRrqm12kzFHyUHqHCVpMMbI=",

10+ "owner": "numtide",

11+ "repo": "flake-utils",

12+ "rev": "11707dc2f618dd54ca8739b309ec4fc024de578b",

13+ "type": "github"

14+ },

15+ "original": {

16+ "id": "flake-utils",

17+ "type": "indirect"

18+ }

19+ },

20+ "nixpkgs": {

21+ "locked": {

22+ "lastModified": 1737469691,

23+ "narHash": "sha256-nmKOgAU48S41dTPIXAq0AHZSehWUn6ZPrUKijHAMmIk=",

24+ "owner": "NixOS",

25+ "repo": "nixpkgs",

26+ "rev": "9e4d5190a9482a1fb9d18adf0bdb83c6e506eaab",

27+ "type": "github"

28+ },

29+ "original": {

30+ "id": "nixpkgs",

31+ "ref": "nixos-unstable",

32+ "type": "indirect"

33+ }

34+ },

35+ "root": {

36+ "inputs": {

37+ "flake-utils": "flake-utils",

38+ "nixpkgs": "nixpkgs"

39+ }

40+ },

41+ "systems": {

42+ "locked": {

43+ "lastModified": 1681028828,

44+ "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",

45+ "owner": "nix-systems",

46+ "repo": "default",

47+ "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",

48+ "type": "github"

49+ },

50+ "original": {

51+ "owner": "nix-systems",

52+ "repo": "default",

53+ "type": "github"

54+ }

55+ }

56+ },

57+ "root": "root",

58+ "version": 7

59+}

flake.nixnew file+24

@@ -0,0 +1,24 @@

1+{

2+ inputs = {

3+ nixpkgs.url = "nixpkgs/nixos-unstable";

4+ flake-utils.url = "flake-utils";

5+ };

7+ outputs = { self, flake-utils, nixpkgs }:

8+ let

9+ supportedSystems =

10+ [ "x86_64-linux" "x86_64-darwin" "aarch64-darwin" "aarch64-linux" ];

11+ compilerVersion = "966";

12+ in flake-utils.lib.eachSystem supportedSystems (system:

13+ let pkgs = import nixpkgs { inherit system; };

14+ in {

15+ devShells.default = pkgs.mkShell {

16+ buildInputs = with pkgs; [

17+ haskell.compiler."ghc${compilerVersion}"

18+ (pkgs.haskell-language-server.override {

19+ supportedGhcVersions = [ compilerVersion ];

20+ })

21+ ];

22+ };

23+ });

24+}

stack.yamlnew file+66

@@ -0,0 +1,66 @@

1+# This file was automatically generated by 'stack init'

2+#

3+# Some commonly used options have been documented as comments in this file.

4+# For advanced use and comprehensive documentation of the format, please see:

5+# https://docs.haskellstack.org/en/stable/yaml_configuration/

7+# Resolver to choose a 'specific' stackage snapshot or a compiler version.

8+# A snapshot resolver dictates the compiler version and the set of packages

9+# to be used for project dependencies. For example:

10+#

11+# resolver: lts-3.5

12+# resolver: nightly-2015-09-21

13+# resolver: ghc-7.10.2

14+#

15+# The location of a snapshot can be provided as a file or url. Stack assumes

16+# a snapshot provided as a file might change, whereas a url resource does not.

17+#

18+# resolver: ./custom-snapshot.yaml

19+# resolver: https://example.com/snapshots/2018-01-01.yaml

20+resolver: lts-22.43

21+

22+# User packages to be built.

23+# Various formats can be used as shown in the example below.

24+#

25+# packages:

26+# - some-directory

27+# - https://example.com/foo/bar/baz-0.0.2.tar.gz

28+# subdirs:

29+# - auto-update

30+# - wai

31+packages:

32+- .

33+# Dependency packages to be pulled from upstream that are not in the resolver.

34+# These entries can reference officially published versions as well as

35+# forks / in-progress versions pinned to a git hash. For example:

36+#

37+# extra-deps:

38+# - acme-missiles-0.3

39+# - git: https://github.com/commercialhaskell/stack.git

40+# commit: e7b331f14bcffb8367cd58fbfc8b40ec7642100a

41+#

42+# extra-deps: []

43+

44+# Override default flag values for local packages and extra-deps

45+# flags: {}

46+

47+# Extra package databases containing global packages

48+# extra-package-dbs: []

49+

50+# Control whether we use the GHC we find on the path

51+# system-ghc: true

52+#

53+# Require a specific version of stack, using version ranges

54+# require-stack-version: -any # Default

55+# require-stack-version: ">=2.9"

56+#

57+# Override the architecture used by stack, especially useful on Windows

58+# arch: i386

59+# arch: x86_64

60+#

61+# Extra directories used by stack for building

62+# extra-include-dirs: [/path/to/dir]

63+# extra-lib-dirs: [/path/to/dir]

64+#

65+# Allow a newer minor version of GHC than the snapshot specifies

66+# compiler-check: newer-minor

stack.yaml.locknew file+12

@@ -0,0 +1,12 @@

1+# This file was autogenerated by Stack.

2+# You should not edit this file by hand.

3+# For more information, please see the documentation at:

4+# https://docs.haskellstack.org/en/stable/lock_files

6+packages: []

7+snapshots:

8+- completed:

9+ sha256: 08bd13ce621b41a8f5e51456b38d5b46d7783ce114a50ab604d6bbab0d002146

10+ size: 720271

11+ url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/22/43.yaml

12+ original: lts-22.43