Comments only
[ghc.git] / compiler / basicTypes / Unique.lhs
1 %
2 % (c) The University of Glasgow 2006
3 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
4 %
5
6 @Uniques@ are used to distinguish entities in the compiler (@Ids@,
7 @Classes@, etc.) from each other.  Thus, @Uniques@ are the basic
8 comparison key in the compiler.
9
10 If there is any single operation that needs to be fast, it is @Unique@
11 comparison.  Unsurprisingly, there is quite a bit of huff-and-puff
12 directed to that end.
13
14 Some of the other hair in this code is to be able to use a
15 ``splittable @UniqueSupply@'' if requested/possible (not standard
16 Haskell).
17
18 \begin{code}
19 {-# LANGUAGE BangPatterns #-}
20
21 module Unique (
22         -- * Main data types
23         Unique, Uniquable(..),
24
25         -- ** Constructors, desctructors and operations on 'Unique's
26         hasKey,
27
28         pprUnique,
29
30         mkUniqueGrimily,                -- Used in UniqSupply only!
31         getKey, getKeyFastInt,          -- Used in Var, UniqFM, Name only!
32         mkUnique, unpkUnique,           -- Used in BinIface only
33
34         incrUnique,                     -- Used for renumbering
35         deriveUnique,                   -- Ditto
36         newTagUnique,                   -- Used in CgCase
37         initTyVarUnique,
38
39         -- ** Making built-in uniques
40
41         -- now all the built-in Uniques (and functions to make them)
42         -- [the Oh-So-Wonderful Haskell module system wins again...]
43         mkAlphaTyVarUnique,
44         mkPrimOpIdUnique,
45         mkTupleTyConUnique, mkTupleDataConUnique,
46         mkPreludeMiscIdUnique, mkPreludeDataConUnique,
47         mkPreludeTyConUnique, mkPreludeClassUnique,
48         mkPArrDataConUnique,
49
50     mkVarOccUnique, mkDataOccUnique, mkTvOccUnique, mkTcOccUnique,
51         mkRegSingleUnique, mkRegPairUnique, mkRegClassUnique, mkRegSubUnique,
52         mkCostCentreUnique,
53
54         mkBuiltinUnique,
55         mkPseudoUniqueD,
56         mkPseudoUniqueE,
57         mkPseudoUniqueH
58     ) where
59
60 #include "HsVersions.h"
61
62 import BasicTypes
63 import FastTypes
64 import FastString
65 import Outputable
66 -- import StaticFlags
67 import Util
68
69 #if defined(__GLASGOW_HASKELL__)
70 --just for implementing a fast [0,61) -> Char function
71 import GHC.Exts (indexCharOffAddr#, Char(..))
72 #else
73 import Data.Array
74 #endif
75 import Data.Char        ( chr, ord )
76 \end{code}
77
78 %************************************************************************
79 %*                                                                      *
80 \subsection[Unique-type]{@Unique@ type and operations}
81 %*                                                                      *
82 %************************************************************************
83
84 The @Chars@ are ``tag letters'' that identify the @UniqueSupply@.
85 Fast comparison is everything on @Uniques@:
86
87 \begin{code}
88 --why not newtype Int?
89
90 -- | The type of unique identifiers that are used in many places in GHC
91 -- for fast ordering and equality tests. You should generate these with
92 -- the functions from the 'UniqSupply' module
93 data Unique = MkUnique FastInt
94 \end{code}
95
96 Now come the functions which construct uniques from their pieces, and vice versa.
97 The stuff about unique *supplies* is handled further down this module.
98
99 \begin{code}
100 unpkUnique      :: Unique -> (Char, Int)        -- The reverse
101
102 mkUniqueGrimily :: Int -> Unique                -- A trap-door for UniqSupply
103 getKey          :: Unique -> Int                -- for Var
104 getKeyFastInt   :: Unique -> FastInt            -- for Var
105
106 incrUnique      :: Unique -> Unique
107 deriveUnique    :: Unique -> Int -> Unique
108 newTagUnique    :: Unique -> Char -> Unique
109 \end{code}
110
111
112 \begin{code}
113 mkUniqueGrimily x = MkUnique (iUnbox x)
114
115 {-# INLINE getKey #-}
116 getKey (MkUnique x) = iBox x
117 {-# INLINE getKeyFastInt #-}
118 getKeyFastInt (MkUnique x) = x
119
120 incrUnique (MkUnique i) = MkUnique (i +# _ILIT(1))
121
122 -- deriveUnique uses an 'X' tag so that it won't clash with
123 -- any of the uniques produced any other way
124 deriveUnique (MkUnique i) delta = mkUnique 'X' (iBox i + delta)
125
126 -- newTagUnique changes the "domain" of a unique to a different char
127 newTagUnique u c = mkUnique c i where (_,i) = unpkUnique u
128
129 -- pop the Char in the top 8 bits of the Unique(Supply)
130
131 -- No 64-bit bugs here, as long as we have at least 32 bits. --JSM
132
133 -- and as long as the Char fits in 8 bits, which we assume anyway!
134
135 mkUnique :: Char -> Int -> Unique       -- Builds a unique from pieces
136 -- NOT EXPORTED, so that we can see all the Chars that
137 --               are used in this one module
138 mkUnique c i
139   = MkUnique (tag `bitOrFastInt` bits)
140   where
141     !tag  = fastOrd (cUnbox c) `shiftLFastInt` _ILIT(24)
142     !bits = iUnbox i `bitAndFastInt` _ILIT(16777215){-``0x00ffffff''-}
143
144 unpkUnique (MkUnique u)
145   = let
146         -- as long as the Char may have its eighth bit set, we
147         -- really do need the logical right-shift here!
148         tag = cBox (fastChr (u `shiftRLFastInt` _ILIT(24)))
149         i   = iBox (u `bitAndFastInt` _ILIT(16777215){-``0x00ffffff''-})
150     in
151     (tag, i)
152 \end{code}
153
154
155
156 %************************************************************************
157 %*                                                                      *
158 \subsection[Uniquable-class]{The @Uniquable@ class}
159 %*                                                                      *
160 %************************************************************************
161
162 \begin{code}
163 -- | Class of things that we can obtain a 'Unique' from
164 class Uniquable a where
165     getUnique :: a -> Unique
166
167 hasKey          :: Uniquable a => a -> Unique -> Bool
168 x `hasKey` k    = getUnique x == k
169
170 instance Uniquable FastString where
171  getUnique fs = mkUniqueGrimily (iBox (uniqueOfFS fs))
172
173 instance Uniquable Int where
174  getUnique i = mkUniqueGrimily i
175 \end{code}
176
177
178 %************************************************************************
179 %*                                                                      *
180 \subsection[Unique-instances]{Instance declarations for @Unique@}
181 %*                                                                      *
182 %************************************************************************
183
184 And the whole point (besides uniqueness) is fast equality.  We don't
185 use `deriving' because we want {\em precise} control of ordering
186 (equality on @Uniques@ is v common).
187
188 \begin{code}
189 eqUnique, ltUnique, leUnique :: Unique -> Unique -> Bool
190 eqUnique (MkUnique u1) (MkUnique u2) = u1 ==# u2
191 ltUnique (MkUnique u1) (MkUnique u2) = u1 <#  u2
192 leUnique (MkUnique u1) (MkUnique u2) = u1 <=# u2
193
194 cmpUnique :: Unique -> Unique -> Ordering
195 cmpUnique (MkUnique u1) (MkUnique u2)
196   = if u1 ==# u2 then EQ else if u1 <# u2 then LT else GT
197
198 instance Eq Unique where
199     a == b = eqUnique a b
200     a /= b = not (eqUnique a b)
201
202 instance Ord Unique where
203     a  < b = ltUnique a b
204     a <= b = leUnique a b
205     a  > b = not (leUnique a b)
206     a >= b = not (ltUnique a b)
207     compare a b = cmpUnique a b
208
209 -----------------
210 instance Uniquable Unique where
211     getUnique u = u
212 \end{code}
213
214 We do sometimes make strings with @Uniques@ in them:
215 \begin{code}
216 showUnique :: Unique -> String
217 showUnique uniq
218   = case unpkUnique uniq of
219       (tag, u) -> finish_show tag u (iToBase62 u)
220
221 finish_show :: Char -> Int -> String -> String
222 finish_show 't' u _pp_u | u < 26
223   = -- Special case to make v common tyvars, t1, t2, ...
224     -- come out as a, b, ... (shorter, easier to read)
225     [chr (ord 'a' + u)]
226 finish_show tag _ pp_u = tag : pp_u
227
228 pprUnique :: Unique -> SDoc
229 pprUnique u = text (showUnique u)
230
231 instance Outputable Unique where
232     ppr = pprUnique
233
234 instance Show Unique where
235     show uniq = showUnique uniq
236 \end{code}
237
238 %************************************************************************
239 %*                                                                      *
240 \subsection[Utils-base62]{Base-62 numbers}
241 %*                                                                      *
242 %************************************************************************
243
244 A character-stingy way to read/write numbers (notably Uniques).
245 The ``62-its'' are \tr{[0-9a-zA-Z]}.  We don't handle negative Ints.
246 Code stolen from Lennart.
247
248 \begin{code}
249 iToBase62 :: Int -> String
250 iToBase62 n_
251   = ASSERT(n_ >= 0) go (iUnbox n_) ""
252   where
253     go n cs | n <# _ILIT(62)
254              = case chooseChar62 n of { c -> c `seq` (c : cs) }
255              | otherwise
256              =  case (quotRem (iBox n) 62) of { (q_, r_) ->
257                 case iUnbox q_ of { q -> case iUnbox r_ of { r ->
258                 case (chooseChar62 r) of { c -> c `seq`
259                 (go q (c : cs)) }}}}
260
261     chooseChar62 :: FastInt -> Char
262     {-# INLINE chooseChar62 #-}
263 #if defined(__GLASGOW_HASKELL__)
264     --then FastInt == Int#
265     chooseChar62 n = C# (indexCharOffAddr# chars62 n)
266     !chars62 = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"#
267 #else
268     --Haskell98 arrays are portable
269     chooseChar62 n = (!) chars62 n
270     chars62 = listArray (0,61) "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
271 #endif
272 \end{code}
273
274 %************************************************************************
275 %*                                                                      *
276 \subsection[Uniques-prelude]{@Uniques@ for wired-in Prelude things}
277 %*                                                                      *
278 %************************************************************************
279
280 Allocation of unique supply characters:
281         v,t,u : for renumbering value-, type- and usage- vars.
282         B:   builtin
283         C-E: pseudo uniques     (used in native-code generator)
284         X:   uniques derived by deriveUnique
285         _:   unifiable tyvars   (above)
286         0-9: prelude things below
287              (no numbers left any more..)
288         ::   (prelude) parallel array data constructors
289
290         other a-z: lower case chars for unique supplies.  Used so far:
291
292         d       desugarer
293         f       AbsC flattener
294         g       SimplStg
295         n       Native codegen
296         r       Hsc name cache
297         s       simplifier
298
299 \begin{code}
300 mkAlphaTyVarUnique     :: Int -> Unique
301 mkPreludeClassUnique   :: Int -> Unique
302 mkPreludeTyConUnique   :: Int -> Unique
303 mkTupleTyConUnique     :: TupleSort -> Int -> Unique
304 mkPreludeDataConUnique :: Int -> Unique
305 mkTupleDataConUnique   :: TupleSort -> Int -> Unique
306 mkPrimOpIdUnique       :: Int -> Unique
307 mkPreludeMiscIdUnique  :: Int -> Unique
308 mkPArrDataConUnique    :: Int -> Unique
309
310 mkAlphaTyVarUnique i            = mkUnique '1' i
311
312 mkPreludeClassUnique i          = mkUnique '2' i
313
314 -- Prelude type constructors occupy *three* slots.
315 -- The first is for the tycon itself; the latter two
316 -- are for the generic to/from Ids.  See TysWiredIn.mk_tc_gen_info.
317
318 mkPreludeTyConUnique i          = mkUnique '3' (3*i)
319 mkTupleTyConUnique BoxedTuple   a       = mkUnique '4' (3*a)
320 mkTupleTyConUnique UnboxedTuple a       = mkUnique '5' (3*a)
321 mkTupleTyConUnique ConstraintTuple a    = mkUnique 'k' (3*a)
322
323 -- Data constructor keys occupy *two* slots.  The first is used for the
324 -- data constructor itself and its wrapper function (the function that
325 -- evaluates arguments as necessary and calls the worker). The second is
326 -- used for the worker function (the function that builds the constructor
327 -- representation).
328
329 mkPreludeDataConUnique i        = mkUnique '6' (2*i)    -- Must be alphabetic
330 mkTupleDataConUnique BoxedTuple   a = mkUnique '7' (2*a)        -- ditto (*may* be used in C labels)
331 mkTupleDataConUnique UnboxedTuple    a = mkUnique '8' (2*a)
332 mkTupleDataConUnique ConstraintTuple a = mkUnique 'h' (2*a)
333
334 mkPrimOpIdUnique op         = mkUnique '9' op
335 mkPreludeMiscIdUnique  i    = mkUnique '0' i
336
337 -- No numbers left anymore, so I pick something different for the character tag
338 mkPArrDataConUnique a           = mkUnique ':' (2*a)
339
340 -- The "tyvar uniques" print specially nicely: a, b, c, etc.
341 -- See pprUnique for details
342
343 initTyVarUnique :: Unique
344 initTyVarUnique = mkUnique 't' 0
345
346 mkPseudoUniqueD, mkPseudoUniqueE, mkPseudoUniqueH,
347    mkBuiltinUnique :: Int -> Unique
348
349 mkBuiltinUnique i = mkUnique 'B' i
350 mkPseudoUniqueD i = mkUnique 'D' i -- used in NCG for getUnique on RealRegs
351 mkPseudoUniqueE i = mkUnique 'E' i -- used in NCG spiller to create spill VirtualRegs
352 mkPseudoUniqueH i = mkUnique 'H' i -- used in NCG spiller to create spill VirtualRegs
353
354 mkRegSingleUnique, mkRegPairUnique, mkRegSubUnique, mkRegClassUnique :: Int -> Unique
355 mkRegSingleUnique = mkUnique 'R'
356 mkRegSubUnique    = mkUnique 'S'
357 mkRegPairUnique   = mkUnique 'P'
358 mkRegClassUnique  = mkUnique 'L'
359
360 mkCostCentreUnique :: Int -> Unique
361 mkCostCentreUnique = mkUnique 'C'
362
363 mkVarOccUnique, mkDataOccUnique, mkTvOccUnique, mkTcOccUnique :: FastString -> Unique
364 -- See Note [The Unique of an OccName] in OccName
365 mkVarOccUnique  fs = mkUnique 'i' (iBox (uniqueOfFS fs))
366 mkDataOccUnique fs = mkUnique 'd' (iBox (uniqueOfFS fs))
367 mkTvOccUnique   fs = mkUnique 'v' (iBox (uniqueOfFS fs))
368 mkTcOccUnique   fs = mkUnique 'c' (iBox (uniqueOfFS fs))
369 \end{code}
370