2 module Main(main) where
4 #include "../../includes/config.h"
5 #include "../../includes/MachRegs.h"
7 #if __GLASGOW_HASKELL__ >= 504
8 import Text.PrettyPrint
11 import Data.List ( intersperse )
12 import Data.Char ( toUpper )
17 import List ( intersperse )
18 import Char ( toUpper )
22 -- -----------------------------------------------------------------------------
23 -- Argument kinds (rougly equivalent to PrimRep)
33 -- size of a value in *words*
34 argSize :: ArgRep -> Int
39 argSize D = (SIZEOF_DOUBLE `quot` SIZEOF_VOID_P :: Int)
40 argSize L = (8 `quot` SIZEOF_VOID_P :: Int)
42 showArg :: ArgRep -> Char
50 -- is a value a pointer?
51 isPtr :: ArgRep -> Bool
55 -- -----------------------------------------------------------------------------
60 availableRegs :: ([Reg],[Reg],[Reg],[Reg])
62 ( vanillaRegs MAX_REAL_VANILLA_REG,
63 floatRegs MAX_REAL_FLOAT_REG,
64 doubleRegs MAX_REAL_DOUBLE_REG,
65 longRegs MAX_REAL_LONG_REG
68 vanillaRegs, floatRegs, doubleRegs, longRegs :: Int -> [Reg]
69 vanillaRegs n = [ "R" ++ show m ++ ".w" | m <- [2..n] ] -- never use R1
70 floatRegs n = [ "F" ++ show m | m <- [1..n] ]
71 doubleRegs n = [ "D" ++ show m | m <- [1..n] ]
72 longRegs n = [ "L" ++ show m | m <- [1..n] ]
74 -- -----------------------------------------------------------------------------
75 -- Loading/saving register arguments to the stack
77 loadRegArgs :: Int -> [ArgRep] -> (Doc,Int)
78 loadRegArgs sp args = (vcat (map (uncurry assign_stk_to_reg) reg_locs), sp')
80 (reg_locs, sp') = assignRegs sp args
82 -- a bit like assignRegs in CgRetConv.lhs
84 :: Int -- Sp of first arg
86 -> ([(Reg,Int)], Int) -- Sp and rest of args
87 assignRegs sp args = assign sp args availableRegs []
89 assign sp [] regs doc = (doc, sp)
90 assign sp (V : args) regs doc = assign sp args regs doc
91 assign sp (arg : args) regs doc
92 = case findAvailableReg arg regs of
93 Just (reg, regs') -> assign (sp + argSize arg) args regs'
97 findAvailableReg N (vreg:vregs, fregs, dregs, lregs) =
98 Just (vreg, (vregs,fregs,dregs,lregs))
99 findAvailableReg P (vreg:vregs, fregs, dregs, lregs) =
100 Just (vreg, (vregs,fregs,dregs,lregs))
101 findAvailableReg F (vregs, freg:fregs, dregs, lregs) =
102 Just (freg, (vregs,fregs,dregs,lregs))
103 findAvailableReg D (vregs, fregs, dreg:dregs, lregs) =
104 Just (dreg, (vregs,fregs,dregs,lregs))
105 findAvailableReg L (vregs, fregs, dregs, lreg:lregs) =
106 Just (lreg, (vregs,fregs,dregs,lregs))
107 findAvailableReg _ _ = Nothing
109 assign_reg_to_stk reg@('F':_) sp
110 = text "ASSIGN_FLT(Sp+" <> int sp <> comma <> text reg <> text ");"
111 assign_reg_to_stk reg@('D':_) sp
112 = text "ASSIGN_DBL(Sp+" <> int sp <> comma <> text reg <> text ");"
113 assign_reg_to_stk reg@('L':_) sp
114 = text "ASSIGN_Word64(Sp+" <> int sp <> comma <> text reg <> text ");"
115 assign_reg_to_stk reg sp
116 = text "Sp[" <> int sp <> text "] = " <> text reg <> semi
118 assign_stk_to_reg reg@('F':_) sp
119 = text reg <> text " = " <> text "PK_FLT(Sp+" <> int sp <> text ");"
120 assign_stk_to_reg reg@('D':_) sp
121 = text reg <> text " = " <> text "PK_DBL(Sp+" <> int sp <> text ");"
122 assign_stk_to_reg reg@('L':_) sp
123 = text reg <> text " = " <> text "PK_Word64(Sp+" <> int sp <> text ");"
124 assign_stk_to_reg reg sp
125 = text reg <> text " = Sp[" <> int sp <> text "];"
128 -- make a ptr/non-ptr bitmap from a list of argument types
129 mkBitmap :: [ArgRep] -> Word32
130 mkBitmap args = foldr f 0 args
131 where f arg bm | isPtr arg = bm `shiftL` 1
132 | otherwise = (bm `shiftL` size) .|. ((1 `shiftL` size) - 1)
133 where size = argSize arg
135 -- -----------------------------------------------------------------------------
136 -- Generating the application functions
139 = text "stg_ap_" <> text (map showArg args) <> text "_ret"
142 = text "stg_ap_" <> text (map showArg args) <> text "_info"
144 genMkPAP macro jump is_pap args all_args_size fun_info_label
145 = smaller_arity_cases
152 -- The SMALLER ARITY cases:
155 -- Sp[1] = (W_)&stg_ap_1_info;
156 -- JMP_(GET_ENTRY(R1.cl));
158 smaller_arity_cases = vcat [ smaller_arity i | i <- [1..n_args-1] ]
161 = text "if (arity == " <> int arity <> text ") {" $$
164 | is_pap = (empty, 1)
165 | otherwise = loadRegArgs 1 these_args
169 vcat [ shuffle_down j | j <- [sp'..these_args_size] ],
170 text "Sp[" <> int these_args_size <> text "] = (W_)&" <>
171 mkApplyInfoName rest_args <> semi,
172 text "Sp += " <> int (sp' - 1) <> semi,
173 -- for a PAP, we have to arrange that the stack contains a
174 -- return address in the even that stg_PAP_entry fails its
175 -- heap check. See stg_PAP_entry in Apply.hc for details.
177 then text "Sp--; Sp[0] = (W_)&" <> mkApplyInfoName these_args <> semi
179 text "JMP_" <> parens (text jump) <> semi
183 (these_args, rest_args) = splitAt arity args
184 these_args_size = sum (map argSize these_args)
187 text "Sp[" <> int (i-1) <> text "] = Sp["
188 <> int i <> text "];"
190 -- The EXACT ARITY case
194 -- JMP_(GET_ENTRY(R1.cl));
197 = text "if (arity == " <> int n_args <> text ") {" $$
200 | is_pap = (empty, 0)
201 | otherwise = loadRegArgs 1 args
205 text "Sp += " <> int sp' <> semi,
207 then text "Sp[0] = (W_)&" <> fun_info_label <> semi
209 text "JMP_" <> parens (text jump) <> semi
212 -- The LARGER ARITY cases:
214 -- } else /* arity > 1 */ {
215 -- BUILD_PAP(1,0,(W_)&stg_ap_v_info);
221 text macro <> char '(' <> int n_args <> comma <>
223 text ",(W_)&" <> fun_info_label <>
228 -- -----------------------------------------------------------------------------
229 -- generate an apply function
231 -- args is a list of 'p', 'n', 'f', 'd' or 'l'
235 fun_ret_label = mkApplyRetName args
236 fun_info_label = mkApplyInfoName args
237 all_args_size = sum (map argSize args)
240 text "INFO_TABLE_RET(" <> fun_info_label <> text "," <>
241 fun_ret_label <> text "," <>
242 text "MK_SMALL_BITMAP(" <> int all_args_size <> text "/*framsize*/," <>
243 int (fromIntegral (mkBitmap args)) <> text "/*bitmap*/), " <>
244 text "0,0,0,RET_SMALL,,EF_,0,0);",
246 text "F_ " <> fun_ret_label <> text "( void )\n{",
248 text "StgInfoTable *info;",
253 -- print "static void *lbls[] ="
254 -- print " { [FUN] &&fun_lbl,"
255 -- print " [FUN_1_0] &&fun_lbl,"
256 -- print " [FUN_0_1] &&fun_lbl,"
257 -- print " [FUN_2_0] &&fun_lbl,"
258 -- print " [FUN_1_1] &&fun_lbl,"
259 -- print " [FUN_0_2] &&fun_lbl,"
260 -- print " [FUN_STATIC] &&fun_lbl,"
261 -- print " [PAP] &&pap_lbl,"
262 -- print " [THUNK] &&thunk_lbl,"
263 -- print " [THUNK_1_0] &&thunk_lbl,"
264 -- print " [THUNK_0_1] &&thunk_lbl,"
265 -- print " [THUNK_2_0] &&thunk_lbl,"
266 -- print " [THUNK_1_1] &&thunk_lbl,"
267 -- print " [THUNK_0_2] &&thunk_lbl,"
268 -- print " [THUNK_STATIC] &&thunk_lbl,"
269 -- print " [THUNK_SELECTOR] &&thunk_lbl,"
270 -- print " [IND] &&ind_lbl,"
271 -- print " [IND_OLDGEN] &&ind_lbl,"
272 -- print " [IND_STATIC] &&ind_lbl,"
273 -- print " [IND_PERM] &&ind_lbl,"
274 -- print " [IND_OLDGEN_PERM] &&ind_lbl"
279 text "IF_DEBUG(apply,fprintf(stderr, \"" <> fun_ret_label <>
280 text "... \"); printClosure(R1.cl));",
282 text "IF_DEBUG(sanity,checkStackFrame(Sp+" <> int (1 + all_args_size)
285 -- text "IF_DEBUG(sanity,checkStackChunk(Sp+" <> int (1 + all_args_size) <>
286 -- text ", CurrentTSO->stack + CurrentTSO->stack_size));",
288 text "TICK_SLOW_CALL(" <> int (length args) <> text ");",
290 let do_assert [] _ = []
291 do_assert (arg:args) offset
292 | isPtr arg = this : rest
294 where this = text "ASSERT(LOOKS_LIKE_CLOSURE_PTR(Sp["
295 <> int offset <> text "]));"
296 rest = do_assert args (offset + argSize arg)
298 vcat (do_assert args 1),
301 text "info = get_itbl(R1.cl);",
304 -- print " goto *lbls[info->type];";
306 text "switch (info->type) {" $$
314 text "arity = BCO_ARITY((StgBCO *)R1.p);",
315 text "target = (F_)&stg_BCO_entry;",
316 text "goto apply_pap;"
323 text "case FUN_1_0:",
324 text "case FUN_0_1:",
325 text "case FUN_2_0:",
326 text "case FUN_1_1:",
327 text "case FUN_0_2:",
328 text "case FUN_STATIC:",
330 text "arity = itbl_to_fun_itbl(info)->arity;",
331 text "ASSERT(arity > 0);",
332 genMkPAP "BUILD_PAP" "GET_ENTRY(R1.cl)" False{-not PAP-}
333 args all_args_size fun_info_label
342 text "arity = ((StgPAP *)R1.p)->arity;",
343 text "target = (F_)&stg_PAP_entry;",
345 text "ASSERT(arity > 0);",
346 genMkPAP "NEW_PAP" "target" True{-is PAP-}
347 args all_args_size fun_info_label
353 -- print " thunk_lbl:"
356 text "case AP_STACK:",
357 text "case CAF_BLACKHOLE:",
358 text "case BLACKHOLE:",
359 text "case BLACKHOLE_BQ:",
360 text "case SE_BLACKHOLE:",
361 text "case SE_CAF_BLACKHOLE:",
363 text "case THUNK_1_0:",
364 text "case THUNK_0_1:",
365 text "case THUNK_2_0:",
366 text "case THUNK_1_1:",
367 text "case THUNK_0_2:",
368 text "case THUNK_STATIC:",
369 text "case THUNK_SELECTOR:",
371 text "Sp[0] = (W_)&" <> fun_info_label <> text ";",
372 text "JMP_(GET_ENTRY(R1.cl));",
380 text "case IND_OLDGEN:",
381 text "case IND_STATIC:",
382 text "case IND_PERM:",
383 text "case IND_OLDGEN_PERM:",
385 text "R1.cl = ((StgInd *)R1.p)->indirectee;",
394 text "barf(\"" <> fun_ret_label <> text "\");"
404 -- -----------------------------------------------------------------------------
405 -- Making a stack apply
407 -- These little functions are like slow entry points. They provide
408 -- the layer between the PAP entry code and the function's fast entry
409 -- point: namely they load arguments off the stack into registers (if
410 -- available) and jump to the function's entry code.
412 -- On entry: R1 points to the function closure
413 -- arguments are on the stack starting at Sp
415 -- Invariant: the list of arguments never contains void. Since we're only
416 -- interested in loading arguments off the stack here, we can ignore
419 mkStackApplyEntryLabel:: [ArgRep] -> Doc
420 mkStackApplyEntryLabel args = text "stg_ap_stk_" <> text (map showArg args)
422 genStackApply :: [ArgRep] -> Doc
424 let fn_entry_label = mkStackApplyEntryLabel args in
426 text "IF_" <> parens fn_entry_label,
428 nest 4 (text "FB_" $$ body $$ text "FE_"),
432 (assign_regs, sp') = loadRegArgs 0 args
433 body = vcat [assign_regs,
434 text "Sp += " <> int sp' <> semi,
435 text "JMP_(GET_ENTRY(R1.cl));"
438 -- -----------------------------------------------------------------------------
439 -- Stack save entry points.
441 -- These code fragments are used to save registers on the stack at a heap
442 -- check failure in the entry code for a function. We also have to save R1
443 -- and the return address (stg_gen_ap_info) on the stack. See stg_fun_gc_gen
444 -- in HeapStackCheck.hc for more details.
446 mkStackSaveEntryLabel :: [ArgRep] -> Doc
447 mkStackSaveEntryLabel args = text "stg_stk_save_" <> text (map showArg args)
449 genStackSave :: [ArgRep] -> Doc
451 let fn_entry_label= mkStackSaveEntryLabel args in
453 text "IF_" <> parens fn_entry_label,
455 nest 4 (text "FB_" $$ body $$ text "FE_"),
459 body = vcat [text "Sp -= " <> int sp_offset <> semi,
460 vcat (map (uncurry assign_reg_to_stk) reg_locs),
461 text "Sp[2] = R1.w;",
462 text "Sp[1] =" <+> int (sp_offset - std_frame_size) <> semi,
463 text "Sp[0] = (W_)&stg_gc_fun_info;",
464 text "JMP_(stg_gc_noregs);"
467 std_frame_size = 3 -- the std bits of the frame. See StgRetFun in Closures.h,
468 -- and the comment on stg_fun_gc_gen in HeapStackCheck.hc.
469 (reg_locs, sp_offset) = assignRegs std_frame_size args
471 -- -----------------------------------------------------------------------------
474 main = putStr (render the_code)
475 where the_code = vcat [
476 text "// DO NOT EDIT!",
477 text "// Automatically generated by GenApply.hs",
479 text "#include \"Stg.h\"",
480 text "#include \"Rts.h\"",
481 text "#include \"RtsFlags.h\"",
482 text "#include \"Storage.h\"",
483 text "#include \"RtsUtils.h\"",
484 text "#include \"Printer.h\"",
485 text "#include \"Sanity.h\"",
486 text "#include \"Apply.h\"",
488 text "#include <stdio.h>",
490 vcat (intersperse (text "") $ map genApply applyTypes),
491 vcat (intersperse (text "") $ map genStackFns stackApplyTypes),
493 genStackApplyArray stackApplyTypes,
494 genStackSaveArray stackApplyTypes,
495 genBitmapArray stackApplyTypes,
497 text "" -- add a newline at the end of the file
500 -- These have been shown to cover about 99% of cases in practice...
518 -- No need for V args in the stack apply cases.
519 -- ToDo: the stack apply and stack save code doesn't make a distinction
520 -- between N and P (they both live in the same register), only the bitmap
521 -- changes, so we could share the apply/save code between lots of cases.
547 genStackFns args = genStackApply args $$ genStackSave args
550 genStackApplyArray types =
551 text "StgFun *stg_ap_stack_entries[] = {" $$
552 vcat (map arr_ent types) $$
555 arr_ent ty = brackets (arg_const ty) <+> mkStackApplyEntryLabel ty <> comma
557 genStackSaveArray types =
558 text "StgFun *stg_stack_save_entries[] = {" $$
559 vcat (map arr_ent types) $$
562 arr_ent ty = brackets (arg_const ty) <+> mkStackSaveEntryLabel ty <> comma
564 genBitmapArray :: [[ArgRep]] -> Doc
565 genBitmapArray types =
567 text "StgWord stg_arg_bitmaps[] = {",
568 vcat (map gen_bitmap types),
572 gen_bitmap ty = brackets (arg_const ty) <+>
573 text "MK_SMALL_BITMAP" <> parens (
574 int (sum (map argSize ty)) <> comma <>
575 text (show (mkBitmap ty))) <>
578 arg_const ty = text "ARG_" <> text (map toUpper (map showArg ty))