1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
|
module AccessOps (byteArrayAccessOps, addrAccessOps) where
import Syntax
data ElementType = MkElementType
{ elt_name :: String
, elt_rep_ty :: Ty
, elt_desc :: String
, elt_width :: Maybe Int
}
machWord :: Maybe Int
machWord = Nothing
strToTy :: String -> Ty
strToTy s = TyApp (TyCon s) []
elementTypes :: [ElementType]
elementTypes =
[ MkElementType "Char" (strToTy "Char#" ) "an 8-bit character" (Just 1)
, MkElementType "WideChar" (strToTy "Char#" ) "a 32-bit character" (Just 4)
, MkElementType "Int" (strToTy "Int#" ) "a word-sized integer" machWord
, MkElementType "Word" (strToTy "Word#" ) "a word-sized unsigned integer" machWord
, MkElementType "Addr" (strToTy "Addr#" ) "a machine address" machWord
, MkElementType "Float" (strToTy "Float#" ) "a single-precision floating-point value" (Just 4)
, MkElementType "Double" (strToTy "Double#") "a double-precision floating-point value" (Just 8)
, MkElementType "StablePtr" (TyApp (TyCon "StablePtr#") [TyVar "a"])
"a 'StablePtr#' value" machWord
] ++ do
n <- [8, 16, 32, 64]
let mkDesc suff = (if n == 8 then "an " else "a ") ++ shows n suff
[ MkElementType
{ elt_name = "Int" ++ show n
, elt_rep_ty = strToTy $ "Int" ++ shows n "#"
, elt_desc = mkDesc "-bit signed integer"
, elt_width = Just (n `quot` 8)
},
MkElementType
{ elt_name = "Word" ++ show n
, elt_rep_ty = strToTy $ "Word" ++ shows n "#"
, elt_desc = mkDesc "-bit unsigned integer"
, elt_width = Just (n `quot` 8)
}
]
unalignedElementTypes :: [ElementType]
unalignedElementTypes
= filter (\e -> elt_name e `notElem` ["Int8", "Word8"]) elementTypes
--unalignedElementTypes = filter (\e -> elt_width e /= Just 1) elementTypes
prettyOffset :: ElementType -> String
prettyOffset e = case elt_width e of
Nothing -> "machine words"
Just 1 -> "bytes"
Just n -> shows n "-byte words"
getAlignWarn :: ElementType -> String
getAlignWarn e = case elt_width e of
Just 1 -> ""
_ -> "On some platforms, the access may fail\n"
++ "for an insufficiently aligned @Addr#@."
mutableByteArrayS :: Ty
mutableByteArrayS = TyApp (TyCon "MutableByteArray#") [TyVar "s"]
stateS :: Ty
stateS = TyApp (TyCon "State#") [TyVar "s"]
readResTy :: ElementType -> Ty
readResTy e = TyF stateS (TyUTup [stateS, elt_rep_ty e])
writeResTy :: ElementType -> Ty
writeResTy e = TyF (elt_rep_ty e) (TyF stateS stateS)
mkIndexByteArrayOp :: ElementType -> Entry
mkIndexByteArrayOp e = PrimOpSpec
{ cons = "IndexByteArrayOp_" ++ elt_name e
, name = "index" ++ elt_name e ++ "Array#"
, ty = TyF (strToTy "ByteArray#")
$ TyF (strToTy "Int#")
(elt_rep_ty e)
, cat = GenPrimOp
, desc = "Read " ++ elt_desc e ++ "; offset in " ++ prettyOffset e ++ "."
, opts = [OptionEffect CanFail]
}
mkUnalignedIndexByteArrayOp :: ElementType -> Entry
mkUnalignedIndexByteArrayOp e = PrimOpSpec
{ cons = "IndexByteArrayOp_Word8As" ++ elt_name e
, name = "indexWord8ArrayAs" ++ elt_name e ++ "#"
, ty = TyF (strToTy "ByteArray#")
$ TyF (strToTy "Int#")
(elt_rep_ty e)
, cat = GenPrimOp
, desc = "Read " ++ elt_desc e ++ "; offset in bytes."
, opts = [OptionEffect CanFail]
}
mkReadByteArrayOp :: ElementType -> Entry
mkReadByteArrayOp e = PrimOpSpec
{ cons = "ReadByteArrayOp_" ++ elt_name e
, name = "read" ++ elt_name e ++ "Array#"
, ty = TyF mutableByteArrayS
$ TyF (strToTy "Int#")
$ readResTy e
, cat = GenPrimOp
, desc = "Read " ++ elt_desc e ++ "; offset in " ++ prettyOffset e ++ "."
, opts = [OptionEffect ReadWriteEffect, OptionCanFailWarnFlag YesWarnCanFail]
}
mkUnalignedReadByteArrayOp :: ElementType -> Entry
mkUnalignedReadByteArrayOp e = PrimOpSpec
{ cons = "ReadByteArrayOp_Word8As" ++ elt_name e
, name = "readWord8ArrayAs" ++ elt_name e ++ "#"
, ty = TyF mutableByteArrayS
$ TyF (strToTy "Int#")
$ readResTy e
, cat = GenPrimOp
, desc = "Read " ++ elt_desc e ++ "; offset in bytes."
, opts = [OptionEffect ReadWriteEffect, OptionCanFailWarnFlag YesWarnCanFail]
}
mkWriteByteArrayOp :: ElementType -> Entry
mkWriteByteArrayOp e = PrimOpSpec
{ cons = "WriteByteArrayOp_" ++ elt_name e
, name = "write" ++ elt_name e ++ "Array#"
, ty = TyF mutableByteArrayS
$ TyF (strToTy "Int#")
$ writeResTy e
, cat = GenPrimOp
, desc = "Write " ++ elt_desc e ++ "; offset in " ++ prettyOffset e ++ "."
, opts = [OptionEffect ReadWriteEffect, OptionCanFailWarnFlag YesWarnCanFail]
}
mkUnalignedWriteByteArrayOp :: ElementType -> Entry
mkUnalignedWriteByteArrayOp e = PrimOpSpec
{ cons = "WriteByteArrayOp_Word8As" ++ elt_name e
, name = "writeWord8ArrayAs" ++ elt_name e ++ "#"
, ty = TyF mutableByteArrayS
$ TyF (strToTy "Int#")
$ writeResTy e
, cat = GenPrimOp
, desc = "Write " ++ elt_desc e ++ "; offset in bytes."
, opts = [OptionEffect ReadWriteEffect, OptionCanFailWarnFlag YesWarnCanFail]
}
byteArrayAccessOps :: [Entry]
byteArrayAccessOps
= map mkIndexByteArrayOp elementTypes
++ map mkUnalignedIndexByteArrayOp unalignedElementTypes
++ map mkReadByteArrayOp elementTypes
++ map mkUnalignedReadByteArrayOp unalignedElementTypes
++ map mkWriteByteArrayOp elementTypes
++ map mkUnalignedWriteByteArrayOp unalignedElementTypes
mkIndexOffAddrOp :: ElementType -> Entry
mkIndexOffAddrOp e = PrimOpSpec
{ cons = "IndexOffAddrOp_" ++ elt_name e
, name = "index" ++ elt_name e ++ "OffAddr#"
, ty = TyF (strToTy "Addr#")
$ TyF (strToTy "Int#")
(elt_rep_ty e)
, cat = GenPrimOp
, desc = "Read " ++ elt_desc e ++ "; offset in " ++ prettyOffset e ++ ".\n\n"
++ getAlignWarn e
, opts = [OptionEffect CanFail]
}
mkUnalignedIndexOffAddrOp :: ElementType -> Entry
mkUnalignedIndexOffAddrOp e = PrimOpSpec
{ cons = "IndexOffAddrOp_Word8As" ++ elt_name e
, name = "indexWord8OffAddrAs" ++ elt_name e ++ "#"
, ty = TyF (strToTy "Addr#")
$ TyF (strToTy "Int#")
(elt_rep_ty e)
, cat = GenPrimOp
, desc = "Read " ++ elt_desc e ++ "; offset in bytes."
, opts = [OptionEffect CanFail]
}
mkReadOffAddrOp :: ElementType -> Entry
mkReadOffAddrOp e = PrimOpSpec
{ cons = "ReadOffAddrOp_" ++ elt_name e
, name = "read" ++ elt_name e ++ "OffAddr#"
, ty = TyF (strToTy "Addr#")
$ TyF (strToTy "Int#")
$ readResTy e
, cat = GenPrimOp
, desc = "Read " ++ elt_desc e ++ "; offset in " ++ prettyOffset e ++ ".\n\n"
++ getAlignWarn e
, opts = [OptionEffect ReadWriteEffect, OptionCanFailWarnFlag YesWarnCanFail]
}
mkUnalignedReadOffAddrOp :: ElementType -> Entry
mkUnalignedReadOffAddrOp e = PrimOpSpec
{ cons = "ReadOffAddrOp_Word8As" ++ elt_name e
, name = "readWord8OffAddrAs" ++ elt_name e ++ "#"
, ty = TyF (strToTy "Addr#")
$ TyF (strToTy "Int#")
$ readResTy e
, cat = GenPrimOp
, desc = "Read " ++ elt_desc e ++ "; offset in bytes."
, opts = [OptionEffect ReadWriteEffect, OptionCanFailWarnFlag YesWarnCanFail]
}
mkWriteOffAddrOp :: ElementType -> Entry
mkWriteOffAddrOp e = PrimOpSpec
{ cons = "WriteOffAddrOp_" ++ elt_name e
, name = "write" ++ elt_name e ++ "OffAddr#"
, ty = TyF (strToTy "Addr#")
$ TyF (strToTy "Int#")
$ writeResTy e
, cat = GenPrimOp
, desc = "Write " ++ elt_desc e ++ "; offset in " ++ prettyOffset e ++ ".\n\n"
++ getAlignWarn e
, opts = [OptionEffect ReadWriteEffect, OptionCanFailWarnFlag YesWarnCanFail]
}
mkUnalignedWriteOffAddrOp :: ElementType -> Entry
mkUnalignedWriteOffAddrOp e = PrimOpSpec
{ cons = "WriteOffAddrOp_Word8As" ++ elt_name e
, name = "writeWord8OffAddrAs" ++ elt_name e ++ "#"
, ty = TyF (strToTy "Addr#")
$ TyF (strToTy "Int#")
$ writeResTy e
, cat = GenPrimOp
, desc = "Write " ++ elt_desc e ++ "; offset in bytes."
, opts = [OptionEffect ReadWriteEffect, OptionCanFailWarnFlag YesWarnCanFail]
}
addrAccessOps :: [Entry]
addrAccessOps
= map mkIndexOffAddrOp elementTypes
++ map mkUnalignedIndexOffAddrOp unalignedElementTypes
++ map mkReadOffAddrOp elementTypes
++ map mkUnalignedReadOffAddrOp unalignedElementTypes
++ map mkWriteOffAddrOp elementTypes
++ map mkUnalignedWriteOffAddrOp unalignedElementTypes
|