ghc/compiler/basicTypes/MkId.lhs

   1 %
   2 % (c) The AQUA Project, Glasgow University, 1998
   3 %
   4 \section[StdIdInfo]{Standard unfoldings}
   5
   6 This module contains definitions for the IdInfo for things that
   7 have a standard form, namely:
   8
   9         * data constructors
  10         * record selectors
  11         * method and superclass selectors
  12         * primitive operations
  13
  14 \begin{code}
  15 module MkId (
  16         mkSpecPragmaId, mkWorkerId,
  17
  18         mkDictFunId, mkDefaultMethodId,
  19         mkDictSelId,
  20
  21         mkDataConId, mkDataConWrapId,
  22         mkRecordSelId,
  23         mkPrimOpId, mkCCallOpId,
  24
  25         -- And some particular Ids; see below for why they are wired in
  26         wiredInIds,
  27         unsafeCoerceId, realWorldPrimId,
  28         eRROR_ID, rEC_SEL_ERROR_ID, pAT_ERROR_ID, rEC_CON_ERROR_ID,
  29         rEC_UPD_ERROR_ID, iRREFUT_PAT_ERROR_ID, nON_EXHAUSTIVE_GUARDS_ERROR_ID,
  30         nO_METHOD_BINDING_ERROR_ID, aBSENT_ERROR_ID, pAR_ERROR_ID
  31     ) where
  32
  33 #include "HsVersions.h"
  34
  35
  36 import TysPrim          ( openAlphaTyVars, alphaTyVar, alphaTy,
  37                           intPrimTy, realWorldStatePrimTy
  38                         )
  39 import TysWiredIn       ( charTy, mkListTy )
  40 import PrelNames        ( pREL_ERR, pREL_GHC )
  41 import PrelRules        ( primOpRule )
  42 import Rules            ( addRule )
  43 import Type             ( Type, ThetaType, mkDictTy, mkDictTys, mkTyConApp, mkTyVarTys,
  44                           mkFunTys, mkFunTy, mkSigmaTy,
  45                           isUnLiftedType, mkForAllTys, mkTyVarTy, tyVarsOfType,
  46                           splitFunTys, splitForAllTys
  47                         )
  48 import Module           ( Module )
  49 import CoreUtils        ( exprType, mkInlineMe )
  50 import CoreUnfold       ( mkTopUnfolding, mkCompulsoryUnfolding, mkOtherCon )
  51 import Literal          ( Literal(..) )
  52 import TyCon            ( TyCon, isNewTyCon, tyConTyVars, tyConDataCons,
  53                           tyConTheta, isProductTyCon, isDataTyCon )
  54 import Class            ( Class, classTyCon, classTyVars, classSelIds )
  55 import Var              ( Id, TyVar )
  56 import VarSet           ( isEmptyVarSet )
  57 import Name             ( mkWiredInName, mkLocalName,
  58                           mkWorkerOcc, mkCCallName,
  59                           Name, NamedThing(..), getSrcLoc
  60                         )
  61 import OccName          ( mkVarOcc )
  62 import PrimOp           ( PrimOp(DataToTagOp, CCallOp),
  63                           primOpSig, mkPrimOpIdName,
  64                           CCall, pprCCallOp
  65                         )
  66 import Demand           ( wwStrict, wwPrim, mkStrictnessInfo )
  67 import DataCon          ( DataCon, StrictnessMark(..),
  68                           dataConFieldLabels, dataConRepArity, dataConTyCon,
  69                           dataConArgTys, dataConRepType, dataConRepStrictness,
  70                           dataConInstOrigArgTys,
  71                           dataConName, dataConTheta,
  72                           dataConSig, dataConStrictMarks, dataConId,
  73                           maybeMarkedUnboxed, splitProductType_maybe
  74                         )
  75 import Id               ( idType, mkId,
  76                           mkVanillaId, mkTemplateLocals,
  77                           mkTemplateLocal, idCprInfo
  78                         )
  79 import IdInfo           ( IdInfo, constantIdInfo, mkIdInfo,
  80                           exactArity, setUnfoldingInfo, setCafInfo, setCprInfo,
  81                           setArityInfo, setSpecInfo, setTyGenInfo,
  82                           mkStrictnessInfo, setStrictnessInfo,
  83                           IdFlavour(..), CafInfo(..), CprInfo(..), TyGenInfo(..)
  84                         )
  85 import FieldLabel       ( mkFieldLabel, fieldLabelName,
  86                           firstFieldLabelTag, allFieldLabelTags, fieldLabelType
  87                         )
  88 import CoreSyn
  89 import Maybes
  90 import PrelNames
  91 import Maybe            ( isJust )
  92 import Outputable
  93 import ListSetOps       ( assoc, assocMaybe )
  94 import UnicodeUtil      ( stringToUtf8 )
  95 import Char             ( ord )
  96 \end{code}
  97
  98
  99 %************************************************************************
 100 %*                                                                      *
 101 \subsection{Wired in Ids}
 102 %*                                                                      *
 103 %************************************************************************
 104
 105 \begin{code}
 106 wiredInIds
 107   = [   -- These error-y things are wired in because we don't yet have
 108         -- a way to express in an interface file that the result type variable
 109         -- is 'open'; that is can be unified with an unboxed type
 110         --
 111         -- [The interface file format now carry such information, but there's
 112         -- no way yet of expressing at the definition site for these
 113         -- error-reporting
 114         -- functions that they have an 'open' result type. -- sof 1/99]
 115
 116       aBSENT_ERROR_ID
 117     , eRROR_ID
 118     , iRREFUT_PAT_ERROR_ID
 119     , nON_EXHAUSTIVE_GUARDS_ERROR_ID
 120     , nO_METHOD_BINDING_ERROR_ID
 121     , pAR_ERROR_ID
 122     , pAT_ERROR_ID
 123     , rEC_CON_ERROR_ID
 124     , rEC_UPD_ERROR_ID
 125
 126         -- These two can't be defined in Haskell
 127     , realWorldPrimId
 128     , unsafeCoerceId
 129     , getTagId
 130     ]
 131 \end{code}
 132
 133 %************************************************************************
 134 %*                                                                      *
 135 \subsection{Easy ones}
 136 %*                                                                      *
 137 %************************************************************************
 138
 139 \begin{code}
 140 mkSpecPragmaId occ uniq ty loc
 141   = mkId (mkLocalName uniq occ loc) ty (mkIdInfo SpecPragmaId NoCafRefs)
 142         -- Maybe a SysLocal?  But then we'd lose the location
 143
 144 mkDefaultMethodId dm_name rec_c ty
 145   = mkId dm_name ty info
 146   where
 147     info = constantIdInfo `setTyGenInfo` TyGenNever
 148              -- type is wired-in (see comment at TcClassDcl.tcClassSig), so
 149              -- do not generalise it
 150
 151 mkWorkerId :: Unique -> Id -> Type -> Id
 152 -- A worker gets a local name.  CoreTidy will globalise it if necessary.
 153 mkWorkerId uniq unwrkr ty
 154   = mkVanillaId wkr_name ty
 155   where
 156     wkr_name = mkLocalName uniq (mkWorkerOcc (getOccName unwrkr)) (getSrcLoc unwrkr)
 157 \end{code}
 158
 159 %************************************************************************
 160 %*                                                                      *
 161 \subsection{Data constructors}
 162 %*                                                                      *
 163 %************************************************************************
 164
 165 \begin{code}
 166 mkDataConId :: Name -> DataCon -> Id
 167         -- Makes the *worker* for the data constructor; that is, the function
 168         -- that takes the reprsentation arguments and builds the constructor.
 169 mkDataConId work_name data_con
 170   = mkId work_name (dataConRepType data_con) info
 171   where
 172     info = mkIdInfo (DataConId data_con) NoCafRefs
 173            `setArityInfo`       exactArity arity
 174            `setStrictnessInfo`  strict_info
 175            `setCprInfo`         cpr_info
 176
 177     arity = dataConRepArity data_con
 178
 179     strict_info = mkStrictnessInfo (dataConRepStrictness data_con, False)
 180
 181     tycon = dataConTyCon data_con
 182     cpr_info | isProductTyCon tycon &&
 183                isDataTyCon tycon    &&
 184                arity > 0                = ReturnsCPR
 185              | otherwise                = NoCPRInfo
 186         -- ReturnsCPR is only true for products that are real data types;
 187         -- that is, not unboxed tuples or newtypes
 188 \end{code}
 189
 190 The wrapper for a constructor is an ordinary top-level binding that evaluates
 191 any strict args, unboxes any args that are going to be flattened, and calls
 192 the worker.
 193
 194 We're going to build a constructor that looks like:
 195
 196         data (Data a, C b) =>  T a b = T1 !a !Int b
 197
 198         T1 = /\ a b ->
 199              \d1::Data a, d2::C b ->
 200              \p q r -> case p of { p ->
 201                        case q of { q ->
 202                        Con T1 [a,b] [p,q,r]}}
 203
 204 Notice that
 205
 206 * d2 is thrown away --- a context in a data decl is used to make sure
 207   one *could* construct dictionaries at the site the constructor
 208   is used, but the dictionary isn't actually used.
 209
 210 * We have to check that we can construct Data dictionaries for
 211   the types a and Int.  Once we've done that we can throw d1 away too.
 212
 213 * We use (case p of q -> ...) to evaluate p, rather than "seq" because
 214   all that matters is that the arguments are evaluated.  "seq" is
 215   very careful to preserve evaluation order, which we don't need
 216   to be here.
 217
 218   You might think that we could simply give constructors some strictness
 219   info, like PrimOps, and let CoreToStg do the let-to-case transformation.
 220   But we don't do that because in the case of primops and functions strictness
 221   is a *property* not a *requirement*.  In the case of constructors we need to
 222   do something active to evaluate the argument.
 223
 224   Making an explicit case expression allows the simplifier to eliminate
 225   it in the (common) case where the constructor arg is already evaluated.
 226
 227 \begin{code}
 228 mkDataConWrapId data_con
 229   = wrap_id
 230   where
 231     wrap_id = mkId (dataConName data_con) wrap_ty info
 232     work_id = dataConId data_con
 233
 234     info = mkIdInfo (DataConWrapId data_con) NoCafRefs
 235            `setUnfoldingInfo`   mkTopUnfolding (mkInlineMe wrap_rhs)
 236            `setCprInfo`         cpr_info
 237                 -- The Cpr info can be important inside INLINE rhss, where the
 238                 -- wrapper constructor isn't inlined
 239            `setArityInfo`       exactArity arity
 240                 -- It's important to specify the arity, so that partial
 241                 -- applications are treated as values
 242            `setTyGenInfo`     TyGenNever
 243                 -- No point generalising its type, since it gets eagerly inlined
 244                 -- away anyway
 245
 246     wrap_ty = mkForAllTys all_tyvars $
 247               mkFunTys all_arg_tys
 248               result_ty
 249
 250     cpr_info = idCprInfo work_id
 251
 252     wrap_rhs | isNewTyCon tycon
 253              = ASSERT( null ex_tyvars && null ex_dict_args && length orig_arg_tys == 1 )
 254                 -- No existentials on a newtype, but it can have a context
 255                 -- e.g.         newtype Eq a => T a = MkT (...)
 256
 257                mkLams tyvars $ mkLams dict_args $ Lam id_arg1 $
 258                Note (Coerce result_ty (head orig_arg_tys)) (Var id_arg1)
 259
 260              | null dict_args && all not_marked_strict strict_marks
 261              = Var work_id      -- The common case.  Not only is this efficient,
 262                                 -- but it also ensures that the wrapper is replaced
 263                                 -- by the worker even when there are no args.
 264                                 --              f (:) x
 265                                 -- becomes
 266                                 --              f $w: x
 267                                 -- This is really important in rule matching,
 268                                 -- (We could match on the wrappers,
 269                                 -- but that makes it less likely that rules will match
 270                                 -- when we bring bits of unfoldings together.)
 271                 --
 272                 -- NB:  because of this special case, (map (:) ys) turns into
 273                 --      (map $w: ys), and thence into (map (\x xs. $w: x xs) ys)
 274                 --      in core-to-stg.  The top-level defn for (:) is never used.
 275                 --      This is somewhat of a bore, but I'm currently leaving it
 276                 --      as is, so that there still is a top level curried (:) for
 277                 --      the interpreter to call.
 278
 279              | otherwise
 280              = mkLams all_tyvars $ mkLams dict_args $
 281                mkLams ex_dict_args $ mkLams id_args $
 282                foldr mk_case con_app
 283                      (zip (ex_dict_args++id_args) strict_marks) i3 []
 284
 285     con_app i rep_ids = mkApps (Var work_id)
 286                                (map varToCoreExpr (all_tyvars ++ reverse rep_ids))
 287
 288     (tyvars, theta, ex_tyvars, ex_theta, orig_arg_tys, tycon) = dataConSig data_con
 289     all_tyvars   = tyvars ++ ex_tyvars
 290
 291     dict_tys     = mkDictTys theta
 292     ex_dict_tys  = mkDictTys ex_theta
 293     all_arg_tys  = dict_tys ++ ex_dict_tys ++ orig_arg_tys
 294     result_ty    = mkTyConApp tycon (mkTyVarTys tyvars)
 295
 296     mkLocals i tys = (zipWith mkTemplateLocal [i..i+n-1] tys, i+n)
 297                    where
 298                      n = length tys
 299
 300     (dict_args, i1)    = mkLocals 1  dict_tys
 301     (ex_dict_args,i2)  = mkLocals i1 ex_dict_tys
 302     (id_args,i3)       = mkLocals i2 orig_arg_tys
 303     arity              = i3-1
 304     (id_arg1:_)   = id_args             -- Used for newtype only
 305
 306     strict_marks  = dataConStrictMarks data_con
 307     not_marked_strict NotMarkedStrict = True
 308     not_marked_strict other           = False
 309
 310
 311     mk_case
 312            :: (Id, StrictnessMark)      -- arg, strictness
 313            -> (Int -> [Id] -> CoreExpr) -- body
 314            -> Int                       -- next rep arg id
 315            -> [Id]                      -- rep args so far
 316            -> CoreExpr
 317     mk_case (arg,strict) body i rep_args
 318           = case strict of
 319                 NotMarkedStrict -> body i (arg:rep_args)
 320                 MarkedStrict
 321                    | isUnLiftedType (idType arg) -> body i (arg:rep_args)
 322                    | otherwise ->
 323                         Case (Var arg) arg [(DEFAULT,[], body i (arg:rep_args))]
 324
 325                 MarkedUnboxed con tys ->
 326                    Case (Var arg) arg [(DataAlt con, con_args,
 327                                         body i' (reverse con_args++rep_args))]
 328                    where
 329                         (con_args,i') = mkLocals i tys
 330 \end{code}
 331
 332
 333 %************************************************************************
 334 %*                                                                      *
 335 \subsection{Record selectors}
 336 %*                                                                      *
 337 %************************************************************************
 338
 339 We're going to build a record selector unfolding that looks like this:
 340
 341         data T a b c = T1 { ..., op :: a, ...}
 342                      | T2 { ..., op :: a, ...}
 343                      | T3
 344
 345         sel = /\ a b c -> \ d -> case d of
 346                                     T1 ... x ... -> x
 347                                     T2 ... x ... -> x
 348                                     other        -> error "..."
 349
 350 Similarly for newtypes
 351
 352         newtype N a = MkN { unN :: a->a }
 353
 354         unN :: N a -> a -> a
 355         unN n = coerce (a->a) n
 356
 357 We need to take a little care if the field has a polymorphic type:
 358
 359         data R = R { f :: forall a. a->a }
 360
 361 Then we want
 362
 363         f :: forall a. R -> a -> a
 364         f = /\ a \ r = case r of
 365                           R f -> f a
 366
 367 (not f :: R -> forall a. a->a, which gives the type inference mechanism
 368 problems at call sites)
 369
 370 Similarly for newtypes
 371
 372         newtype N = MkN { unN :: forall a. a->a }
 373
 374         unN :: forall a. N -> a -> a
 375         unN = /\a -> \n:N -> coerce (a->a) n
 376
 377 \begin{code}
 378 mkRecordSelId tycon field_label unpack_id unpackUtf8_id
 379         -- Assumes that all fields with the same field label have the same type
 380         --
 381         -- Annoyingly, we have to pass in the unpackCString# Id, because
 382         -- we can't conjure it up out of thin air
 383   = sel_id
 384   where
 385     sel_id     = mkId (fieldLabelName field_label) selector_ty info
 386
 387     field_ty   = fieldLabelType field_label
 388     data_cons  = tyConDataCons tycon
 389     tyvars     = tyConTyVars tycon      -- These scope over the types in
 390                                         -- the FieldLabels of constructors of this type
 391     tycon_theta = tyConTheta tycon      -- The context on the data decl
 392                                         --   eg data (Eq a, Ord b) => T a b = ...
 393     (field_tyvars,field_tau) = splitForAllTys field_ty
 394
 395     data_ty   = mkTyConApp tycon tyvar_tys
 396     tyvar_tys = mkTyVarTys tyvars
 397
 398         -- Very tiresomely, the selectors are (unnecessarily!) overloaded over
 399         -- just the dictionaries in the types of the constructors that contain
 400         -- the relevant field.  Urgh.
 401         -- NB: this code relies on the fact that DataCons are quantified over
 402         -- the identical type variables as their parent TyCon
 403     dict_tys  = [mkDictTy cls tys | (cls, tys) <- tycon_theta, needed_dict (cls, tys)]
 404     needed_dict pred = or [ pred `elem` (dataConTheta dc)
 405                           | (DataAlt dc, _, _) <- the_alts]
 406
 407     selector_ty :: Type
 408     selector_ty  = mkForAllTys tyvars $ mkForAllTys field_tyvars $
 409                    mkFunTys dict_tys $  mkFunTy data_ty field_tau
 410
 411     info = mkIdInfo (RecordSelId field_label) NoCafRefs
 412            `setArityInfo`       exactArity (1 + length dict_tys)
 413            `setUnfoldingInfo`   unfolding
 414            `setTyGenInfo`       TyGenNever
 415         -- ToDo: consider adding further IdInfo
 416
 417     unfolding = mkTopUnfolding sel_rhs
 418
 419
 420     (data_id:dict_ids) = mkTemplateLocals (data_ty:dict_tys)
 421     alts      = map mk_maybe_alt data_cons
 422     the_alts  = catMaybes alts
 423     default_alt | all isJust alts = []  -- No default needed
 424                 | otherwise       = [(DEFAULT, [], error_expr)]
 425
 426     sel_rhs = mkLams tyvars $ mkLams field_tyvars $
 427               mkLams dict_ids $ Lam data_id $
 428               sel_body
 429
 430     sel_body | isNewTyCon tycon = Note (Coerce field_tau data_ty) (Var data_id)
 431              | otherwise        = Case (Var data_id) data_id (the_alts ++ default_alt)
 432
 433     mk_maybe_alt data_con
 434           = case maybe_the_arg_id of
 435                 Nothing         -> Nothing
 436                 Just the_arg_id -> Just (DataAlt data_con, real_args, expr)
 437                   where
 438                     body              = mkVarApps (Var the_arg_id) field_tyvars
 439                     strict_marks      = dataConStrictMarks data_con
 440                     (expr, real_args) = rebuildConArgs data_con arg_ids strict_marks body
 441                                           (length arg_ids + 1)
 442         where
 443             arg_ids = mkTemplateLocals (dataConInstOrigArgTys data_con tyvar_tys)
 444                                     -- The first one will shadow data_id, but who cares
 445             maybe_the_arg_id  = assocMaybe (field_lbls `zip` arg_ids) field_label
 446             field_lbls        = dataConFieldLabels data_con
 447
 448     error_expr = mkApps (Var rEC_SEL_ERROR_ID) [Type field_tau, err_string]
 449     err_string
 450         | all safeChar full_msg
 451             = App (Var unpack_id) (Lit (MachStr (_PK_ full_msg)))
 452         | otherwise
 453             = App (Var unpackUtf8_id) (Lit (MachStr (_PK_ (stringToUtf8 (map ord full_msg)))))
 454         where
 455         safeChar c = c >= '\1' && c <= '\xFF'
 456         -- TODO: Putting this Unicode stuff here is ugly. Find a better
 457         -- generic place to make string literals. This logic is repeated
 458         -- in DsUtils.
 459     full_msg   = showSDoc (sep [text "No match in record selector", ppr sel_id])
 460
 461
 462 -- this rather ugly function converts the unpacked data con arguments back into
 463 -- their packed form.  It is almost the same as the version in DsUtils, except that
 464 -- we use template locals here rather than newDsId (ToDo: merge these).
 465
 466 rebuildConArgs
 467   :: DataCon                            -- the con we're matching on
 468   -> [Id]                               -- the source-level args
 469   -> [StrictnessMark]                   -- the strictness annotations (per-arg)
 470   -> CoreExpr                           -- the body
 471   -> Int                                -- template local
 472   -> (CoreExpr, [Id])
 473
 474 rebuildConArgs con [] stricts body i = (body, [])
 475 rebuildConArgs con (arg:args) stricts body i | isTyVar arg
 476   = let (body', args') = rebuildConArgs con args stricts body i
 477     in  (body',arg:args')
 478 rebuildConArgs con (arg:args) (str:stricts) body i
 479   = case maybeMarkedUnboxed str of
 480         Just (pack_con1, _) ->
 481             case splitProductType_maybe (idType arg) of
 482                 Just (_, tycon_args, pack_con, con_arg_tys) ->
 483                     ASSERT( pack_con == pack_con1 )
 484                     let unpacked_args = zipWith mkTemplateLocal [i..] con_arg_tys
 485                         (body', real_args) = rebuildConArgs con args stricts body
 486                                                 (i + length con_arg_tys)
 487                     in
 488                     (
 489                          Let (NonRec arg (mkConApp pack_con
 490                                                   (map Type tycon_args ++
 491                                                    map Var  unpacked_args))) body',
 492                          unpacked_args ++ real_args
 493                     )
 494
 495         _ -> let (body', args') = rebuildConArgs con args stricts body i
 496              in  (body', arg:args')
 497 \end{code}
 498
 499
 500 %************************************************************************
 501 %*                                                                      *
 502 \subsection{Dictionary selectors}
 503 %*                                                                      *
 504 %************************************************************************
 505
 506 Selecting a field for a dictionary.  If there is just one field, then
 507 there's nothing to do.
 508
 509 ToDo: unify with mkRecordSelId.
 510
 511 \begin{code}
 512 mkDictSelId :: Name -> Class -> Id
 513 mkDictSelId name clas
 514   = sel_id
 515   where
 516     ty        = exprType rhs
 517     sel_id    = mkId name ty info
 518     field_lbl = mkFieldLabel name tycon ty tag
 519     tag       = assoc "MkId.mkDictSelId" (classSelIds clas `zip` allFieldLabelTags) sel_id
 520
 521     info      = mkIdInfo (RecordSelId field_lbl) NoCafRefs
 522                 `setArityInfo`      exactArity 1
 523                 `setUnfoldingInfo`  unfolding
 524                 `setTyGenInfo`      TyGenNever
 525
 526         -- We no longer use 'must-inline' on record selectors.  They'll
 527         -- inline like crazy if they scrutinise a constructor
 528
 529     unfolding = mkTopUnfolding rhs
 530
 531     tyvars  = classTyVars clas
 532
 533     tycon      = classTyCon clas
 534     [data_con] = tyConDataCons tycon
 535     tyvar_tys  = mkTyVarTys tyvars
 536     arg_tys    = dataConArgTys data_con tyvar_tys
 537     the_arg_id = arg_ids !! (tag - firstFieldLabelTag)
 538
 539     dict_ty    = mkDictTy clas tyvar_tys
 540     (dict_id:arg_ids) = mkTemplateLocals (dict_ty : arg_tys)
 541
 542     rhs | isNewTyCon tycon = mkLams tyvars $ Lam dict_id $
 543                              Note (Coerce (head arg_tys) dict_ty) (Var dict_id)
 544         | otherwise        = mkLams tyvars $ Lam dict_id $
 545                              Case (Var dict_id) dict_id
 546                                   [(DataAlt data_con, arg_ids, Var the_arg_id)]
 547 \end{code}
 548
 549
 550 %************************************************************************
 551 %*                                                                      *
 552 \subsection{Primitive operations
 553 %*                                                                      *
 554 %************************************************************************
 555
 556 \begin{code}
 557 mkPrimOpId :: PrimOp -> Id
 558 mkPrimOpId prim_op
 559   = id
 560   where
 561     (tyvars,arg_tys,res_ty, arity, strict_info) = primOpSig prim_op
 562     ty   = mkForAllTys tyvars (mkFunTys arg_tys res_ty)
 563     name = mkPrimOpIdName prim_op
 564     id   = mkId name ty info
 565
 566     info = mkIdInfo (PrimOpId prim_op) NoCafRefs
 567            `setSpecInfo`        rules
 568            `setArityInfo`       exactArity arity
 569            `setStrictnessInfo`  strict_info
 570
 571     rules = addRule emptyCoreRules id (primOpRule prim_op)
 572
 573
 574 -- For each ccall we manufacture a separate CCallOpId, giving it
 575 -- a fresh unique, a type that is correct for this particular ccall,
 576 -- and a CCall structure that gives the correct details about calling
 577 -- convention etc.
 578 --
 579 -- The *name* of this Id is a local name whose OccName gives the full
 580 -- details of the ccall, type and all.  This means that the interface
 581 -- file reader can reconstruct a suitable Id
 582
 583 mkCCallOpId :: Unique -> CCall -> Type -> Id
 584 mkCCallOpId uniq ccall ty
 585   = ASSERT( isEmptyVarSet (tyVarsOfType ty) )
 586         -- A CCallOpId should have no free type variables;
 587         -- when doing substitutions won't substitute over it
 588     mkId name ty info
 589   where
 590     occ_str = showSDocIface (braces (pprCCallOp ccall <+> ppr ty))
 591         -- The "occurrence name" of a ccall is the full info about the
 592         -- ccall; it is encoded, but may have embedded spaces etc!
 593
 594     name    = mkCCallName uniq occ_str
 595     prim_op = CCallOp ccall
 596
 597     info = mkIdInfo (PrimOpId prim_op) NoCafRefs
 598            `setArityInfo`       exactArity arity
 599            `setStrictnessInfo`  strict_info
 600
 601     (_, tau)     = splitForAllTys ty
 602     (arg_tys, _) = splitFunTys tau
 603     arity        = length arg_tys
 604     strict_info  = mkStrictnessInfo (take arity (repeat wwPrim), False)
 605 \end{code}
 606
 607
 608 %************************************************************************
 609 %*                                                                      *
 610 \subsection{DictFuns}
 611 %*                                                                      *
 612 %************************************************************************
 613
 614 \begin{code}
 615 mkDictFunId :: Name             -- Name to use for the dict fun;
 616             -> Class
 617             -> [TyVar]
 618             -> [Type]
 619             -> ThetaType
 620             -> Id
 621
 622 mkDictFunId dfun_name clas inst_tyvars inst_tys dfun_theta
 623   = mkId dfun_name dfun_ty info
 624   where
 625     dfun_ty = mkSigmaTy inst_tyvars dfun_theta (mkDictTy clas inst_tys)
 626     info = mkIdInfo DictFunId MayHaveCafRefs
 627            `setTyGenInfo` TyGenNever
 628              -- type is wired-in (see comment at TcClassDcl.tcClassSig), so
 629              -- do not generalise it
 630         -- An imported dfun may refer to CAFs, so we assume the worst
 631
 632 {-  1 dec 99: disable the Mark Jones optimisation for the sake
 633     of compatibility with Hugs.
 634     See `types/InstEnv' for a discussion related to this.
 635
 636     (class_tyvars, sc_theta, _, _) = classBigSig clas
 637     not_const (clas, tys) = not (isEmptyVarSet (tyVarsOfTypes tys))
 638     sc_theta' = substClasses (mkTopTyVarSubst class_tyvars inst_tys) sc_theta
 639     dfun_theta = case inst_decl_theta of
 640                    []    -> []  -- If inst_decl_theta is empty, then we don't
 641                                 -- want to have any dict arguments, so that we can
 642                                 -- expose the constant methods.
 643
 644                    other -> nub (inst_decl_theta ++ filter not_const sc_theta')
 645                                 -- Otherwise we pass the superclass dictionaries to
 646                                 -- the dictionary function; the Mark Jones optimisation.
 647                                 --
 648                                 -- NOTE the "nub".  I got caught by this one:
 649                                 --   class Monad m => MonadT t m where ...
 650                                 --   instance Monad m => MonadT (EnvT env) m where ...
 651                                 -- Here, the inst_decl_theta has (Monad m); but so
 652                                 -- does the sc_theta'!
 653                                 --
 654                                 -- NOTE the "not_const".  I got caught by this one too:
 655                                 --   class Foo a => Baz a b where ...
 656                                 --   instance Wob b => Baz T b where..
 657                                 -- Now sc_theta' has Foo T
 658 -}
 659 \end{code}
 660
 661
 662 %************************************************************************
 663 %*                                                                      *
 664 \subsection{Un-definable}
 665 %*                                                                      *
 666 %************************************************************************
 667
 668 These two can't be defined in Haskell.
 669
 670 unsafeCoerce# isn't so much a PrimOp as a phantom identifier, that
 671 just gets expanded into a type coercion wherever it occurs.  Hence we
 672 add it as a built-in Id with an unfolding here.
 673
 674 The type variables we use here are "open" type variables: this means
 675 they can unify with both unlifted and lifted types.  Hence we provide
 676 another gun with which to shoot yourself in the foot.
 677
 678 \begin{code}
 679 unsafeCoerceId
 680   = pcMiscPrelId unsafeCoerceIdKey pREL_GHC SLIT("unsafeCoerce#") ty info
 681   where
 682     info = constantIdInfo `setUnfoldingInfo` mkCompulsoryUnfolding rhs
 683
 684
 685     ty  = mkForAllTys [openAlphaTyVar,openBetaTyVar]
 686                       (mkFunTy openAlphaTy openBetaTy)
 687     [x] = mkTemplateLocals [openAlphaTy]
 688     rhs = mkLams [openAlphaTyVar,openBetaTyVar,x] $
 689           Note (Coerce openBetaTy openAlphaTy) (Var x)
 690 \end{code}
 691
 692
 693 @getTag#@ is another function which can't be defined in Haskell.  It needs to
 694 evaluate its argument and call the dataToTag# primitive.
 695
 696 \begin{code}
 697 getTagId
 698   = pcMiscPrelId getTagIdKey pREL_GHC SLIT("getTag#") ty info
 699   where
 700     info = constantIdInfo
 701            `setUnfoldingInfo`   mkCompulsoryUnfolding rhs
 702         -- We don't provide a defn for this; you must inline it
 703
 704     ty = mkForAllTys [alphaTyVar] (mkFunTy alphaTy intPrimTy)
 705     [x,y] = mkTemplateLocals [alphaTy,alphaTy]
 706     rhs = mkLams [alphaTyVar,x] $
 707           Case (Var x) y [ (DEFAULT, [], mkApps (Var dataToTagId) [Type alphaTy, Var y]) ]
 708
 709 dataToTagId = mkPrimOpId DataToTagOp
 710 \end{code}
 711
 712 @realWorld#@ used to be a magic literal, \tr{void#}.  If things get
 713 nasty as-is, change it back to a literal (@Literal@).
 714
 715 \begin{code}
 716 realWorldPrimId -- :: State# RealWorld
 717   = pcMiscPrelId realWorldPrimIdKey pREL_GHC SLIT("realWorld#")
 718                  realWorldStatePrimTy
 719                  (noCafIdInfo `setUnfoldingInfo` mkOtherCon [])
 720         -- The mkOtherCon makes it look that realWorld# is evaluated
 721         -- which in turn makes Simplify.interestingArg return True,
 722         -- which in turn makes INLINE things applied to realWorld# likely
 723         -- to be inlined
 724 \end{code}
 725
 726
 727 %************************************************************************
 728 %*                                                                      *
 729 \subsection[PrelVals-error-related]{@error@ and friends; @trace@}
 730 %*                                                                      *
 731 %************************************************************************
 732
 733 GHC randomly injects these into the code.
 734
 735 @patError@ is just a version of @error@ for pattern-matching
 736 failures.  It knows various ``codes'' which expand to longer
 737 strings---this saves space!
 738
 739 @absentErr@ is a thing we put in for ``absent'' arguments.  They jolly
 740 well shouldn't be yanked on, but if one is, then you will get a
 741 friendly message from @absentErr@ (rather than a totally random
 742 crash).
 743
 744 @parError@ is a special version of @error@ which the compiler does
 745 not know to be a bottoming Id.  It is used in the @_par_@ and @_seq_@
 746 templates, but we don't ever expect to generate code for it.
 747
 748 \begin{code}
 749 eRROR_ID
 750   = pc_bottoming_Id errorIdKey pREL_ERR SLIT("error") errorTy
 751 pAT_ERROR_ID
 752   = generic_ERROR_ID patErrorIdKey SLIT("patError")
 753 rEC_SEL_ERROR_ID
 754   = generic_ERROR_ID recSelErrIdKey SLIT("recSelError")
 755 rEC_CON_ERROR_ID
 756   = generic_ERROR_ID recConErrorIdKey SLIT("recConError")
 757 rEC_UPD_ERROR_ID
 758   = generic_ERROR_ID recUpdErrorIdKey SLIT("recUpdError")
 759 iRREFUT_PAT_ERROR_ID
 760   = generic_ERROR_ID irrefutPatErrorIdKey SLIT("irrefutPatError")
 761 nON_EXHAUSTIVE_GUARDS_ERROR_ID
 762   = generic_ERROR_ID nonExhaustiveGuardsErrorIdKey SLIT("nonExhaustiveGuardsError")
 763 nO_METHOD_BINDING_ERROR_ID
 764   = generic_ERROR_ID noMethodBindingErrorIdKey SLIT("noMethodBindingError")
 765
 766 aBSENT_ERROR_ID
 767   = pc_bottoming_Id absentErrorIdKey pREL_ERR SLIT("absentErr")
 768         (mkSigmaTy [openAlphaTyVar] [] openAlphaTy)
 769
 770 pAR_ERROR_ID
 771   = pcMiscPrelId parErrorIdKey pREL_ERR SLIT("parError")
 772     (mkSigmaTy [openAlphaTyVar] [] openAlphaTy) noCafIdInfo
 773
 774 \end{code}
 775
 776
 777 %************************************************************************
 778 %*                                                                      *
 779 \subsection{Utilities}
 780 %*                                                                      *
 781 %************************************************************************
 782
 783 \begin{code}
 784 pcMiscPrelId :: Unique{-IdKey-} -> Module -> FAST_STRING -> Type -> IdInfo -> Id
 785 pcMiscPrelId key mod str ty info
 786   = let
 787         name = mkWiredInName mod (mkVarOcc str) key
 788         imp  = mkId name ty info -- the usual case...
 789     in
 790     imp
 791     -- We lie and say the thing is imported; otherwise, we get into
 792     -- a mess with dependency analysis; e.g., core2stg may heave in
 793     -- random calls to GHCbase.unpackPS__.  If GHCbase is the module
 794     -- being compiled, then it's just a matter of luck if the definition
 795     -- will be in "the right place" to be in scope.
 796
 797 pc_bottoming_Id key mod name ty
 798  = pcMiscPrelId key mod name ty bottoming_info
 799  where
 800     bottoming_info = noCafIdInfo
 801                      `setStrictnessInfo` mkStrictnessInfo ([wwStrict], True)
 802
 803         -- these "bottom" out, no matter what their arguments
 804
 805 generic_ERROR_ID u n = pc_bottoming_Id u pREL_ERR n errorTy
 806
 807 -- Very useful...
 808 noCafIdInfo = constantIdInfo `setCafInfo` NoCafRefs
 809
 810 (openAlphaTyVar:openBetaTyVar:_) = openAlphaTyVars
 811 openAlphaTy  = mkTyVarTy openAlphaTyVar
 812 openBetaTy   = mkTyVarTy openBetaTyVar
 813
 814 errorTy  :: Type
 815 errorTy  = mkSigmaTy [openAlphaTyVar] [] (mkFunTys [mkListTy charTy]
 816                                                    openAlphaTy)
 817     -- Notice the openAlphaTyVar.  It says that "error" can be applied
 818     -- to unboxed as well as boxed types.  This is OK because it never
 819     -- returns, so the return type is irrelevant.
 820 \end{code}
 821