ClosureInfo.lhs 31.6 KB
Newer Older
1
%
2
% (c) The Univserity of Glasgow 1992-2004
3
%
4 5 6 7 8

	Data structures which describe closures, and
	operations over those data structures

		Nothing monadic in here
9 10 11 12 13 14 15

Much of the rationale for these things is in the ``details'' part of
the STG paper.

\begin{code}
module ClosureInfo (
	ClosureInfo, LambdaFormInfo, SMRep, 	-- all abstract
16
	StandardFormInfo, 
17

18 19
	ArgDescr(..), Liveness(..), 
	C_SRT(..), needsSRT,
20

21
	mkLFThunk, mkLFReEntrant, mkConLFInfo, mkSelectorLFInfo,
22
	mkApLFInfo, mkLFImported, mkLFArgument, mkLFLetNoEscape,
23

24 25
	mkClosureInfo, mkConInfo,

26
	closureSize, closureNonHdrSize,
27
	closureGoodStuffSize, closurePtrsSize,
28
	slopSize, 
29

30 31
	closureName, infoTableLabelFromCI,
	closureLabelFromCI, closureSRT,
32 33
	closureLFInfo, isLFThunk,closureSMRep, closureUpdReqd, 
	closureNeedsUpdSpace, closureIsThunk,
34 35
	closureSingleEntry, closureReEntrant, isConstrClosure_maybe,
	closureFunInfo,	isStandardFormThunk, isKnownFun,
36

37
	enterIdLabel, enterLocalIdLabel, enterReturnPtLabel,
38 39 40

	nodeMustPointToIt, 
	CallMethod(..), getCallMethod,
sof's avatar
sof committed
41

sof's avatar
sof committed
42
	blackHoleOnEntry,
43

44
	staticClosureRequired,
45
	getClosureType,
46

47
	isToplevClosure,
48
	closureValDescr, closureTypeDescr,	-- profiling
49

50
	isStaticClosure,
51
	cafBlackHoleClosureInfo, seCafBlackHoleClosureInfo,
52 53

	staticClosureNeedsLink,
54 55
    ) where

56
#include "../includes/MachDeps.h"
57
#include "HsVersions.h"
58

59
import StgSyn
60
import SMRep		-- all of it
61

62
import CLabel
63

64
import Constants	( mIN_PAYLOAD_SIZE )
65
import Packages		( isDllName, HomeModules )
66
import StaticFlags	( opt_SccProfilingOn, opt_OmitBlackHoling,
67
			  opt_Parallel, opt_DoTickyProfiling )
68
import Id		( Id, idType, idArity, idName )
69
import DataCon		( DataCon, dataConTyCon, isNullaryRepDataCon, dataConName )
70
import Name		( Name, nameUnique, getOccName, getOccString )
71
import OccName		( occNameString )
72
import Type		( isUnLiftedType, Type, repType, splitTyConApp_maybe )
73
import TcType		( tcSplitSigmaTy )
74
import TyCon		( isFunTyCon, isAbstractTyCon )
75
import BasicTypes	( TopLevelFlag(..), isNotTopLevel, isTopLevel, ipNameName )
76
import FastString
77
import Outputable
78
import Constants
79 80

import TypeRep	-- TEMP
81 82
\end{code}

83

84 85 86 87 88 89
%************************************************************************
%*									*
\subsection[ClosureInfo-datatypes]{Data types for closure information}
%*									*
%************************************************************************

90 91 92 93 94 95 96 97 98 99 100 101
Information about a closure, from the code generator's point of view.

A ClosureInfo decribes the info pointer of a closure.  It has
enough information 
  a) to construct the info table itself
  b) to allocate a closure containing that info pointer (i.e.
	it knows the info table label)

We make a ClosureInfo for
	- each let binding (both top level and not)
	- each data constructor (for its shared static and
		dynamic info tables)
102 103 104

\begin{code}
data ClosureInfo
105 106 107 108 109 110 111 112 113
  = ClosureInfo {
	closureName   :: !Name,		  -- The thing bound to this closure
	closureLFInfo :: !LambdaFormInfo, -- NOTE: not an LFCon (see below)
	closureSMRep  :: !SMRep,	  -- representation used by storage mgr
	closureSRT    :: !C_SRT,	  -- What SRT applies to this closure
	closureType   :: !Type,		  -- Type of closure (ToDo: remove)
	closureDescr  :: !String	  -- closure description (for profiling)
    }

114
  -- Constructor closures don't have a unique info table label (they use
115 116 117
  -- the constructor's info table), and they don't have an SRT.
  | ConInfo {
	closureCon       :: !DataCon,
118 119
	closureSMRep     :: !SMRep,
	closureDllCon	 :: !Bool	-- is in a separate DLL
120
    }
121 122 123 124 125 126 127 128 129 130

-- C_SRT is what StgSyn.SRT gets translated to... 
-- we add a label for the table, and expect only the 'offset/length' form

data C_SRT = NoC_SRT
	   | C_SRT !CLabel !WordOff !StgHalfWord {-bitmap or escape-}

needsSRT :: C_SRT -> Bool
needsSRT NoC_SRT       = False
needsSRT (C_SRT _ _ _) = True
131 132
\end{code}

133 134 135 136 137 138
%************************************************************************
%*									*
\subsubsection[LambdaFormInfo-datatype]{@LambdaFormInfo@: source-derivable info}
%*									*
%************************************************************************

139 140 141 142 143 144 145 146
Information about an identifier, from the code generator's point of
view.  Every identifier is bound to a LambdaFormInfo in the
environment, which gives the code generator enough info to be able to
tail call or return that identifier.

Note that a closure is usually bound to an identifier, so a
ClosureInfo contains a LambdaFormInfo.

147 148
\begin{code}
data LambdaFormInfo
149
  = LFReEntrant		-- Reentrant closure (a function)
150
	TopLevelFlag	-- True if top level
151
	!Int		-- Arity. Invariant: always > 0
152
	!Bool		-- True <=> no fvs
153
	ArgDescr	-- Argument descriptor (should reall be in ClosureInfo)
154

155
  | LFCon		-- A saturated constructor application
156
	DataCon		-- The constructor
157

158
  | LFThunk		-- Thunk (zero arity)
159 160
	TopLevelFlag
	!Bool		-- True <=> no free vars
161
	!Bool		-- True <=> updatable (i.e., *not* single-entry)
162
	StandardFormInfo
163
	!Bool		-- True <=> *might* be a function type
164

165 166 167
  | LFUnknown		-- Used for function arguments and imported things.
			--  We know nothing about  this closure.  Treat like
			-- updatable "LFThunk"...
168 169 170
			-- Imported things which we do know something about use
			-- one of the other LF constructors (eg LFReEntrant for
			-- known functions)
171
	!Bool		-- True <=> *might* be a function type
172 173 174

  | LFLetNoEscape	-- See LetNoEscape module for precise description of
			-- these "lets".
175
	!Int		-- arity;
176 177 178 179

  | LFBlackHole		-- Used for the closures allocated to hold the result
			-- of a CAF.  We want the target of the update frame to
			-- be in the heap, so we make a black hole to hold it.
180
        CLabel          -- Flavour (info label, eg CAF_BLACKHOLE_info).
181 182


183 184
-------------------------
-- An ArgDsecr describes the argument pattern of a function
185

186 187 188
data ArgDescr
  = ArgSpec		-- Fits one of the standard patterns
	!Int		-- RTS type identifier ARG_P, ARG_N, ...
189

190 191
  | ArgGen	 	-- General case
	Liveness	-- Details about the arguments
192

193

194 195 196 197 198 199 200 201
-------------------------
-- We represent liveness bitmaps as a Bitmap (whose internal
-- representation really is a bitmap).  These are pinned onto case return
-- vectors to indicate the state of the stack for the garbage collector.
-- 
-- In the compiled program, liveness bitmaps that fit inside a single
-- word (StgWord) are stored as a single word, while larger bitmaps are
-- stored as a pointer to an array of words. 
202

203 204 205 206 207 208
data Liveness
  = SmallLiveness	-- Liveness info that fits in one word
	StgWord		-- Here's the bitmap

  | BigLiveness		-- Liveness info witha a multi-word bitmap
	CLabel		-- Label for the bitmap
209 210


211 212 213
-------------------------
-- StandardFormInfo tells whether this thunk has one of 
-- a small number of standard forms
214

215 216 217
data StandardFormInfo
  = NonStandardThunk
	-- Not of of the standard forms
218

219 220 221 222 223 224 225 226
  | SelectorThunk
	-- A SelectorThunk is of form
	--      case x of
	--	       con a1,..,an -> ak
	-- and the constructor is from a single-constr type.
       WordOff             	-- 0-origin offset of ak within the "goods" of 
			-- constructor (Recall that the a1,...,an may be laid
			-- out in the heap in a non-obvious order.)
227

228 229 230 231 232 233 234
  | ApThunk 
	-- An ApThunk is of form
	--	x1 ... xn
	-- The code for the thunk just pushes x2..xn on the stack and enters x1.
	-- There are a few of these (for 1 <= n <= MAX_SPEC_AP_SIZE) pre-compiled
	-- in the RTS to save space.
	Int		-- Arity, n
235 236 237 238 239 240 241 242 243
\end{code}

%************************************************************************
%*									*
\subsection[ClosureInfo-construction]{Functions which build LFInfos}
%*									*
%************************************************************************

\begin{code}
244 245 246 247 248 249 250 251 252 253 254 255 256 257 258
mkLFReEntrant :: TopLevelFlag	-- True of top level
	      -> [Id]		-- Free vars
	      -> [Id] 		-- Args
	      -> ArgDescr	-- Argument descriptor
	      -> LambdaFormInfo

mkLFReEntrant top fvs args arg_descr 
  = LFReEntrant top (length args) (null fvs) arg_descr

mkLFThunk thunk_ty top fvs upd_flag
  = ASSERT( not (isUpdatable upd_flag) || not (isUnLiftedType thunk_ty) )
    LFThunk top (null fvs) 
	    (isUpdatable upd_flag)
	    NonStandardThunk 
	    (might_be_a_function thunk_ty)
259 260 261 262

might_be_a_function :: Type -> Bool
might_be_a_function ty
  | Just (tc,_) <- splitTyConApp_maybe (repType ty), 
263
    not (isFunTyCon tc)  && not (isAbstractTyCon tc) = False
264 265
	-- don't forget to check for abstract types, which might
	-- be functions too.
266
  | otherwise = True
267 268 269 270 271 272
\end{code}

@mkConLFInfo@ is similar, for constructors.

\begin{code}
mkConLFInfo :: DataCon -> LambdaFormInfo
273
mkConLFInfo con = LFCon con
274

275 276 277
mkSelectorLFInfo id offset updatable
  = LFThunk NotTopLevel False updatable (SelectorThunk offset) 
	(might_be_a_function (idType id))
278

279 280 281
mkApLFInfo id upd_flag arity
  = LFThunk NotTopLevel (arity == 0) (isUpdatable upd_flag) (ApThunk arity)
	(might_be_a_function (idType id))
282 283
\end{code}

284 285 286
Miscellaneous LF-infos.

\begin{code}
287 288
mkLFArgument id = LFUnknown (might_be_a_function (idType id))

289 290 291 292
mkLFLetNoEscape = LFLetNoEscape

mkLFImported :: Id -> LambdaFormInfo
mkLFImported id
293
  = case idArity id of
294 295
      n | n > 0 -> LFReEntrant TopLevel n True (panic "arg_descr")  -- n > 0
      other -> mkLFArgument id -- Not sure of exact arity
296
\end{code}
297

298 299 300 301 302 303 304 305 306 307
\begin{code}
isLFThunk :: LambdaFormInfo -> Bool
isLFThunk (LFThunk _ _ _ _ _)  = True
isLFThunk (LFBlackHole _)      = True
	-- return True for a blackhole: this function is used to determine
	-- whether to use the thunk header in SMP mode, and a blackhole
	-- must have one.
isLFThunk _ = False
\end{code}

308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332
%************************************************************************
%*									*
	Building ClosureInfos
%*									*
%************************************************************************

\begin{code}
mkClosureInfo :: Bool		-- Is static
	      -> Id
	      -> LambdaFormInfo 
	      -> Int -> Int	-- Total and pointer words
	      -> C_SRT
	      -> String		-- String descriptor
	      -> ClosureInfo
mkClosureInfo is_static id lf_info tot_wds ptr_wds srt_info descr
  = ClosureInfo { closureName = name, 
		  closureLFInfo = lf_info,
		  closureSMRep = sm_rep, 
		  closureSRT = srt_info,
		  closureType = idType id,
		  closureDescr = descr }
  where
    name   = idName id
    sm_rep = chooseSMRep is_static lf_info tot_wds ptr_wds

333
mkConInfo :: HomeModules
334
	  -> Bool	-- Is static
335 336 337
	  -> DataCon	
	  -> Int -> Int	-- Total and pointer words
	  -> ClosureInfo
338
mkConInfo hmods is_static data_con tot_wds ptr_wds
339
   = ConInfo {	closureSMRep = sm_rep,
340
		closureCon = data_con,
341
		closureDllCon = isDllName hmods (dataConName data_con) }
342 343 344 345
  where
    sm_rep = chooseSMRep is_static (mkConLFInfo data_con) tot_wds ptr_wds
\end{code}

346 347 348 349 350 351 352
%************************************************************************
%*									*
\subsection[ClosureInfo-sizes]{Functions about closure {\em sizes}}
%*									*
%************************************************************************

\begin{code}
353
closureSize :: ClosureInfo -> WordOff
354 355 356 357 358 359 360 361
closureSize cl_info = hdr_size + closureNonHdrSize cl_info
  where hdr_size  | closureIsThunk cl_info = thunkHdrSize
  		  | otherwise      	   = fixedHdrSize
	-- All thunks use thunkHdrSize, even if they are non-updatable.
	-- this is because we don't have separate closure types for
	-- updatable vs. non-updatable thunks, so the GC can't tell the
	-- difference.  If we ever have significant numbers of non-
	-- updatable thunks, it might be worth fixing this.
362

363
closureNonHdrSize :: ClosureInfo -> WordOff
364
closureNonHdrSize cl_info
365
  = tot_wds + computeSlopSize tot_wds cl_info
366 367 368
  where
    tot_wds = closureGoodStuffSize cl_info

369
closureGoodStuffSize :: ClosureInfo -> WordOff
370 371
closureGoodStuffSize cl_info
  = let (ptrs, nonptrs) = sizes_from_SMRep (closureSMRep cl_info)
372 373
    in	ptrs + nonptrs

374
closurePtrsSize :: ClosureInfo -> WordOff
375 376
closurePtrsSize cl_info
  = let (ptrs, _) = sizes_from_SMRep (closureSMRep cl_info)
377 378 379
    in	ptrs

-- not exported:
380
sizes_from_SMRep :: SMRep -> (WordOff,WordOff)
381 382
sizes_from_SMRep (GenericRep _ ptrs nonptrs _)   = (ptrs, nonptrs)
sizes_from_SMRep BlackHoleRep			 = (0, 0)
383 384 385 386 387 388
\end{code}

Computing slop size.  WARNING: this looks dodgy --- it has deep
knowledge of what the storage manager does with the various
representations...

389 390
Slop Requirements: every thunk gets an extra padding word in the
header, which takes the the updated value.
391

392
\begin{code}
393 394
slopSize cl_info = computeSlopSize payload_size cl_info
  where payload_size = closureGoodStuffSize cl_info
395

396 397 398 399 400 401
computeSlopSize :: WordOff -> ClosureInfo -> WordOff
computeSlopSize payload_size cl_info
  = max 0 (minPayloadSize smrep updatable - payload_size)
  where
	smrep        = closureSMRep cl_info
	updatable    = closureNeedsUpdSpace cl_info
402

403 404 405 406 407 408 409
-- we leave space for an update if either (a) the closure is updatable
-- or (b) it is a static thunk.  This is because a static thunk needs
-- a static link field in a predictable place (after the slop), regardless
-- of whether it is updatable or not.
closureNeedsUpdSpace (ClosureInfo { closureLFInfo = 
					LFThunk TopLevel _ _ _ _ }) = True
closureNeedsUpdSpace cl_info = closureUpdReqd cl_info
410

411 412 413 414 415 416
minPayloadSize :: SMRep -> Bool -> WordOff
minPayloadSize smrep updatable
  = case smrep of
	BlackHoleRep		 		-> min_upd_size
	GenericRep _ _ _ _      | updatable     -> min_upd_size
	GenericRep True _ _ _                   -> 0 -- static
417
	GenericRep False _ _ _                  -> mIN_PAYLOAD_SIZE
418 419
          --       ^^^^^___ dynamic
  where
420 421 422 423 424
   min_upd_size =
	ASSERT(mIN_PAYLOAD_SIZE <= sIZEOF_StgSMPThunkHeader)
	0 	-- check that we already have enough
		-- room for mIN_SIZE_NonUpdHeapObject,
		-- due to the extra header word in SMP
425 426 427 428 429 430 431 432 433
\end{code}

%************************************************************************
%*									*
\subsection[SMreps]{Choosing SM reps}
%*									*
%************************************************************************

\begin{code}
434 435 436
chooseSMRep
	:: Bool			-- True <=> static closure
	-> LambdaFormInfo
437
	-> WordOff -> WordOff	-- Tot wds, ptr wds
438 439
	-> SMRep

440
chooseSMRep is_static lf_info tot_wds ptr_wds
441
  = let
442
	 nonptr_wds   = tot_wds - ptr_wds
443
	 closure_type = getClosureType is_static ptr_wds lf_info
444
    in
445
    GenericRep is_static ptr_wds nonptr_wds closure_type	
446

447
-- We *do* get non-updatable top-level thunks sometimes.  eg. f = g
448 449 450
-- gets compiled to a jump to g (if g has non-zero arity), instead of
-- messing around with update frames and PAPs.  We set the closure type
-- to FUN_STATIC in this case.
451

452 453
getClosureType :: Bool -> WordOff -> LambdaFormInfo -> ClosureType
getClosureType is_static ptr_wds lf_info
454
  = case lf_info of
455 456 457 458 459
	LFCon con | is_static && ptr_wds == 0	-> ConstrNoCaf
		  | otherwise			-> Constr
  	LFReEntrant _ _ _ _ 			-> Fun
	LFThunk _ _ _ (SelectorThunk _) _ 	-> ThunkSelector
	LFThunk _ _ _ _ _ 			-> Thunk
460
	_ -> panic "getClosureType"
461 462 463 464 465 466 467 468 469 470 471
\end{code}

%************************************************************************
%*									*
\subsection[ClosureInfo-4-questions]{Four major questions about @ClosureInfo@}
%*									*
%************************************************************************

Be sure to see the stg-details notes about these...

\begin{code}
472 473 474 475
nodeMustPointToIt :: LambdaFormInfo -> Bool
nodeMustPointToIt (LFReEntrant top _ no_fvs _)
  = not no_fvs ||   -- Certainly if it has fvs we need to point to it
    isNotTopLevel top
476
		    -- If it is not top level we will point to it
477 478 479 480 481 482 483 484
		    --   We can have a \r closure with no_fvs which
		    --   is not top level as special case cgRhsClosure
		    --   has been dissabled in favour of let floating

		-- For lex_profiling we also access the cost centre for a
		-- non-inherited function i.e. not top level
		-- the  not top  case above ensures this is ok.

485
nodeMustPointToIt (LFCon _) = True
486 487 488 489 490 491 492 493 494 495 496 497

	-- Strictly speaking, the above two don't need Node to point
	-- to it if the arity = 0.  But this is a *really* unlikely
	-- situation.  If we know it's nil (say) and we are entering
	-- it. Eg: let x = [] in x then we will certainly have inlined
	-- x, since nil is a simple atom.  So we gain little by not
	-- having Node point to known zero-arity things.  On the other
	-- hand, we do lose something; Patrick's code for figuring out
	-- when something has been updated but not entered relies on
	-- having Node point to the result of an update.  SLPJ
	-- 27/11/92.

498 499
nodeMustPointToIt (LFThunk _ no_fvs updatable NonStandardThunk _)
  = updatable || not no_fvs || opt_SccProfilingOn
500 501 502 503 504 505 506
	  -- For the non-updatable (single-entry case):
	  --
	  -- True if has fvs (in which case we need access to them, and we
	  --		    should black-hole it)
	  -- or profiling (in which case we need to recover the cost centre
	  --		 from inside it)

507 508
nodeMustPointToIt (LFThunk _ no_fvs updatable some_standard_form_thunk _)
  = True  -- Node must point to any standard-form thunk
sof's avatar
sof committed
509

510 511 512
nodeMustPointToIt (LFUnknown _)     = True
nodeMustPointToIt (LFBlackHole _)   = True    -- BH entry may require Node to point
nodeMustPointToIt (LFLetNoEscape _) = False 
513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539
\end{code}

The entry conventions depend on the type of closure being entered,
whether or not it has free variables, and whether we're running
sequentially or in parallel.

\begin{tabular}{lllll}
Closure Characteristics & Parallel & Node Req'd & Argument Passing & Enter Via \\
Unknown 			& no & yes & stack	& node \\
Known fun ($\ge$ 1 arg), no fvs 	& no & no  & registers 	& fast entry (enough args) \\
\ & \ & \ & \ 						& slow entry (otherwise) \\
Known fun ($\ge$ 1 arg), fvs	& no & yes & registers 	& fast entry (enough args) \\
0 arg, no fvs @\r,\s@ 		& no & no  & n/a 	& direct entry \\
0 arg, no fvs @\u@ 		& no & yes & n/a 	& node \\
0 arg, fvs @\r,\s@ 		& no & yes & n/a 	& direct entry \\
0 arg, fvs @\u@ 		& no & yes & n/a 	& node \\

Unknown 			& yes & yes & stack	& node \\
Known fun ($\ge$ 1 arg), no fvs 	& yes & no  & registers & fast entry (enough args) \\
\ & \ & \ & \ 						& slow entry (otherwise) \\
Known fun ($\ge$ 1 arg), fvs	& yes & yes & registers & node \\
0 arg, no fvs @\r,\s@ 		& yes & no  & n/a 	& direct entry \\
0 arg, no fvs @\u@ 		& yes & yes & n/a 	& node \\
0 arg, fvs @\r,\s@ 		& yes & yes & n/a 	& node \\
0 arg, fvs @\u@ 		& yes & yes & n/a 	& node\\
\end{tabular}

540
When black-holing, single-entry closures could also be entered via node
541 542 543
(rather than directly) to catch double-entry.

\begin{code}
544
data CallMethod
545
  = EnterIt				-- no args, not a function
546

547 548 549 550 551 552 553
  | JumpToIt CLabel			-- no args, not a function, but we
					-- know what its entry code is

  | ReturnIt				-- it's a function, but we have
					-- zero args to apply to it, so just
					-- return it.

554 555
  | ReturnCon DataCon			-- It's a data constructor, just return it

556 557
  | SlowCall				-- Unknown fun, or known fun with
					-- too few args.
558

559
  | DirectEntry 			-- Jump directly, with args in regs
560 561
	CLabel 				--   The code label
	Int 				--   Its arity
562

563
getCallMethod :: HomeModules
564
	      -> Name		-- Function being applied
565 566 567 568
	      -> LambdaFormInfo	-- Its info
	      -> Int		-- Number of available arguments
	      -> CallMethod

569
getCallMethod hmods name lf_info n_args
570 571 572 573 574 575
  | nodeMustPointToIt lf_info && opt_Parallel
  =	-- If we're parallel, then we must always enter via node.  
	-- The reason is that the closure may have been 	
	-- fetched since we allocated it.
    EnterIt

576
getCallMethod hmods name (LFReEntrant _ arity _ _) n_args
577 578 579
  | n_args == 0    = ASSERT( arity /= 0 )
		     ReturnIt	-- No args at all
  | n_args < arity = SlowCall	-- Not enough args
580
  | otherwise      = DirectEntry (enterIdLabel hmods name) arity
581

582
getCallMethod hmods name (LFCon con) n_args
583 584 585
  = ASSERT( n_args == 0 )
    ReturnCon con

586
getCallMethod hmods name (LFThunk _ _ updatable std_form_info is_fun) n_args
587 588 589 590 591
  | is_fun 	-- Must always "call" a function-typed 
  = SlowCall	-- thing, cannot just enter it [in eval/apply, the entry code
		-- is the fast-entry code]

  | updatable || opt_DoTickyProfiling  -- to catch double entry
592 593 594 595 596
      {- OLD: || opt_SMP
	 I decided to remove this, because in SMP mode it doesn't matter
	 if we enter the same thunk multiple times, so the optimisation
	 of jumping directly to the entry code is still valid.  --SDM
	-}
597
  = ASSERT( n_args == 0 ) EnterIt
598

599 600
  | otherwise	-- Jump direct to code for single-entry thunks
  = ASSERT( n_args == 0 )
601
    JumpToIt (thunkEntryLabel hmods name std_form_info updatable)
602

603
getCallMethod hmods name (LFUnknown True) n_args
604 605
  = SlowCall -- might be a function

606
getCallMethod hmods name (LFUnknown False) n_args
607 608
  = ASSERT2 ( n_args == 0, ppr name <+> ppr n_args ) 
    EnterIt -- Not a function
609

610
getCallMethod hmods name (LFBlackHole _) n_args
611 612 613 614
  = SlowCall	-- Presumably the black hole has by now
		-- been updated, but we don't know with
		-- what, so we slow call it

615
getCallMethod hmods name (LFLetNoEscape 0) n_args
616 617
  = JumpToIt (enterReturnPtLabel (nameUnique name))

618
getCallMethod hmods name (LFLetNoEscape arity) n_args
619 620 621 622
  | n_args == arity = DirectEntry (enterReturnPtLabel (nameUnique name)) arity
  | otherwise = pprPanic "let-no-escape: " (ppr name <+> ppr arity)

blackHoleOnEntry :: ClosureInfo -> Bool
623
-- Static closures are never themselves black-holed.
624 625 626 627
-- Updatable ones will be overwritten with a CAFList cell, which points to a 
-- black hole;
-- Single-entry ones have no fvs to plug, and we trust they don't form part 
-- of a loop.
628

629 630 631
blackHoleOnEntry ConInfo{} = False
blackHoleOnEntry (ClosureInfo { closureLFInfo = lf_info, closureSMRep = rep })
  | isStaticRep rep
632
  = False	-- Never black-hole a static closure
633

634
  | otherwise
635
  = case lf_info of
636
	LFReEntrant _ _ _ _	  -> False
637
	LFLetNoEscape _		  -> False
638
	LFThunk _ no_fvs updatable _ _
639
	  -> if updatable
640
	     then not opt_OmitBlackHoling
641 642 643 644
	     else opt_DoTickyProfiling || not no_fvs
                  -- the former to catch double entry,
                  -- and the latter to plug space-leaks.  KSW/SDM 1999-04.

645
	other -> panic "blackHoleOnEntry"	-- Should never happen
646

647
isStandardFormThunk :: LambdaFormInfo -> Bool
648 649
isStandardFormThunk (LFThunk _ _ _ (SelectorThunk _) _) = True
isStandardFormThunk (LFThunk _ _ _ (ApThunk _) _)	= True
650
isStandardFormThunk other_lf_info 			= False
651

652 653 654 655
isKnownFun :: LambdaFormInfo -> Bool
isKnownFun (LFReEntrant _ _ _ _) = True
isKnownFun (LFLetNoEscape _) = True
isKnownFun _ = False
656 657 658 659
\end{code}

-----------------------------------------------------------------------------
SRT-related stuff
660

661 662
\begin{code}
staticClosureNeedsLink :: ClosureInfo -> Bool
663 664 665
-- A static closure needs a link field to aid the GC when traversing
-- the static closure graph.  But it only needs such a field if either
-- 	a) it has an SRT
666
--	b) it's a constructor with one or more pointer fields
667 668
-- In case (b), the constructor's fields themselves play the role
-- of the SRT.
669 670 671
staticClosureNeedsLink (ClosureInfo { closureSRT = srt })
  = needsSRT srt
staticClosureNeedsLink (ConInfo { closureSMRep = sm_rep, closureCon = con })
672
  = not (isNullaryRepDataCon con) && not_nocaf_constr
673
  where
674 675
    not_nocaf_constr = 
	case sm_rep of 
676 677
	   GenericRep _ _ _ ConstrNoCaf -> False
	   _other			-> True
678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704
\end{code}

Avoiding generating entries and info tables
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
At present, for every function we generate all of the following,
just in case.  But they aren't always all needed, as noted below:

[NB1: all of this applies only to *functions*.  Thunks always
have closure, info table, and entry code.]

[NB2: All are needed if the function is *exported*, just to play safe.]


* Fast-entry code  ALWAYS NEEDED

* Slow-entry code
	Needed iff (a) we have any un-saturated calls to the function
	OR	   (b) the function is passed as an arg
	OR	   (c) we're in the parallel world and the function has free vars
			[Reason: in parallel world, we always enter functions
			with free vars via the closure.]

* The function closure
	Needed iff (a) we have any un-saturated calls to the function
	OR	   (b) the function is passed as an arg
	OR	   (c) if the function has free vars (ie not top level)

705
  Why case (a) here?  Because if the arg-satis check fails,
706 707 708 709
  UpdatePAP stuffs a pointer to the function closure in the PAP.
  [Could be changed; UpdatePAP could stuff in a code ptr instead,
   but doesn't seem worth it.]

710
  [NB: these conditions imply that we might need the closure
711 712 713 714 715 716 717 718 719 720 721 722 723 724 725
  without the slow-entry code.  Here's how.

	f x y = let g w = ...x..y..w...
		in
		...(g t)...

  Here we need a closure for g which contains x and y,
  but since the calls are all saturated we just jump to the
  fast entry point for g, with R1 pointing to the closure for g.]


* Standard info table
	Needed iff (a) we have any un-saturated calls to the function
	OR	   (b) the function is passed as an arg
	OR 	   (c) the function has free vars (ie not top level)
726

727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742
	NB.  In the sequential world, (c) is only required so that the function closure has
	an info table to point to, to keep the storage manager happy.
	If (c) alone is true we could fake up an info table by choosing
	one of a standard family of info tables, whose entry code just
	bombs out.

	[NB In the parallel world (c) is needed regardless because
	we enter functions with free vars via the closure.]

	If (c) is retained, then we'll sometimes generate an info table
	(for storage mgr purposes) without slow-entry code.  Then we need
	to use an error label in the info table to substitute for the absent
	slow entry code.

\begin{code}
staticClosureRequired
743
	:: Name
744
	-> StgBinderInfo
745 746
	-> LambdaFormInfo
	-> Bool
747
staticClosureRequired binder bndr_info
748
		      (LFReEntrant top_level _ _ _)	-- It's a function
749
  = ASSERT( isTopLevel top_level )
750
	-- Assumption: it's a top-level, no-free-var binding
751
	not (satCallsOnly bndr_info)
752 753

staticClosureRequired binder other_binder_info other_lf_info = True
754 755
\end{code}

756 757 758 759 760 761 762 763 764
%************************************************************************
%*									*
\subsection[ClosureInfo-misc-funs]{Misc functions about @ClosureInfo@, etc.}
%*									*
%************************************************************************

\begin{code}

isStaticClosure :: ClosureInfo -> Bool
765
isStaticClosure cl_info = isStaticRep (closureSMRep cl_info)
766 767

closureUpdReqd :: ClosureInfo -> Bool
768 769 770 771 772 773
closureUpdReqd ClosureInfo{ closureLFInfo = lf_info } = lfUpdatable lf_info
closureUpdReqd ConInfo{} = False

lfUpdatable :: LambdaFormInfo -> Bool
lfUpdatable (LFThunk _ _ upd _ _)  = upd
lfUpdatable (LFBlackHole _)	   = True
774 775
	-- Black-hole closures are allocated to receive the results of an
	-- alg case with a named default... so they need to be updated.
776 777 778 779 780
lfUpdatable _ = False

closureIsThunk :: ClosureInfo -> Bool
closureIsThunk ClosureInfo{ closureLFInfo = lf_info } = isLFThunk lf_info
closureIsThunk ConInfo{} = False
781 782

closureSingleEntry :: ClosureInfo -> Bool
783
closureSingleEntry (ClosureInfo { closureLFInfo = LFThunk _ _ upd _ _}) = not upd
784
closureSingleEntry other_closure = False
785 786

closureReEntrant :: ClosureInfo -> Bool
787
closureReEntrant (ClosureInfo { closureLFInfo = LFReEntrant _ _ _ _ }) = True
788
closureReEntrant other_closure = False
789

790 791 792
isConstrClosure_maybe :: ClosureInfo -> Maybe DataCon
isConstrClosure_maybe (ConInfo { closureCon = data_con }) = Just data_con
isConstrClosure_maybe _ 				  = Nothing
793 794 795 796 797 798

closureFunInfo :: ClosureInfo -> Maybe (Int, ArgDescr)
closureFunInfo (ClosureInfo { closureLFInfo = LFReEntrant _ arity _ arg_desc})
  = Just (arity, arg_desc)
closureFunInfo _
  = Nothing
799 800
\end{code}

801 802
\begin{code}
isToplevClosure :: ClosureInfo -> Bool
803
isToplevClosure (ClosureInfo { closureLFInfo = lf_info })
804
  = case lf_info of
805 806
      LFReEntrant TopLevel _ _ _ -> True
      LFThunk TopLevel _ _ _ _   -> True
807
      other -> False
808
isToplevClosure _ = False
809 810
\end{code}

811 812 813
Label generation.

\begin{code}
814
infoTableLabelFromCI :: ClosureInfo -> CLabel
815 816 817
infoTableLabelFromCI (ClosureInfo { closureName = name,
				    closureLFInfo = lf_info, 
				    closureSMRep = rep })
818
  = case lf_info of
819
	LFBlackHole info -> info
820

821
	LFThunk _ _ upd_flag (SelectorThunk offset) _ -> 
822
		mkSelectorInfoLabel upd_flag offset
823

824
	LFThunk _ _ upd_flag (ApThunk arity) _ -> 
825
		mkApInfoTableLabel upd_flag arity
826

827
	LFThunk{}      -> mkLocalInfoTableLabel name
828

829
	LFReEntrant _ _ _ _ -> mkLocalInfoTableLabel name
830 831 832

	other -> panic "infoTableLabelFromCI"

833 834 835 836 837
infoTableLabelFromCI (ConInfo { closureCon = con, 
				closureSMRep = rep,
				closureDllCon = dll })
  | isStaticRep rep = mkStaticInfoTableLabel  name dll
  | otherwise	    = mkConInfoTableLabel     name dll
838 839
  where
    name = dataConName con
840

841 842
-- ClosureInfo for a closure (as opposed to a constructor) is always local
closureLabelFromCI (ClosureInfo { closureName = nm }) = mkLocalClosureLabel nm
843
closureLabelFromCI _ = panic "closureLabelFromCI"
844 845

-- thunkEntryLabel is a local help function, not exported.  It's used from both
846
-- entryLabelFromCI and getCallMethod.
847

848
thunkEntryLabel hmods thunk_id (ApThunk arity) is_updatable
849
  = enterApLabel is_updatable arity
850
thunkEntryLabel hmods thunk_id (SelectorThunk offset) upd_flag
851
  = enterSelectorLabel upd_flag offset
852 853
thunkEntryLabel hmods thunk_id _ is_updatable
  = enterIdLabel hmods thunk_id
854

855 856 857 858 859 860 861 862
enterApLabel is_updatable arity
  | tablesNextToCode = mkApInfoTableLabel is_updatable arity
  | otherwise        = mkApEntryLabel is_updatable arity

enterSelectorLabel upd_flag offset
  | tablesNextToCode = mkSelectorInfoLabel upd_flag offset
  | otherwise        = mkSelectorEntryLabel upd_flag offset

863 864 865
enterIdLabel hmods id
  | tablesNextToCode = mkInfoTableLabel hmods id
  | otherwise        = mkEntryLabel hmods id
866 867 868 869

enterLocalIdLabel id
  | tablesNextToCode = mkLocalInfoTableLabel id
  | otherwise        = mkLocalEntryLabel id
870 871 872 873

enterReturnPtLabel name
  | tablesNextToCode = mkReturnInfoLabel name
  | otherwise        = mkReturnPtLabel name
874 875
\end{code}

876

877
We need a black-hole closure info to pass to @allocDynClosure@ when we
878 879 880
want to allocate the black hole on entry to a CAF.  These are the only
ways to build an LFBlackHole, maintaining the invariant that it really
is a black hole and not something else.
881 882

\begin{code}
883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901
cafBlackHoleClosureInfo (ClosureInfo { closureName = nm,
				       closureType = ty })
  = ClosureInfo { closureName   = nm,
		  closureLFInfo = LFBlackHole mkCAFBlackHoleInfoTableLabel,
		  closureSMRep  = BlackHoleRep,
		  closureSRT    = NoC_SRT,
		  closureType   = ty,
		  closureDescr  = "" }
cafBlackHoleClosureInfo _ = panic "cafBlackHoleClosureInfo"

seCafBlackHoleClosureInfo (ClosureInfo { closureName = nm,
				         closureType = ty })
  = ClosureInfo { closureName   = nm,
		  closureLFInfo = LFBlackHole mkSECAFBlackHoleInfoTableLabel,
		  closureSMRep  = BlackHoleRep,
		  closureSRT    = NoC_SRT,
		  closureType   = ty,
		  closureDescr  = ""  }
seCafBlackHoleClosureInfo _ = panic "seCafBlackHoleClosureInfo"
902 903 904 905 906 907 908 909
\end{code}

%************************************************************************
%*									*
\subsection[ClosureInfo-Profiling-funs]{Misc functions about for profiling info.}
%*									*
%************************************************************************

910 911
Profiling requires two pieces of information to be determined for
each closure's info table --- description and type.
912 913 914 915 916 917 918 919

The description is stored directly in the @CClosureInfoTable@ when the
info table is built.

The type is determined from the type information stored with the @Id@
in the closure info using @closureTypeDescr@.

\begin{code}
920 921 922 923
closureValDescr, closureTypeDescr :: ClosureInfo -> String
closureValDescr (ClosureInfo {closureDescr = descr}) 
  = descr
closureValDescr (ConInfo {closureCon = con})
924
  = occNameString (getOccName con)
925

926 927 928
closureTypeDescr (ClosureInfo { closureType = ty })
  = getTyDescription ty
closureTypeDescr (ConInfo { closureCon = data_con })
929
  = occNameString (getOccName (dataConTyCon data_con))
930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948

getTyDescription :: Type -> String
getTyDescription ty
  = case (tcSplitSigmaTy ty) of { (_, _, tau_ty) ->
    case tau_ty of
      TyVarTy _	       	     -> "*"
      AppTy fun _      	     -> getTyDescription fun
      FunTy _ res      	     -> '-' : '>' : fun_result res
      TyConApp tycon _ 	     -> getOccString tycon
      NoteTy (FTVNote _) ty  -> getTyDescription ty
      PredTy sty	     -> getPredTyDescription sty
      ForAllTy _ ty          -> getTyDescription ty
    }
  where
    fun_result (FunTy _ res) = '>' : fun_result res
    fun_result other	     = getTyDescription other

getPredTyDescription (ClassP cl tys) = getOccString cl
getPredTyDescription (IParam ip ty)  = getOccString (ipNameName ip)
949 950 951
\end{code}