MkId.hs 54.6 KB
Newer Older
Austin Seipp's avatar
Austin Seipp committed
1 2 3 4
{-
(c) The University of Glasgow 2006
(c) The AQUA Project, Glasgow University, 1998

5 6 7 8

This module contains definitions for the IdInfo for things that
have a standard form, namely:

Thomas Schilling's avatar
Thomas Schilling committed
9 10 11 12
- data constructors
- record selectors
- method and superclass selectors
- primitive operations
Austin Seipp's avatar
Austin Seipp committed
13
-}
14

15
{-# LANGUAGE CPP #-}
Ian Lynagh's avatar
Ian Lynagh committed
16

17
module MkId (
18
        mkDictFunId, mkDictFunTy, mkDictSelId, mkDictSelRhs,
19

20
        mkPrimOpId, mkFCallId,
21

22
        wrapNewTypeBody, unwrapNewTypeBody,
23
        wrapFamInstBody, unwrapFamInstScrut,
24 25
        wrapTypeFamInstBody, wrapTypeUnbranchedFamInstBody, unwrapTypeFamInstScrut,
        unwrapTypeUnbranchedFamInstScrut,
26 27

        DataConBoxer(..), mkDataConRep, mkDataConWorkId,
28

Ian Lynagh's avatar
Ian Lynagh committed
29 30
        -- And some particular Ids; see below for why they are wired in
        wiredInIds, ghcPrimIds,
31 32 33
        unsafeCoerceName, unsafeCoerceId, realWorldPrimId,
        voidPrimId, voidArgId,
        nullAddrId, seqId, lazyId, lazyIdKey,
34
        coercionTokenId, magicDictId, coerceId,
35
        proxyHashId,
36

37 38
        -- Re-export error Ids
        module PrelRules
39 40 41 42
    ) where

#include "HsVersions.h"

Simon Marlow's avatar
Simon Marlow committed
43 44
import Rules
import TysPrim
45
import TysWiredIn
Simon Marlow's avatar
Simon Marlow committed
46 47
import PrelRules
import Type
48 49
import FamInstEnv
import Coercion
Simon Marlow's avatar
Simon Marlow committed
50
import TcType
51
import MkCore
52
import CoreUtils        ( exprType, mkCast )
Simon Marlow's avatar
Simon Marlow committed
53 54 55
import CoreUnfold
import Literal
import TyCon
56
import CoAxiom
Simon Marlow's avatar
Simon Marlow committed
57
import Class
58
import NameSet
Simon Marlow's avatar
Simon Marlow committed
59 60 61 62 63 64 65
import VarSet
import Name
import PrimOp
import ForeignCall
import DataCon
import Id
import IdInfo
66
import Demand
67
import CoreSyn
Simon Marlow's avatar
Simon Marlow committed
68
import Unique
69
import UniqSupply
70
import PrelNames
Simon Marlow's avatar
Simon Marlow committed
71 72
import BasicTypes       hiding ( SuccessFlag(..) )
import Util
73
import Pair
Ian Lynagh's avatar
Ian Lynagh committed
74
import DynFlags
75
import Outputable
76
import FastString
Simon Marlow's avatar
Simon Marlow committed
77
import ListSetOps
78 79

import Data.Maybe       ( maybeToList )
80

Austin Seipp's avatar
Austin Seipp committed
81 82 83
{-
************************************************************************
*                                                                      *
84
\subsection{Wired in Ids}
Austin Seipp's avatar
Austin Seipp committed
85 86
*                                                                      *
************************************************************************
87

88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
Note [Wired-in Ids]
~~~~~~~~~~~~~~~~~~~
There are several reasons why an Id might appear in the wiredInIds:

(1) The ghcPrimIds are wired in because they can't be defined in
    Haskell at all, although the can be defined in Core.  They have
    compulsory unfoldings, so they are always inlined and they  have
    no definition site.  Their home module is GHC.Prim, so they
    also have a description in primops.txt.pp, where they are called
    'pseudoops'.

(2) The 'error' function, eRROR_ID, is wired in because we don't yet have
    a way to express in an interface file that the result type variable
    is 'open'; that is can be unified with an unboxed type

    [The interface file format now carry such information, but there's
104 105
    no way yet of expressing at the definition site for these
    error-reporting functions that they have an 'open'
106 107 108 109 110 111 112 113 114 115
    result type. -- sof 1/99]

(3) Other error functions (rUNTIME_ERROR_ID) are wired in (a) because
    the desugarer generates code that mentiones them directly, and
    (b) for the same reason as eRROR_ID

(4) lazyId is wired in because the wired-in version overrides the
    strictness of the version defined in GHC.Base

In cases (2-4), the function has a definition in a library module, and
116
can be called; but the wired-in version means that the details are
117 118
never read from that module's interface file; instead, the full definition
is right here.
Austin Seipp's avatar
Austin Seipp committed
119
-}
120

121
wiredInIds :: [Id]
122
wiredInIds
Joachim Breitner's avatar
Joachim Breitner committed
123
  =  [lazyId, dollarId, oneShotId]
124
  ++ errorIds           -- Defined in MkCore
125
  ++ ghcPrimIds
126 127

-- These Ids are exported from GHC.Prim
128
ghcPrimIds :: [Id]
129
ghcPrimIds
Ian Lynagh's avatar
Ian Lynagh committed
130 131
  = [   -- These can't be defined in Haskell, but they have
        -- perfectly reasonable unfoldings in Core
132
    realWorldPrimId,
133
    voidPrimId,
134 135
    unsafeCoerceId,
    nullAddrId,
136
    seqId,
137
    magicDictId,
138 139
    coerceId,
    proxyHashId
140 141
    ]

Austin Seipp's avatar
Austin Seipp committed
142 143 144
{-
************************************************************************
*                                                                      *
145
\subsection{Data constructors}
Austin Seipp's avatar
Austin Seipp committed
146 147
*                                                                      *
************************************************************************
148

149 150 151 152
The wrapper for a constructor is an ordinary top-level binding that evaluates
any strict args, unboxes any args that are going to be flattened, and calls
the worker.

153 154
We're going to build a constructor that looks like:

Ian Lynagh's avatar
Ian Lynagh committed
155
        data (Data a, C b) =>  T a b = T1 !a !Int b
156

157
        T1 = /\ a b ->
Ian Lynagh's avatar
Ian Lynagh committed
158 159 160 161
             \d1::Data a, d2::C b ->
             \p q r -> case p of { p ->
                       case q of { q ->
                       Con T1 [a,b] [p,q,r]}}
162 163 164 165 166 167 168 169 170 171

Notice that

* d2 is thrown away --- a context in a data decl is used to make sure
  one *could* construct dictionaries at the site the constructor
  is used, but the dictionary isn't actually used.

* We have to check that we can construct Data dictionaries for
  the types a and Int.  Once we've done that we can throw d1 away too.

172
* We use (case p of q -> ...) to evaluate p, rather than "seq" because
173
  all that matters is that the arguments are evaluated.  "seq" is
174 175 176
  very careful to preserve evaluation order, which we don't need
  to be here.

177 178 179 180 181 182 183 184 185
  You might think that we could simply give constructors some strictness
  info, like PrimOps, and let CoreToStg do the let-to-case transformation.
  But we don't do that because in the case of primops and functions strictness
  is a *property* not a *requirement*.  In the case of constructors we need to
  do something active to evaluate the argument.

  Making an explicit case expression allows the simplifier to eliminate
  it in the (common) case where the constructor arg is already evaluated.

186 187
Note [Wrappers for data instance tycons]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
188 189
In the case of data instances, the wrapper also applies the coercion turning
the representation type into the family instance type to cast the result of
190 191 192 193 194
the wrapper.  For example, consider the declarations

  data family Map k :: * -> *
  data instance Map (a, b) v = MapPair (Map a (Pair b v))

195 196 197 198 199 200 201
The tycon to which the datacon MapPair belongs gets a unique internal
name of the form :R123Map, and we call it the representation tycon.
In contrast, Map is the family tycon (accessible via
tyConFamInst_maybe). A coercion allows you to move between
representation and family type.  It is accessible from :R123Map via
tyConFamilyCoercion_maybe and has kind

202
  Co123Map a b v :: {Map (a, b) v ~ :R123Map a b v}
203 204

The wrapper and worker of MapPair get the types
205

Ian Lynagh's avatar
Ian Lynagh committed
206
        -- Wrapper
207
  $WMapPair :: forall a b v. Map a (Map a b v) -> Map (a, b) v
208
  $WMapPair a b v = MapPair a b v `cast` sym (Co123Map a b v)
209

Ian Lynagh's avatar
Ian Lynagh committed
210
        -- Worker
211
  MapPair :: forall a b v. Map a (Map a b v) -> :R123Map a b v
212

213
This coercion is conditionally applied by wrapFamInstBody.
214

215
It's a bit more complicated if the data instance is a GADT as well!
216

217
   data instance T [a] where
Ian Lynagh's avatar
Ian Lynagh committed
218
        T1 :: forall b. b -> T [Maybe b]
219

simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
220
Hence we translate to
221

Ian Lynagh's avatar
Ian Lynagh committed
222
        -- Wrapper
223
  $WT1 :: forall b. b -> T [Maybe b]
224
  $WT1 b v = T1 (Maybe b) b (Maybe b) v
Ian Lynagh's avatar
Ian Lynagh committed
225
                        `cast` sym (Co7T (Maybe b))
226

Ian Lynagh's avatar
Ian Lynagh committed
227
        -- Worker
228
  T1 :: forall c b. (c ~ Maybe b) => b -> :R7T c
229

simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
230 231 232
        -- Coercion from family type to representation type
  Co7T a :: T [a] ~ :R7T a

233 234 235 236 237 238 239 240 241 242 243
Note [Newtype datacons]
~~~~~~~~~~~~~~~~~~~~~~~
The "data constructor" for a newtype should always be vanilla.  At one
point this wasn't true, because the newtype arising from
     class C a => D a
looked like
       newtype T:D a = D:D (C a)
so the data constructor for T:C had a single argument, namely the
predicate (C a).  But now we treat that as an ordinary argument, not
part of the theta-type, so all is well.

244

Austin Seipp's avatar
Austin Seipp committed
245 246
************************************************************************
*                                                                      *
247
\subsection{Dictionary selectors}
Austin Seipp's avatar
Austin Seipp committed
248 249
*                                                                      *
************************************************************************
250

251
Selecting a field for a dictionary.  If there is just one field, then
252
there's nothing to do.
253

254
Dictionary selectors may get nested forall-types.  Thus:
255

256 257
        class Foo a where
          op :: forall b. Ord b => a -> b -> b
258

259
Then the top-level type for op is
260

261 262
        op :: forall a. Foo a =>
              forall b. Ord b =>
263
              a -> b -> b
264

265 266 267
This is unlike ordinary record selectors, which have all the for-alls
at the outside.  When dealing with classes it's very convenient to
recover the original type signature from the class op selector.
Austin Seipp's avatar
Austin Seipp committed
268
-}
269

270 271
mkDictSelId :: Name          -- Name of one of the *value* selectors
                             -- (dictionary superclass or method)
272
            -> Class -> Id
273
mkDictSelId name clas
274 275
  = mkGlobalId (ClassOpId clas) name sel_ty info
  where
276
    tycon          = classTyCon clas
277
    sel_names      = map idName (classAllSelIds clas)
278 279 280 281
    new_tycon      = isNewTyCon tycon
    [data_con]     = tyConDataCons tycon
    tyvars         = dataConUnivTyVars data_con
    arg_tys        = dataConRepArgTys data_con  -- Includes the dictionary superclasses
282 283 284 285
    val_index      = assoc "MkId.mkDictSelId" (sel_names `zip` [0..]) name

    sel_ty = mkForAllTys tyvars (mkFunTy (mkClassPred clas (mkTyVarTys tyvars))
                                         (getNth arg_tys val_index))
286

287
    base_info = noCafIdInfo
288 289
                `setArityInfo`         1
                `setStrictnessInfo`    strict_sig
290 291 292 293

    info | new_tycon
         = base_info `setInlinePragInfo` alwaysInlinePragma
                     `setUnfoldingInfo`  mkInlineUnfolding (Just 1) (mkDictSelRhs clas val_index)
294 295
                   -- See Note [Single-method classes] in TcInstDcls
                   -- for why alwaysInlinePragma
296 297 298

         | otherwise
         = base_info `setSpecInfo` mkSpecInfo [rule]
299 300 301
                   -- Add a magic BuiltinRule, but no unfolding
                   -- so that the rule is always available to fire.
                   -- See Note [ClassOp/DFun selection] in TcInstDcls
302

303 304 305
    n_ty_args = length tyvars

    -- This is the built-in rule that goes
306 307 308
    --      op (dfT d1 d2) --->  opT d1 d2
    rule = BuiltinRule { ru_name = fsLit "Class op " `appendFS`
                                     occNameFS (getOccName name)
309
                       , ru_fn    = name
310
                       , ru_nargs = n_ty_args + 1
311
                       , ru_try   = dictSelRule val_index n_ty_args }
312

313 314 315 316
        -- The strictness signature is of the form U(AAAVAAAA) -> T
        -- where the V depends on which item we are selecting
        -- It's worth giving one, so that absence info etc is generated
        -- even if the selector isn't inlined
317

318
    strict_sig = mkClosedStrictSig [arg_dmd] topRes
319
    arg_dmd | new_tycon = evalDmd
320
            | otherwise = mkManyUsedDmd $
321 322 323 324 325 326 327 328 329
                          mkProdDmd [ if name == sel_name then evalDmd else absDmd
                                    | sel_name <- sel_names ]

mkDictSelRhs :: Class
             -> Int         -- 0-indexed selector among (superclasses ++ methods)
             -> CoreExpr
mkDictSelRhs clas val_index
  = mkLams tyvars (Lam dict_id rhs_body)
  where
330 331 332 333 334
    tycon          = classTyCon clas
    new_tycon      = isNewTyCon tycon
    [data_con]     = tyConDataCons tycon
    tyvars         = dataConUnivTyVars data_con
    arg_tys        = dataConRepArgTys data_con  -- Includes the dictionary superclasses
335

336
    the_arg_id     = getNth arg_ids val_index
337 338 339
    pred           = mkClassPred clas (mkTyVarTys tyvars)
    dict_id        = mkTemplateLocal 1 pred
    arg_ids        = mkTemplateLocalsNum 2 arg_tys
340

341 342
    rhs_body | new_tycon = unwrapNewTypeBody tycon (map mkTyVarTy tyvars) (Var dict_id)
             | otherwise = Case (Var dict_id) dict_id (idType the_arg_id)
Simon Peyton Jones's avatar
Simon Peyton Jones committed
343
                                [(DataAlt data_con, arg_ids, varToCoreExpr the_arg_id)]
344 345
                                -- varToCoreExpr needed for equality superclass selectors
                                --   sel a b d = case x of { MkC _ (g:a~b) _ -> CO g }
346

347
dictSelRule :: Int -> Arity -> RuleFun
348 349 350
-- Tries to persuade the argument to look like a constructor
-- application, using exprIsConApp_maybe, and then selects
-- from it
351
--       sel_i t1..tk (D t1..tk op1 ... opm) = opi
352
--
353
dictSelRule val_index n_ty_args _ id_unf _ args
354
  | (dict_arg : _) <- drop n_ty_args args
355
  , Just (_, _, con_args) <- exprIsConApp_maybe id_unf dict_arg
356
  = Just (getNth con_args val_index)
357 358
  | otherwise
  = Nothing
359

Austin Seipp's avatar
Austin Seipp committed
360 361 362
{-
************************************************************************
*                                                                      *
Simon Peyton Jones's avatar
Simon Peyton Jones committed
363
        Data constructors
Austin Seipp's avatar
Austin Seipp committed
364 365 366
*                                                                      *
************************************************************************
-}
367 368 369 370 371 372 373 374

mkDataConWorkId :: Name -> DataCon -> Id
mkDataConWorkId wkr_name data_con
  | isNewTyCon tycon
  = mkGlobalId (DataConWrapId data_con) wkr_name nt_wrap_ty nt_work_info
  | otherwise
  = mkGlobalId (DataConWorkId data_con) wkr_name alg_wkr_ty wkr_info

375
  where
376 377 378 379 380 381 382
    tycon = dataConTyCon data_con

        ----------- Workers for data types --------------
    alg_wkr_ty = dataConRepType data_con
    wkr_arity = dataConRepArity data_con
    wkr_info  = noCafIdInfo
                `setArityInfo`       wkr_arity
383
                `setStrictnessInfo`  wkr_sig
384 385 386
                `setUnfoldingInfo`   evaldUnfolding  -- Record that it's evaluated,
                                                     -- even if arity = 0

387
    wkr_sig = mkClosedStrictSig (replicate wkr_arity topDmd) (dataConCPR data_con)
388 389 390 391 392 393 394 395 396 397 398
        --      Note [Data-con worker strictness]
        -- Notice that we do *not* say the worker is strict
        -- even if the data constructor is declared strict
        --      e.g.    data T = MkT !(Int,Int)
        -- Why?  Because the *wrapper* is strict (and its unfolding has case
        -- expresssions that do the evals) but the *worker* itself is not.
        -- If we pretend it is strict then when we see
        --      case x of y -> $wMkT y
        -- the simplifier thinks that y is "sure to be evaluated" (because
        --  $wMkT is strict) and drops the case.  No, $wMkT is not strict.
        --
399
        -- When the simplifer sees a pattern
400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
        --      case e of MkT x -> ...
        -- it uses the dataConRepStrictness of MkT to mark x as evaluated;
        -- but that's fine... dataConRepStrictness comes from the data con
        -- not from the worker Id.

        ----------- Workers for newtypes --------------
    (nt_tvs, _, nt_arg_tys, _) = dataConSig data_con
    res_ty_args  = mkTyVarTys nt_tvs
    nt_wrap_ty   = dataConUserType data_con
    nt_work_info = noCafIdInfo          -- The NoCaf-ness is set by noCafIdInfo
                  `setArityInfo` 1      -- Arity 1
                  `setInlinePragInfo`    alwaysInlinePragma
                  `setUnfoldingInfo`     newtype_unf
    id_arg1      = mkTemplateLocal 1 (head nt_arg_tys)
    newtype_unf  = ASSERT2( isVanillaDataCon data_con &&
                            isSingleton nt_arg_tys, ppr data_con  )
416 417 418
                              -- Note [Newtype datacons]
                   mkCompulsoryUnfolding $
                   mkLams nt_tvs $ Lam id_arg1 $
419
                   wrapNewTypeBody tycon res_ty_args (Var id_arg1)
420

421 422
dataConCPR :: DataCon -> DmdResult
dataConCPR con
423
  | isDataTyCon tycon     -- Real data types only; that is,
424
                          -- not unboxed tuples or newtypes
425
  , null (dataConExTyVars con)  -- No existentials
426 427
  , wkr_arity > 0
  , wkr_arity <= mAX_CPR_SIZE
428 429
  = if is_prod then vanillaCprProdRes (dataConRepArity con)
               else cprSumRes (dataConTag con)
430
  | otherwise
431
  = topRes
432
  where
433 434
    is_prod   = isProductTyCon tycon
    tycon     = dataConTyCon con
435 436 437 438 439
    wkr_arity = dataConRepArity con

    mAX_CPR_SIZE :: Arity
    mAX_CPR_SIZE = 10
    -- We do not treat very big tuples as CPR-ish:
440 441 442
    --      a) for a start we get into trouble because there aren't
    --         "enough" unboxed tuple types (a tiresome restriction,
    --         but hard to fix),
443 444 445 446
    --      b) more importantly, big unboxed tuples get returned mainly
    --         on the stack, and are often then allocated in the heap
    --         by the caller.  So doing CPR for them may in fact make
    --         things worse.
447

Austin Seipp's avatar
Austin Seipp committed
448
{-
449 450
-------------------------------------------------
--         Data constructor representation
451 452
--
-- This is where we decide how to wrap/unwrap the
453 454 455
-- constructor fields
--
--------------------------------------------------
Austin Seipp's avatar
Austin Seipp committed
456
-}
457 458 459 460 461 462 463 464 465 466 467 468 469

type Unboxer = Var -> UniqSM ([Var], CoreExpr -> CoreExpr)
  -- Unbox: bind rep vars by decomposing src var

data Boxer = UnitBox | Boxer (TvSubst -> UniqSM ([Var], CoreExpr))
  -- Box:   build src arg using these rep vars

newtype DataConBoxer = DCB ([Type] -> [Var] -> UniqSM ([Var], [CoreBind]))
                       -- Bind these src-level vars, returning the
                       -- rep-level vars to bind in the pattern

mkDataConRep :: DynFlags -> FamInstEnvs -> Name -> DataCon -> UniqSM DataConRep
mkDataConRep dflags fam_envs wrap_name data_con
470 471
  | not wrapper_reqd
  = return NoDataConRep
472

473
  | otherwise
474
  = do { wrap_args <- mapM newLocal wrap_arg_tys
475
       ; wrap_body <- mk_rep_app (wrap_args `zip` dropList eq_spec unboxers)
476 477 478 479
                                 initial_wrap_app

       ; let wrap_id = mkGlobalId (DataConWrapId data_con) wrap_name wrap_ty wrap_info
             wrap_info = noCafIdInfo
480 481 482 483 484 485 486 487 488 489 490 491 492
                         `setArityInfo`         wrap_arity
                             -- It's important to specify the arity, so that partial
                             -- applications are treated as values
                         `setInlinePragInfo`    alwaysInlinePragma
                         `setUnfoldingInfo`     wrap_unf
                         `setStrictnessInfo`    wrap_sig
                             -- We need to get the CAF info right here because TidyPgm
                             -- does not tidy the IdInfo of implicit bindings (like the wrapper)
                             -- so it not make sure that the CAF info is sane

             wrap_sig = mkClosedStrictSig wrap_arg_dmds (dataConCPR data_con)
             wrap_arg_dmds = map mk_dmd (dropList eq_spec wrap_bangs)
             mk_dmd str | isBanged str = evalDmd
493
                        | otherwise           = topDmd
494 495 496 497 498 499 500 501 502 503
                 -- The Cpr info can be important inside INLINE rhss, where the
                 -- wrapper constructor isn't inlined.
                 -- And the argument strictness can be important too; we
                 -- may not inline a contructor when it is partially applied.
                 -- For example:
                 --      data W = C !Int !Int !Int
                 --      ...(let w = C x in ...(w p q)...)...
                 -- we want to see that w is strict in its two arguments

             wrap_unf = mkInlineUnfolding (Just wrap_arity) wrap_rhs
504
             wrap_tvs = (univ_tvs `minusList` map fst eq_spec) ++ ex_tvs
505 506 507
             wrap_rhs = mkLams wrap_tvs $
                        mkLams wrap_args $
                        wrapFamInstBody tycon res_ty_args $
508 509 510 511 512 513 514
                        wrap_body

       ; return (DCR { dcr_wrap_id = wrap_id
                     , dcr_boxer   = mk_boxer boxers
                     , dcr_arg_tys = rep_tys
                     , dcr_stricts = rep_strs
                     , dcr_bangs   = dropList ev_tys wrap_bangs }) }
515

516
  where
517 518 519 520 521 522
    (univ_tvs, ex_tvs, eq_spec, theta, orig_arg_tys, _) = dataConFullSig data_con
    res_ty_args  = substTyVars (mkTopTvSubst eq_spec) univ_tvs
    tycon        = dataConTyCon data_con       -- The representation TyCon (not family)
    wrap_ty      = dataConUserType data_con
    ev_tys       = eqSpecPreds eq_spec ++ theta
    all_arg_tys  = ev_tys                         ++ orig_arg_tys
Simon Peyton Jones's avatar
Simon Peyton Jones committed
523
    orig_bangs   = map mk_pred_strict_mark ev_tys ++ dataConSrcBangs data_con
524 525 526

    wrap_arg_tys = theta ++ orig_arg_tys
    wrap_arity   = length wrap_arg_tys
527 528 529
             -- The wrap_args are the arguments *other than* the eq_spec
             -- Because we are going to apply the eq_spec args manually in the
             -- wrapper
530

531 532 533
    (wrap_bangs, rep_tys_w_strs, wrappers)
       = unzip3 (zipWith (dataConArgRep dflags fam_envs) all_arg_tys orig_bangs)
    (unboxers, boxers) = unzip wrappers
534 535 536
    (rep_tys, rep_strs) = unzip (concat rep_tys_w_strs)

    wrapper_reqd = not (isNewTyCon tycon)  -- Newtypes have only a worker
537 538 539
                && (any isBanged wrap_bangs -- Some forcing/unboxing
                                            -- (includes eq_spec)
                    || isFamInstTyCon tycon) -- Cast result
540 541 542

    initial_wrap_app = Var (dataConWorkId data_con)
                      `mkTyApps`  res_ty_args
543 544 545 546
                      `mkVarApps` ex_tvs
                      `mkCoApps`  map (mkReflCo Nominal . snd) eq_spec
                        -- Dont box the eq_spec coercions since they are
                        -- marked as HsUnpack by mk_dict_strict_mark
547 548

    mk_boxer :: [Boxer] -> DataConBoxer
549
    mk_boxer boxers = DCB (\ ty_args src_vars ->
550 551
                      do { let ex_vars = takeList ex_tvs src_vars
                               subst1 = mkTopTvSubst (univ_tvs `zip` ty_args)
552
                               subst2 = extendTvSubstList subst1 ex_tvs
553 554 555 556 557 558 559 560 561 562 563 564 565 566 567
                                                          (mkTyVarTys ex_vars)
                         ; (rep_ids, binds) <- go subst2 boxers (dropList ex_tvs src_vars)
                         ; return (ex_vars ++ rep_ids, binds) } )

    go _ [] src_vars = ASSERT2( null src_vars, ppr data_con ) return ([], [])
    go subst (UnitBox : boxers) (src_var : src_vars)
      = do { (rep_ids2, binds) <- go subst boxers src_vars
           ; return (src_var : rep_ids2, binds) }
    go subst (Boxer boxer : boxers) (src_var : src_vars)
      = do { (rep_ids1, arg)  <- boxer subst
           ; (rep_ids2, binds) <- go subst boxers src_vars
           ; return (rep_ids1 ++ rep_ids2, NonRec src_var arg : binds) }
    go _ (_:_) [] = pprPanic "mk_boxer" (ppr data_con)

    mk_rep_app :: [(Id,Unboxer)] -> CoreExpr -> UniqSM CoreExpr
568
    mk_rep_app [] con_app
569
      = return con_app
570
    mk_rep_app ((wrap_arg, unboxer) : prs) con_app
571 572 573 574 575 576
      = do { (rep_ids, unbox_fn) <- unboxer wrap_arg
           ; expr <- mk_rep_app prs (mkVarApps con_app rep_ids)
           ; return (unbox_fn expr) }

-------------------------
newLocal :: Type -> UniqSM Var
577
newLocal ty = do { uniq <- getUniqueM
578 579 580 581
                 ; return (mkSysLocal (fsLit "dt") uniq ty) }

-------------------------
dataConArgRep
582
   :: DynFlags
583
   -> FamInstEnvs
Simon Peyton Jones's avatar
Simon Peyton Jones committed
584
   -> Type
Simon Peyton Jones's avatar
Simon Peyton Jones committed
585 586 587 588 589 590 591
   -> HsSrcBang     -- For DataCons defined in this module, this is the
                    --    bang/unpack annotation that the programmer wrote
                    -- For DataCons imported from an interface file, this
                    --    is the HsImplBang implementation decision taken
                    --    by the compiler in the defining module; just follow
                    --    it slavishly, so that we make the same decision as
                    --    in the defining module
Simon Peyton Jones's avatar
Simon Peyton Jones committed
592
   -> ( HsImplBang                 -- Implementation decision about unpack strategy
593
      , [(Type, StrictnessMark)]   -- Rep types
594 595
      , (Unboxer, Boxer) )

596 597 598
dataConArgRep dflags fam_envs arg_ty (HsSrcBang ann unpk NoSrcStrictness)
  | xopt Opt_StrictData dflags -- StrictData => strict field
  = dataConArgRep dflags fam_envs arg_ty (HsSrcBang ann unpk SrcStrict)
599

600 601 602 603 604
  | otherwise                  -- no StrictData => lazy field
  = (HsLazy, [(arg_ty, NotMarkedStrict)], (unitUnboxer, unitBoxer))

dataConArgRep _ _ arg_ty (HsSrcBang _ _ SrcLazy)
  = (HsLazy, [(arg_ty, NotMarkedStrict)], (unitUnboxer, unitBoxer))
605

606
dataConArgRep dflags fam_envs arg_ty
607
    (HsSrcBang _ unpk_prag SrcStrict)
608
  | not (gopt Opt_OmitInterfacePragmas dflags) -- Don't unpack if -fomit-iface-pragmas
609
          -- Don't unpack if we aren't optimising; rather arbitrarily,
610
          -- we use -fomit-iface-pragmas as the indication
611
  , let mb_co   = topNormaliseType_maybe fam_envs arg_ty
612
                     -- Unwrap type families and newtypes
613
        arg_ty' = case mb_co of { Just (_,ty) -> ty; Nothing -> arg_ty }
614
  , isUnpackableType dflags fam_envs arg_ty'
615
  , (rep_tys, wrappers) <- dataConArgUnpack arg_ty'
616
  , case unpk_prag of
617 618 619 620 621
      NoSrcUnpack ->
        gopt Opt_UnboxStrictFields dflags
            || (gopt Opt_UnboxSmallStrictFields dflags
                && length rep_tys <= 1) -- See Note [Unpack one-wide fields]
      srcUnpack -> isSrcUnpacked srcUnpack
622 623 624
  = case mb_co of
      Nothing          -> (HsUnpack Nothing,   rep_tys, wrappers)
      Just (co,rep_ty) -> (HsUnpack (Just co), rep_tys, wrapCo co rep_ty wrappers)
625

626
  | otherwise -- Record the strict-but-no-unpack decision
627 628
  = strict_but_not_unpacked arg_ty

629 630 631
dataConArgRep _ _ arg_ty HsLazy
  = (HsLazy, [(arg_ty, NotMarkedStrict)], (unitUnboxer, unitBoxer))

632 633
dataConArgRep _ _ arg_ty HsStrict
  = strict_but_not_unpacked arg_ty
634

635 636 637
dataConArgRep _ _ arg_ty (HsUnpack Nothing)
  | (rep_tys, wrappers) <- dataConArgUnpack arg_ty
  = (HsUnpack Nothing, rep_tys, wrappers)
638

639 640 641 642
dataConArgRep _ _ _ (HsUnpack (Just co))
  | let co_rep_ty = pSnd (coercionKind co)
  , (rep_tys, wrappers) <- dataConArgUnpack co_rep_ty
  = (HsUnpack (Just co), rep_tys, wrapCo co co_rep_ty wrappers)
643

Simon Peyton Jones's avatar
Simon Peyton Jones committed
644
strict_but_not_unpacked :: Type -> (HsImplBang, [(Type,StrictnessMark)], (Unboxer, Boxer))
645
strict_but_not_unpacked arg_ty
646
  = (HsStrict, [(arg_ty, MarkedStrict)], (seqUnboxer, unitBoxer))
647 648

-------------------------
649 650 651 652 653 654 655 656
wrapCo :: Coercion -> Type -> (Unboxer, Boxer) -> (Unboxer, Boxer)
wrapCo co rep_ty (unbox_rep, box_rep)  -- co :: arg_ty ~ rep_ty
  = (unboxer, boxer)
  where
    unboxer arg_id = do { rep_id <- newLocal rep_ty
                        ; (rep_ids, rep_fn) <- unbox_rep rep_id
                        ; let co_bind = NonRec rep_id (Var arg_id `Cast` co)
                        ; return (rep_ids, Let co_bind . rep_fn) }
657 658
    boxer = Boxer $ \ subst ->
            do { (rep_ids, rep_expr)
659 660 661 662 663 664 665 666
                    <- case box_rep of
                         UnitBox -> do { rep_id <- newLocal (TcType.substTy subst rep_ty)
                                       ; return ([rep_id], Var rep_id) }
                         Boxer boxer -> boxer subst
               ; let sco = substCo (tvCvSubst subst) co
               ; return (rep_ids, rep_expr `Cast` mkSymCo sco) }

------------------------
667 668 669 670 671 672 673 674 675 676 677 678
seqUnboxer :: Unboxer
seqUnboxer v = return ([v], \e -> Case (Var v) v (exprType e) [(DEFAULT, [], e)])

unitUnboxer :: Unboxer
unitUnboxer v = return ([v], \e -> e)

unitBoxer :: Boxer
unitBoxer = UnitBox

-------------------------
dataConArgUnpack
   :: Type
679 680
   ->  ( [(Type, StrictnessMark)]   -- Rep types
       , (Unboxer, Boxer) )
681 682

dataConArgUnpack arg_ty
683
  | Just (tc, tc_args) <- splitTyConApp_maybe arg_ty
684 685
  , Just con <- tyConSingleAlgDataCon_maybe tc
      -- NB: check for an *algebraic* data type
686
      -- A recursive newtype might mean that
687
      -- 'arg_ty' is a newtype
688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705
  , let rep_tys = dataConInstArgTys con tc_args
  = ASSERT( isVanillaDataCon con )
    ( rep_tys `zip` dataConRepStrictness con
    ,( \ arg_id ->
       do { rep_ids <- mapM newLocal rep_tys
          ; let unbox_fn body
                  = Case (Var arg_id) arg_id (exprType body)
                         [(DataAlt con, rep_ids, body)]
          ; return (rep_ids, unbox_fn) }
     , Boxer $ \ subst ->
       do { rep_ids <- mapM (newLocal . TcType.substTy subst) rep_tys
          ; return (rep_ids, Var (dataConWorkId con)
                             `mkTyApps` (substTys subst tc_args)
                             `mkVarApps` rep_ids ) } ) )
  | otherwise
  = pprPanic "dataConArgUnpack" (ppr arg_ty)
    -- An interface file specified Unpacked, but we couldn't unpack it

706
isUnpackableType :: DynFlags -> FamInstEnvs -> Type -> Bool
707
-- True if we can unpack the UNPACK the argument type
708 709 710 711
-- See Note [Recursive unboxing]
-- We look "deeply" inside rather than relying on the DataCons
-- we encounter on the way, because otherwise we might well
-- end up relying on ourselves!
712
isUnpackableType dflags fam_envs ty
713
  | Just (tc, _) <- splitTyConApp_maybe ty
714
  , Just con <- tyConSingleAlgDataCon_maybe tc
715 716 717 718
  , isVanillaDataCon con
  = ok_con_args (unitNameSet (getName tc)) con
  | otherwise
  = False
719
  where
720
    ok_arg tcs (ty, bang) = not (attempt_unpack bang) || ok_ty tcs norm_ty
721
        where
722
          norm_ty = topNormaliseType fam_envs ty
723 724 725 726
    ok_ty tcs ty
      | Just (tc, _) <- splitTyConApp_maybe ty
      , let tc_name = getName tc
      =  not (tc_name `elemNameSet` tcs)
727
      && case tyConSingleAlgDataCon_maybe tc of
728
            Just con | isVanillaDataCon con
729
                    -> ok_con_args (tcs `extendNameSet` getName tc) con
730
            _ -> True
731
      | otherwise
732 733 734
      = True

    ok_con_args tcs con
Simon Peyton Jones's avatar
Simon Peyton Jones committed
735 736 737
       = all (ok_arg tcs) (dataConOrigArgTys con `zip` dataConSrcBangs con)
         -- NB: dataConSrcBangs gives the *user* request;
         -- We'd get a black hole if we used dataConImplBangs
738

739 740 741 742 743 744 745 746 747 748 749 750 751 752 753
    attempt_unpack (HsUnpack {})
      = True
    attempt_unpack HsStrict
      = False
    attempt_unpack HsLazy
      = False
    attempt_unpack (HsSrcBang _ SrcUnpack NoSrcStrictness)
      = xopt Opt_StrictData dflags
    attempt_unpack (HsSrcBang _ SrcUnpack SrcStrict)
      = True
    attempt_unpack (HsSrcBang _  NoSrcUnpack SrcStrict)
      = True  -- Be conservative
    attempt_unpack (HsSrcBang _  NoSrcUnpack NoSrcStrictness)
      = xopt Opt_StrictData dflags -- Be conservative
    attempt_unpack _ = False
754

Austin Seipp's avatar
Austin Seipp committed
755
{-
756 757 758 759 760 761 762 763 764 765 766 767 768 769 770
Note [Unpack one-wide fields]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The flag UnboxSmallStrictFields ensures that any field that can
(safely) be unboxed to a word-sized unboxed field, should be so unboxed.
For example:

    data A = A Int#
    newtype B = B A
    data C = C !B
    data D = D !C
    data E = E !()
    data F = F !D
    data G = G !F !F

All of these should have an Int# as their representation, except
771
G which should have two Int#s.
772

773
However
774 775 776 777 778 779 780 781

    data T = T !(S Int)
    data S = S !a

Here we can represent T with an Int#.

Note [Recursive unboxing]
~~~~~~~~~~~~~~~~~~~~~~~~~
782
Consider
783 784 785
  data R = MkR {-# UNPACK #-} !S Int
  data S = MkS {-# UNPACK #-} !Int
The representation arguments of MkR are the *representation* arguments
786 787 788
of S (plus Int); the rep args of MkS are Int#.  This is all fine.

But be careful not to try to unbox this!
789
        data T = MkT {-# UNPACK #-} !T Int
790 791 792
Because then we'd get an infinite number of arguments.

Here is a more complicated case:
793 794
        data S = MkS {-# UNPACK #-} !T Int
        data T = MkT {-# UNPACK #-} !S Int
795 796 797 798
Each of S and T must decide independendently whether to unpack
and they had better not both say yes. So they must both say no.

Also behave conservatively when there is no UNPACK pragma
799
        data T = MkS !T Int
800 801
with -funbox-strict-fields or -funbox-small-strict-fields
we need to behave as if there was an UNPACK pragma there.
802 803

But it's the *argument* type that matters. This is fine:
804
        data S = MkS S !Int
805 806 807 808 809 810 811 812 813 814 815
because Int is non-recursive.


Note [Unpack equality predicates]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If we have a GADT with a contructor C :: (a~[b]) => b -> T a
we definitely want that equality predicate *unboxed* so that it
takes no space at all.  This is easily done: just give it
an UNPACK pragma. The rest of the unpack/repack code does the
heavy lifting.  This one line makes every GADT take a word less
space for each equality predicate, so it's pretty important!
Austin Seipp's avatar
Austin Seipp committed
816
-}
817

818
mk_pred_strict_mark :: PredType -> HsImplBang
819 820
mk_pred_strict_mark pred
  | isEqPred pred = HsUnpack Nothing    -- Note [Unpack equality predicates]
821
  | otherwise     = HsLazy
822

Austin Seipp's avatar
Austin Seipp committed
823 824 825
{-
************************************************************************
*                                                                      *
Ian Lynagh's avatar
Ian Lynagh committed
826
        Wrapping and unwrapping newtypes and type families
Austin Seipp's avatar
Austin Seipp committed
827 828 829
*                                                                      *
************************************************************************
-}
830

831 832
wrapNewTypeBody :: TyCon -> [Type] -> CoreExpr -> CoreExpr
-- The wrapper for the data constructor for a newtype looks like this:
Ian Lynagh's avatar
Ian Lynagh committed
833 834 835
--      newtype T a = MkT (a,Int)
--      MkT :: forall a. (a,Int) -> T a
--      MkT = /\a. \(x:(a,Int)). x `cast` sym (CoT a)
836 837 838 839
-- where CoT is the coercion TyCon assoicated with the newtype
--
-- The call (wrapNewTypeBody T [a] e) returns the
-- body of the wrapper, namely
Ian Lynagh's avatar
Ian Lynagh committed
840
--      e `cast` (CoT [a])
841
--
842
-- If a coercion constructor is provided in the newtype, then we use
843
-- it, otherwise the wrap/unwrap are both no-ops
844
--
845
-- If the we are dealing with a newtype *instance*, we have a second coercion
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
846 847 848
-- identifying the family instance with the constructor of the newtype
-- instance.  This coercion is applied in any case (ie, composed with the
-- coercion constructor of the newtype or applied by itself).
849

850
wrapNewTypeBody tycon args result_expr
851 852
  = ASSERT( isNewTyCon tycon )
    wrapFamInstBody tycon args $
853
    mkCast result_expr (mkSymCo co)
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
854
  where
855
    co = mkUnbranchedAxInstCo Representational (newTyConCo tycon) args
856

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
857 858 859 860
-- When unwrapping, we do *not* apply any family coercion, because this will
-- be done via a CoPat by the type checker.  We have to do it this way as
-- computing the right type arguments for the coercion requires more than just
-- a spliting operation (cf, TcPat.tcConPat).
861

862 863
unwrapNewTypeBody :: TyCon -> [Type] -> CoreExpr -> CoreExpr
unwrapNewTypeBody tycon args result_expr
864
  = ASSERT( isNewTyCon tycon )
865
    mkCast result_expr (mkUnbranchedAxInstCo Representational (newTyConCo tycon) args)
866

867 868 869 870 871 872 873 874
-- If the type constructor is a representation type of a data instance, wrap
-- the expression into a cast adjusting the expression type, which is an
-- instance of the representation type, to the corresponding instance of the
-- family instance type.
-- See Note [Wrappers for data instance tycons]
wrapFamInstBody :: TyCon -> [Type] -> CoreExpr -> CoreExpr
wrapFamInstBody tycon args body
  | Just co_con <- tyConFamilyCoercion_maybe tycon
875
  = mkCast body (mkSymCo (mkUnbranchedAxInstCo Representational co_con args))
876 877
  | otherwise
  = body
878

879 880
-- Same as `wrapFamInstBody`, but for type family instances, which are
-- represented by a `CoAxiom`, and not a `TyCon`
881 882
wrapTypeFamInstBody :: CoAxiom br -> Int -> [Type] -> CoreExpr -> CoreExpr
wrapTypeFamInstBody axiom ind args body
883
  = mkCast body (mkSymCo (mkAxInstCo Representational axiom ind args))
884 885 886 887

wrapTypeUnbranchedFamInstBody :: CoAxiom Unbranched -> [Type] -> CoreExpr -> CoreExpr
wrapTypeUnbranchedFamInstBody axiom
  = wrapTypeFamInstBody axiom 0
888

889 890 891
unwrapFamInstScrut :: TyCon -> [Type] -> CoreExpr -> CoreExpr
unwrapFamInstScrut tycon args scrut
  | Just co_con <- tyConFamilyCoercion_maybe tycon
892
  = mkCast scrut (mkUnbranchedAxInstCo Representational co_con args) -- data instances only
893 894
  | otherwise
  = scrut
895

896 897
unwrapTypeFamInstScrut :: CoAxiom br -> Int -> [Type] -> CoreExpr -> CoreExpr
unwrapTypeFamInstScrut axiom ind args scrut
898
  = mkCast scrut (mkAxInstCo Representational axiom ind args)
899 900 901 902

unwrapTypeUnbranchedFamInstScrut :: CoAxiom Unbranched -> [Type] -> CoreExpr -> CoreExpr
unwrapTypeUnbranchedFamInstScrut axiom
  = unwrapTypeFamInstScrut axiom 0
903

Austin Seipp's avatar
Austin Seipp committed
904 905 906
{-
************************************************************************
*                                                                      *
907
\subsection{Primitive operations}
Austin Seipp's avatar
Austin Seipp committed
908 909 910
*                                                                      *
************************************************************************
-}
911

912
mkPrimOpId :: PrimOp -> Id
913
mkPrimOpId prim_op