compiler/cmm/CmmCallConv.hs

   1 module CmmCallConv (
   2   ParamLocation(..),
   3   ArgumentFormat,
   4   assignArguments,
   5   assignArgumentsPos,
   6   argumentsSize,
   7 ) where
   8
   9 #include "HsVersions.h"
  10
  11 import Cmm
  12 import SMRep
  13 import ZipCfgCmmRep (Convention(..))
  14
  15 import Constants
  16 import StaticFlags (opt_Unregisterised)
  17 import Outputable
  18 import Panic
  19
  20 -- Calculate the 'GlobalReg' or stack locations for function call
  21 -- parameters as used by the Cmm calling convention.
  22
  23 data ParamLocation a
  24   = RegisterParam GlobalReg
  25   | StackParam a
  26
  27 instance (Outputable a) => Outputable (ParamLocation a) where
  28   ppr (RegisterParam g) = ppr g
  29   ppr (StackParam p)    = ppr p
  30
  31 type ArgumentFormat a b = [(a, ParamLocation b)]
  32
  33 -- Stack parameters are returned as word offsets.
  34 assignArguments :: (a -> CmmType) -> [a] -> ArgumentFormat a WordOff
  35 assignArguments f reps = assignments
  36     where
  37       availRegs = getRegsWithNode
  38       (sizes, assignments) = unzip $ assignArguments' reps (negate (sum sizes)) availRegs
  39       assignArguments' [] _ _ = []
  40       assignArguments' (r:rs) offset availRegs =
  41           (size,(r,assignment)):assignArguments' rs new_offset remaining
  42           where
  43             (assignment, new_offset, size, remaining) =
  44                 assign_reg assign_slot_neg (f r) offset availRegs
  45
  46 -- | JD: For the new stack story, I want arguments passed on the stack to manifest as
  47 -- positive offsets in a CallArea, not negative offsets from the stack pointer.
  48 -- Also, I want byte offsets, not word offsets.
  49 -- The first argument tells us whether we are assigning positions for call arguments
  50 -- or return results. The distinction matters because some conventions use different
  51 -- global registers in each case. In particular, the native calling convention
  52 -- uses the `node' register to pass the closure environment.
  53 assignArgumentsPos :: (Outputable a) => Convention -> Bool -> (a -> CmmType) -> [a] ->
  54                       ArgumentFormat a ByteOff
  55 assignArgumentsPos conv isCall arg_ty reps = map cvt assignments
  56     where -- The calling conventions (CgCallConv.hs) are complicated, to say the least
  57       regs = if isCall then
  58                case (reps, conv) of
  59                  (_, Native) -> getRegsWithoutNode
  60                  (_, GC    ) -> getRegsWithNode
  61                  (_, PrimOp) -> allRegs
  62                  (_, Slow  ) -> noRegs
  63                  (_, _     ) -> getRegsWithoutNode
  64              else
  65                case (reps, conv) of
  66                  ([_], _)    -> allRegs
  67                  (_, Native) -> getRegsWithNode
  68                  (_, GC    ) -> getRegsWithNode
  69                  (_, PrimOp) -> getRegsWithNode
  70                  (_, Slow  ) -> noRegs
  71                  (_, _     ) -> getRegsWithNode
  72       (sizes, assignments) = unzip $ assignArguments' reps (sum sizes) regs
  73       assignArguments' [] _ _ = []
  74       assignArguments' (r:rs) offset avails =
  75           (size, (r,assignment)):assignArguments' rs new_offset remaining
  76           where
  77             (assignment, new_offset, size, remaining) =
  78                 assign_reg assign_slot_pos (arg_ty r) offset avails
  79       cvt (l, RegisterParam r) = (l, RegisterParam r)
  80       cvt (l, StackParam off)  = (l, StackParam $ off * wORD_SIZE)
  81
  82 argumentsSize :: (a -> CmmType) -> [a] -> WordOff
  83 argumentsSize f reps = maximum (0 : map arg_top args)
  84     where
  85       args = assignArguments f reps
  86       arg_top (_, StackParam offset) = -offset
  87       arg_top (_, RegisterParam _) = 0
  88
  89 -----------------------------------------------------------------------------
  90 -- Local information about the registers available
  91
  92 type AvailRegs = ( [VGcPtr -> GlobalReg]   -- available vanilla regs.
  93                  , [GlobalReg]   -- floats
  94                  , [GlobalReg]   -- doubles
  95                  , [GlobalReg]   -- longs (int64 and word64)
  96                  )
  97
  98 -- Vanilla registers can contain pointers, Ints, Chars.
  99 -- Floats and doubles have separate register supplies.
 100 --
 101 -- We take these register supplies from the *real* registers, i.e. those
 102 -- that are guaranteed to map to machine registers.
 103
 104 vanillaRegNos, floatRegNos, doubleRegNos, longRegNos :: [Int]
 105 vanillaRegNos | opt_Unregisterised = []
 106               | otherwise          = regList mAX_Real_Vanilla_REG
 107 floatRegNos       | opt_Unregisterised = []
 108               | otherwise          = regList mAX_Real_Float_REG
 109 doubleRegNos  | opt_Unregisterised = []
 110               | otherwise          = regList mAX_Real_Double_REG
 111 longRegNos        | opt_Unregisterised = []
 112               | otherwise          = regList mAX_Real_Long_REG
 113
 114 --
 115 getRegsWithoutNode, getRegsWithNode :: AvailRegs
 116 getRegsWithoutNode =
 117   (filter (\r -> r VGcPtr /= node) intRegs,
 118    map FloatReg  floatRegNos, map DoubleReg doubleRegNos, map LongReg longRegNos)
 119     where intRegs = map VanillaReg vanillaRegNos
 120 getRegsWithNode =
 121   (intRegs, map FloatReg  floatRegNos, map DoubleReg doubleRegNos, map LongReg longRegNos)
 122     where intRegs = map VanillaReg vanillaRegNos
 123
 124 allVanillaRegNos, allFloatRegNos, allDoubleRegNos, allLongRegNos :: [Int]
 125 allVanillaRegNos = regList mAX_Vanilla_REG
 126 allFloatRegNos   = regList mAX_Float_REG
 127 allDoubleRegNos  = regList mAX_Double_REG
 128 allLongRegNos      = regList mAX_Long_REG
 129
 130 regList :: Int -> [Int]
 131 regList n = [1 .. n]
 132
 133 allRegs :: AvailRegs
 134 allRegs = (map VanillaReg allVanillaRegNos, map FloatReg allFloatRegNos,
 135            map DoubleReg  allDoubleRegNos,  map LongReg  allLongRegNos)
 136
 137 noRegs :: AvailRegs
 138 noRegs    = ([], [], [], [])
 139
 140 -- Round the size of a local register up to the nearest word.
 141 {-
 142 UNUSED 2008-12-29
 143
 144 slot_size :: LocalReg -> Int
 145 slot_size reg = slot_size' (typeWidth (localRegType reg))
 146 -}
 147
 148 slot_size' :: Width -> Int
 149 slot_size' reg = ((widthInBytes reg - 1) `div` wORD_SIZE) + 1
 150
 151 type Assignment = (ParamLocation WordOff, WordOff, WordOff, AvailRegs)
 152 type SlotAssigner = Width -> Int -> AvailRegs -> Assignment
 153
 154 assign_reg :: SlotAssigner -> CmmType -> WordOff -> AvailRegs -> Assignment
 155 assign_reg slot ty off avails
 156   | isFloatType ty = assign_float_reg slot width off avails
 157   | otherwise      = assign_bits_reg  slot width off gcp avails
 158   where
 159     width = typeWidth ty
 160     gcp | isGcPtrType ty = VGcPtr
 161         | otherwise      = VNonGcPtr
 162
 163 -- Assigning a slot using negative offsets from the stack pointer.
 164 -- JD: I don't know why this convention stops using all the registers
 165 --     after running out of one class of registers.
 166 assign_slot_neg :: SlotAssigner
 167 assign_slot_neg width off _regs =
 168   (StackParam $ off, off + size, size, ([], [], [], [])) where size = slot_size' width
 169
 170 -- Assigning a slot using positive offsets into a CallArea.
 171 assign_slot_pos :: SlotAssigner
 172 assign_slot_pos width off _regs =
 173   (StackParam $ off, off - size, size, ([], [], [], []))
 174   where size = slot_size' width
 175
 176 -- On calls in the native convention, `node` is used to hold the environment
 177 -- for the closure, so we can't pass arguments in that register.
 178 assign_bits_reg :: SlotAssigner -> Width -> WordOff -> VGcPtr -> AvailRegs -> Assignment
 179 assign_bits_reg _ W128 _ _ _ = panic "W128 is not a supported register type"
 180 assign_bits_reg _ w off gcp (v:vs, fs, ds, ls)
 181   | widthInBits w <= widthInBits wordWidth =
 182         pprTrace "long regs" (ppr ls <+> ppr wordWidth <+> ppr mAX_Real_Long_REG) $ (RegisterParam (v gcp), off, 0, (vs, fs, ds, ls))
 183 assign_bits_reg _ w off _ (vs, fs, ds, l:ls)
 184   | widthInBits w > widthInBits wordWidth =
 185         pprTrace "long regs" (ppr ls <+> ppr wordWidth <+> ppr mAX_Real_Long_REG) $ (RegisterParam l, off, 0, (vs, fs, ds, ls))
 186 assign_bits_reg assign_slot w off _ regs@(_, _, _, ls) =
 187   pprTrace "long regs" (ppr w <+> ppr ls <+> ppr wordWidth <+> ppr mAX_Real_Long_REG <+> ppr mAX_Long_REG) $ assign_slot w off regs
 188
 189 assign_float_reg :: SlotAssigner -> Width -> WordOff -> AvailRegs -> Assignment
 190 assign_float_reg _ W32 off (vs, f:fs, ds, ls) = (RegisterParam $ f, off, 0, (vs, fs, ds, ls))
 191 assign_float_reg _ W64 off (vs, fs, d:ds, ls) = (RegisterParam $ d, off, 0, (vs, fs, ds, ls))
 192 assign_float_reg _ W80 _   _                  = panic "F80 is not a supported register type"
 193 assign_float_reg assign_slot width off r = assign_slot width off r