Comments, layout and cmm-notes
[ghc-hetmet.git] / compiler / cmm / CmmCallConv.hs
index 5476eb8..830c879 100644 (file)
@@ -1,10 +1,3 @@
-{-# OPTIONS -w #-}
--- The above warning supression flag is a temporary kludge.
--- While working on this module you are encouraged to remove it and fix
--- any warnings in the module. See
---     http://hackage.haskell.org/trac/ghc/wiki/CodingStyle#Warnings
--- for details
-
 module CmmCallConv (
   ParamLocation(..),
   ArgumentFormat,
@@ -15,13 +8,15 @@ module CmmCallConv (
 
 #include "HsVersions.h"
 
-import Cmm
+import CmmExpr
 import SMRep
+import Cmm (Convention(..))
+import PprCmm ()
 
 import Constants
+import qualified Data.List as L
 import StaticFlags (opt_Unregisterised)
 import Outputable
-import Panic
 
 -- Calculate the 'GlobalReg' or stack locations for function call
 -- parameters as used by the Cmm calling convention.
@@ -30,54 +25,94 @@ data ParamLocation a
   = RegisterParam GlobalReg
   | StackParam a
 
+instance (Outputable a) => Outputable (ParamLocation a) where
+  ppr (RegisterParam g) = ppr g
+  ppr (StackParam p)    = ppr p
+
 type ArgumentFormat a b = [(a, ParamLocation b)]
 
--- Stack parameters are returned as word offsets.
 assignArguments :: (a -> CmmType) -> [a] -> ArgumentFormat a WordOff
-assignArguments f reps = assignments
-    where
-      (sizes, assignments) = unzip $ assignArguments' reps (negate (sum sizes)) availRegs
-      assignArguments' [] offset availRegs = []
-      assignArguments' (r:rs) offset availRegs =
-          (size,(r,assignment)):assignArguments' rs new_offset remaining
-          where 
-            (assignment, new_offset, size, remaining) =
-                assign_reg False assign_slot_up (f r) offset availRegs
+-- Stack parameters are returned as word offsets.
+assignArguments _ _ = panic "assignArguments only used in dead codegen" -- assignments
 
 -- | JD: For the new stack story, I want arguments passed on the stack to manifest as
 -- positive offsets in a CallArea, not negative offsets from the stack pointer.
 -- Also, I want byte offsets, not word offsets.
--- The first argument tells us whether we are assigning positions for call arguments
--- or return results. The distinction matters because we reserve different
--- global registers in each case.
-assignArgumentsPos :: Bool -> (a -> CmmType) -> [a] -> ArgumentFormat a ByteOff
-assignArgumentsPos isCall arg_ty reps = map cvt assignments
-    where
-      (sizes, assignments) = unzip $ assignArguments' reps 0 availRegs
-      assignArguments' [] _ _ = []
-      assignArguments' (r:rs) offset avails =
-          (size,(r,assignment)):assignArguments' rs new_offset remaining
-          where 
-            (assignment, new_offset, size, remaining) =
-                assign_reg isCall assign_slot_down (arg_ty r) offset avails
-      cvt (l, RegisterParam r) = (l, RegisterParam r)
-      cvt (l, StackParam off)  = (l, StackParam $ off * wORD_SIZE)
-
+assignArgumentsPos :: (Outputable a) => Convention -> (a -> CmmType) -> [a] ->
+                      ArgumentFormat a ByteOff
+-- Given a list of arguments, and a function that tells their types,
+-- return a list showing where each argument is passed
+assignArgumentsPos conv arg_ty reps = assignments
+    where -- The calling conventions (CgCallConv.hs) are complicated, to say the least
+      regs = case (reps, conv) of
+               (_,   NativeNodeCall)   -> getRegsWithNode
+               (_,   NativeDirectCall) -> getRegsWithoutNode
+               ([_], NativeReturn)     -> allRegs
+               (_,   NativeReturn)     -> getRegsWithNode
+               -- GC calling convention *must* put values in registers
+               (_,   GC)               -> allRegs
+               (_,   PrimOpCall)       -> allRegs
+               ([_], PrimOpReturn)     -> allRegs
+               (_,   PrimOpReturn)     -> getRegsWithNode
+               (_,   Slow)             -> noRegs
+               _ -> pprPanic "Unknown calling convention" (ppr conv)
+      -- The calling conventions first assign arguments to registers,
+      -- then switch to the stack when we first run out of registers
+      -- (even if there are still available registers for args of a different type).
+      -- When returning an unboxed tuple, we also separate the stack
+      -- arguments by pointerhood.
+      (reg_assts, stk_args) = assign_regs [] reps regs
+      stk_args' = case conv of NativeReturn -> part
+                               PrimOpReturn -> part
+                               GC | length stk_args /= 0 -> panic "Failed to allocate registers for GC call"
+                               _            -> stk_args
+                  where part = uncurry (++)
+                                       (L.partition (not . isGcPtrType . arg_ty) stk_args)
+      stk_assts = assign_stk 0 [] (reverse stk_args')
+      assignments = reg_assts ++ stk_assts
+
+      assign_regs assts []     _    = (assts, [])
+      assign_regs assts (r:rs) regs = if isFloatType ty then float else int
+        where float = case (w, regs) of
+                        (W32, (vs, f:fs, ds, ls)) -> k (RegisterParam f, (vs, fs, ds, ls))
+                        (W64, (vs, fs, d:ds, ls)) -> k (RegisterParam d, (vs, fs, ds, ls))
+                        (W80, _) -> panic "F80 unsupported register type"
+                        _ -> (assts, (r:rs))
+              int = case (w, regs) of
+                      (W128, _) -> panic "W128 unsupported register type"
+                      (_, (v:vs, fs, ds, ls)) | widthInBits w <= widthInBits wordWidth
+                          -> k (RegisterParam (v gcp), (vs, fs, ds, ls))
+                      (_, (vs, fs, ds, l:ls)) | widthInBits w > widthInBits wordWidth
+                          -> k (RegisterParam l, (vs, fs, ds, ls))
+                      _   -> (assts, (r:rs))
+              k (asst, regs') = assign_regs ((r, asst) : assts) rs regs'
+              ty = arg_ty r
+              w  = typeWidth ty
+              gcp | isGcPtrType ty = VGcPtr
+                  | otherwise             = VNonGcPtr
+
+      assign_stk _      assts [] = assts
+      assign_stk offset assts (r:rs) = assign_stk off' ((r, StackParam off') : assts) rs
+        where w    = typeWidth (arg_ty r)
+              size = (((widthInBytes w - 1) `div` wORD_SIZE) + 1) * wORD_SIZE
+              off' = offset + size
+       
+     
 argumentsSize :: (a -> CmmType) -> [a] -> WordOff
 argumentsSize f reps = maximum (0 : map arg_top args)
     where
       args = assignArguments f reps
-      arg_top (a, StackParam offset) = -offset
+      arg_top (_, StackParam offset) = -offset
       arg_top (_, RegisterParam _) = 0
 
 -----------------------------------------------------------------------------
 -- Local information about the registers available
 
 type AvailRegs = ( [VGcPtr -> GlobalReg]   -- available vanilla regs.
-                , [GlobalReg]   -- floats
-                , [GlobalReg]   -- doubles
-                , [GlobalReg]   -- longs (int64 and word64)
-                )
+                 , [GlobalReg]   -- floats
+                 , [GlobalReg]   -- doubles
+                 , [GlobalReg]   -- longs (int64 and word64)
+                 )
 
 -- Vanilla registers can contain pointers, Ints, Chars.
 -- Floats and doubles have separate register supplies.
@@ -85,65 +120,38 @@ type AvailRegs = ( [VGcPtr -> GlobalReg]   -- available vanilla regs.
 -- We take these register supplies from the *real* registers, i.e. those
 -- that are guaranteed to map to machine registers.
 
-useVanillaRegs | opt_Unregisterised = 0
-              | otherwise          = mAX_Real_Vanilla_REG
-useFloatRegs   | opt_Unregisterised = 0
-              | otherwise          = mAX_Real_Float_REG
-useDoubleRegs  | opt_Unregisterised = 0
-              | otherwise          = mAX_Real_Double_REG
-useLongRegs    | opt_Unregisterised = 0
-              | otherwise          = mAX_Real_Long_REG
-
-availRegs = (regList VanillaReg useVanillaRegs,
-             regList FloatReg useFloatRegs,
-             regList DoubleReg useDoubleRegs,
-             regList LongReg useLongRegs)
-    where
-      regList f max = map f [1 .. max]
-
--- Round the size of a local register up to the nearest word.
-slot_size :: LocalReg -> Int
-slot_size reg = slot_size' (typeWidth (localRegType reg))
-
-slot_size' :: Width -> Int
-slot_size' reg = ((widthInBytes reg - 1) `div` wORD_SIZE) + 1
-
-type Assignment = (ParamLocation WordOff, WordOff, WordOff, AvailRegs)
-type SlotAssigner = Width -> Int -> AvailRegs -> Assignment
-
-assign_reg :: Bool -> SlotAssigner -> CmmType -> WordOff -> AvailRegs -> Assignment
-assign_reg isCall slot ty off avails
-  | isFloatType ty = assign_float_reg        slot width off avails
-  | otherwise      = assign_bits_reg  isCall slot width off gcp avails
-  where
-    width = typeWidth ty
-    gcp | isGcPtrType ty = VGcPtr
-       | otherwise      = VNonGcPtr
-
--- Assigning a slot on a stack that grows up:
--- JD: I don't know why this convention stops using all the registers
---     after running out of one class of registers.
-assign_slot_up :: SlotAssigner
-assign_slot_up width off regs =
-  (StackParam $ off, off + size, size, ([], [], [], [])) where size = slot_size' width
-
--- Assigning a slot on a stack that grows down:
-assign_slot_down :: SlotAssigner
-assign_slot_down width off regs =
-  (StackParam $ off + size, off + size, size, ([], [], [], []))
-  where size = slot_size' width
-
--- On calls, `node` is used to hold the closure that is entered, so we can't
--- pass arguments in that register.
-assign_bits_reg _ _ W128 _ _ _ = panic "I128 is not a supported register type"
-assign_bits_reg isCall assign_slot w off gcp regs@(v:vs, fs, ds, ls) =
-  if isCall && v gcp == node then
-    assign_bits_reg isCall assign_slot w off gcp (vs, fs, ds, ls)
-  else if widthInBits w <= widthInBits wordWidth then
-    (RegisterParam (v gcp), off, 0, (vs, fs, ds, ls))
-  else assign_slot w off regs
-
-assign_float_reg _ W32 off (vs, f:fs, ds, ls) = (RegisterParam $ f, off, 0, (vs, fs, ds, ls))
-assign_float_reg _ W64 off (vs, fs, d:ds, ls) = (RegisterParam $ d, off, 0, (vs, fs, ds, ls))
-assign_float_reg _ W80 off _                  = panic "F80 is not a supported register type"
-assign_float_reg assign_slot width off r = assign_slot width off r
+vanillaRegNos, floatRegNos, doubleRegNos, longRegNos :: [Int]
+vanillaRegNos | opt_Unregisterised = []
+              | otherwise          = regList mAX_Real_Vanilla_REG
+floatRegNos      | opt_Unregisterised = []
+              | otherwise          = regList mAX_Real_Float_REG
+doubleRegNos  | opt_Unregisterised = []
+              | otherwise          = regList mAX_Real_Double_REG
+longRegNos       | opt_Unregisterised = []
+              | otherwise          = regList mAX_Real_Long_REG
+
+-- 
+getRegsWithoutNode, getRegsWithNode :: AvailRegs
+getRegsWithoutNode =
+  (filter (\r -> r VGcPtr /= node) intRegs,
+   map FloatReg  floatRegNos, map DoubleReg doubleRegNos, map LongReg longRegNos)
+    where intRegs = map VanillaReg vanillaRegNos
+getRegsWithNode =
+  (intRegs, map FloatReg  floatRegNos, map DoubleReg doubleRegNos, map LongReg longRegNos)
+    where intRegs = map VanillaReg vanillaRegNos
+
+allVanillaRegNos, allFloatRegNos, allDoubleRegNos, allLongRegNos :: [Int]
+allVanillaRegNos = regList mAX_Vanilla_REG
+allFloatRegNos  = regList mAX_Float_REG
+allDoubleRegNos         = regList mAX_Double_REG
+allLongRegNos     = regList mAX_Long_REG
+
+regList :: Int -> [Int]
+regList n = [1 .. n]
+
+allRegs :: AvailRegs
+allRegs = (map VanillaReg allVanillaRegNos, map FloatReg allFloatRegNos,
+           map DoubleReg  allDoubleRegNos,  map LongReg  allLongRegNos)
+
+noRegs :: AvailRegs
+noRegs    = ([], [], [], [])