basis/cpu/architecture/architecture.factor

   1 ! Copyright (C) 2006, 2009 Slava Pestov.
   2 ! See http://factorcode.org/license.txt for BSD license.
   3 USING: accessors arrays generic kernel kernel.private math
   4 memory namespaces make sequences layouts system hashtables
   5 classes alien byte-arrays combinators words sets fry ;
   6 IN: cpu.architecture
   7
   8 ! Representations -- these are like low-level types
   9
  10 ! Unknown representation; this is used for ##copy instructions which
  11 ! get eliminated later
  12 SINGLETON: any-rep
  13
  14 ! Integer registers can contain data with one of these three representations
  15 ! tagged-rep: tagged pointer or fixnum
  16 ! int-rep: untagged fixnum, not a pointer
  17 SINGLETONS: tagged-rep int-rep ;
  18
  19 ! Floating point registers can contain data with
  20 ! one of these representations
  21 SINGLETONS: float-rep double-rep ;
  22
  23 ! On x86, floating point registers are really vector registers
  24 SINGLETONS:
  25 char-16-rep
  26 uchar-16-rep
  27 short-8-rep
  28 ushort-8-rep
  29 int-4-rep
  30 uint-4-rep ;
  31
  32 SINGLETONS:
  33 float-4-rep
  34 double-2-rep ;
  35
  36 UNION: int-vector-rep
  37 char-16-rep
  38 uchar-16-rep
  39 short-8-rep
  40 ushort-8-rep
  41 int-4-rep
  42 uint-4-rep ;
  43
  44 UNION: float-vector-rep
  45 float-4-rep
  46 double-2-rep ;
  47
  48 UNION: vector-rep
  49 int-vector-rep
  50 float-vector-rep ;
  51
  52 UNION: representation
  53 any-rep
  54 tagged-rep
  55 int-rep
  56 float-rep
  57 double-rep
  58 vector-rep ;
  59
  60 ! Register classes
  61 SINGLETONS: int-regs float-regs ;
  62
  63 UNION: reg-class int-regs float-regs ;
  64 CONSTANT: reg-classes { int-regs float-regs }
  65
  66 ! A pseudo-register class for parameters spilled on the stack
  67 SINGLETON: stack-params
  68
  69 GENERIC: reg-class-of ( rep -- reg-class )
  70
  71 M: tagged-rep reg-class-of drop int-regs ;
  72 M: int-rep reg-class-of drop int-regs ;
  73 M: float-rep reg-class-of drop float-regs ;
  74 M: double-rep reg-class-of drop float-regs ;
  75 M: vector-rep reg-class-of drop float-regs ;
  76 M: stack-params reg-class-of drop stack-params ;
  77
  78 GENERIC: rep-size ( rep -- n ) foldable
  79
  80 M: tagged-rep rep-size drop cell ;
  81 M: int-rep rep-size drop cell ;
  82 M: float-rep rep-size drop 4 ;
  83 M: double-rep rep-size drop 8 ;
  84 M: stack-params rep-size drop cell ;
  85 M: vector-rep rep-size drop 16 ;
  86
  87 GENERIC: rep-component-type ( rep -- n )
  88
  89 ! Methods defined in alien.c-types
  90
  91 GENERIC: scalar-rep-of ( rep -- rep' )
  92
  93 M: float-4-rep scalar-rep-of drop float-rep ;
  94 M: double-2-rep scalar-rep-of drop double-rep ;
  95 M: int-vector-rep scalar-rep-of drop int-rep ;
  96
  97 ! Mapping from register class to machine registers
  98 HOOK: machine-registers cpu ( -- assoc )
  99
 100 HOOK: two-operand? cpu ( -- ? )
 101
 102 HOOK: %load-immediate cpu ( reg obj -- )
 103 HOOK: %load-reference cpu ( reg obj -- )
 104
 105 HOOK: %peek cpu ( vreg loc -- )
 106 HOOK: %replace cpu ( vreg loc -- )
 107 HOOK: %inc-d cpu ( n -- )
 108 HOOK: %inc-r cpu ( n -- )
 109
 110 HOOK: stack-frame-size cpu ( stack-frame -- n )
 111 HOOK: %call cpu ( word -- )
 112 HOOK: %jump cpu ( word -- )
 113 HOOK: %jump-label cpu ( label -- )
 114 HOOK: %return cpu ( -- )
 115
 116 HOOK: %dispatch cpu ( src temp -- )
 117
 118 HOOK: %slot cpu ( dst obj slot tag temp -- )
 119 HOOK: %slot-imm cpu ( dst obj slot tag -- )
 120 HOOK: %set-slot cpu ( src obj slot tag temp -- )
 121 HOOK: %set-slot-imm cpu ( src obj slot tag -- )
 122
 123 HOOK: %string-nth cpu ( dst obj index temp -- )
 124 HOOK: %set-string-nth-fast cpu ( ch obj index temp -- )
 125
 126 HOOK: %add     cpu ( dst src1 src2 -- )
 127 HOOK: %add-imm cpu ( dst src1 src2 -- )
 128 HOOK: %sub     cpu ( dst src1 src2 -- )
 129 HOOK: %sub-imm cpu ( dst src1 src2 -- )
 130 HOOK: %mul     cpu ( dst src1 src2 -- )
 131 HOOK: %mul-imm cpu ( dst src1 src2 -- )
 132 HOOK: %and     cpu ( dst src1 src2 -- )
 133 HOOK: %and-imm cpu ( dst src1 src2 -- )
 134 HOOK: %or      cpu ( dst src1 src2 -- )
 135 HOOK: %or-imm  cpu ( dst src1 src2 -- )
 136 HOOK: %xor     cpu ( dst src1 src2 -- )
 137 HOOK: %xor-imm cpu ( dst src1 src2 -- )
 138 HOOK: %shl     cpu ( dst src1 src2 -- )
 139 HOOK: %shl-imm cpu ( dst src1 src2 -- )
 140 HOOK: %shr     cpu ( dst src1 src2 -- )
 141 HOOK: %shr-imm cpu ( dst src1 src2 -- )
 142 HOOK: %sar     cpu ( dst src1 src2 -- )
 143 HOOK: %sar-imm cpu ( dst src1 src2 -- )
 144 HOOK: %min     cpu ( dst src1 src2 -- )
 145 HOOK: %max     cpu ( dst src1 src2 -- )
 146 HOOK: %not     cpu ( dst src -- )
 147 HOOK: %log2    cpu ( dst src -- )
 148
 149 HOOK: %copy cpu ( dst src rep -- )
 150
 151 HOOK: %fixnum-add cpu ( label dst src1 src2 -- )
 152 HOOK: %fixnum-sub cpu ( label dst src1 src2 -- )
 153 HOOK: %fixnum-mul cpu ( label dst src1 src2 -- )
 154
 155 HOOK: %integer>bignum cpu ( dst src temp -- )
 156 HOOK: %bignum>integer cpu ( dst src temp -- )
 157
 158 HOOK: %unbox-float cpu ( dst src -- )
 159 HOOK: %box-float cpu ( dst src temp -- )
 160
 161 HOOK: %add-float cpu ( dst src1 src2 -- )
 162 HOOK: %sub-float cpu ( dst src1 src2 -- )
 163 HOOK: %mul-float cpu ( dst src1 src2 -- )
 164 HOOK: %div-float cpu ( dst src1 src2 -- )
 165 HOOK: %min-float cpu ( dst src1 src2 -- )
 166 HOOK: %max-float cpu ( dst src1 src2 -- )
 167 HOOK: %sqrt cpu ( dst src -- )
 168 HOOK: %unary-float-function cpu ( dst src func -- )
 169 HOOK: %binary-float-function cpu ( dst src1 src2 func -- )
 170
 171 HOOK: %single>double-float cpu ( dst src -- )
 172 HOOK: %double>single-float cpu ( dst src -- )
 173
 174 HOOK: %integer>float cpu ( dst src -- )
 175 HOOK: %float>integer cpu ( dst src -- )
 176
 177 HOOK: %box-vector cpu ( dst src temp rep -- )
 178 HOOK: %unbox-vector cpu ( dst src rep -- )
 179
 180 HOOK: %broadcast-vector cpu ( dst src rep -- )
 181 HOOK: %gather-vector-2 cpu ( dst src1 src2 rep -- )
 182 HOOK: %gather-vector-4 cpu ( dst src1 src2 src3 src4 rep -- )
 183 HOOK: %add-vector cpu ( dst src1 src2 rep -- )
 184 HOOK: %saturated-add-vector cpu ( dst src1 src2 rep -- )
 185 HOOK: %add-sub-vector cpu ( dst src1 src2 rep -- )
 186 HOOK: %sub-vector cpu ( dst src1 src2 rep -- )
 187 HOOK: %saturated-sub-vector cpu ( dst src1 src2 rep -- )
 188 HOOK: %mul-vector cpu ( dst src1 src2 rep -- )
 189 HOOK: %saturated-mul-vector cpu ( dst src1 src2 rep -- )
 190 HOOK: %div-vector cpu ( dst src1 src2 rep -- )
 191 HOOK: %min-vector cpu ( dst src1 src2 rep -- )
 192 HOOK: %max-vector cpu ( dst src1 src2 rep -- )
 193 HOOK: %sqrt-vector cpu ( dst src rep -- )
 194 HOOK: %horizontal-add-vector cpu ( dst src rep -- )
 195
 196 HOOK: %broadcast-vector-reps cpu ( -- reps )
 197 HOOK: %gather-vector-2-reps cpu ( -- reps )
 198 HOOK: %gather-vector-4-reps cpu ( -- reps )
 199 HOOK: %add-vector-reps cpu ( -- reps )
 200 HOOK: %saturated-add-vector-reps cpu ( -- reps )
 201 HOOK: %add-sub-vector-reps cpu ( -- reps )
 202 HOOK: %sub-vector-reps cpu ( -- reps )
 203 HOOK: %saturated-sub-vector-reps cpu ( -- reps )
 204 HOOK: %mul-vector-reps cpu ( -- reps )
 205 HOOK: %saturated-mul-vector-reps cpu ( -- reps )
 206 HOOK: %div-vector-reps cpu ( -- reps )
 207 HOOK: %min-vector-reps cpu ( -- reps )
 208 HOOK: %max-vector-reps cpu ( -- reps )
 209 HOOK: %sqrt-vector-reps cpu ( -- reps )
 210 HOOK: %horizontal-add-vector-reps cpu ( -- reps )
 211
 212 HOOK: %unbox-alien cpu ( dst src -- )
 213 HOOK: %unbox-any-c-ptr cpu ( dst src temp -- )
 214 HOOK: %box-alien cpu ( dst src temp -- )
 215 HOOK: %box-displaced-alien cpu ( dst displacement base temp1 temp2 base-class -- )
 216
 217 HOOK: %alien-unsigned-1 cpu ( dst src -- )
 218 HOOK: %alien-unsigned-2 cpu ( dst src -- )
 219 HOOK: %alien-unsigned-4 cpu ( dst src -- )
 220 HOOK: %alien-signed-1   cpu ( dst src -- )
 221 HOOK: %alien-signed-2   cpu ( dst src -- )
 222 HOOK: %alien-signed-4   cpu ( dst src -- )
 223 HOOK: %alien-cell       cpu ( dst src -- )
 224 HOOK: %alien-float      cpu ( dst src -- )
 225 HOOK: %alien-double     cpu ( dst src -- )
 226 HOOK: %alien-vector     cpu ( dst src rep -- )
 227
 228 HOOK: %set-alien-integer-1 cpu ( ptr value -- )
 229 HOOK: %set-alien-integer-2 cpu ( ptr value -- )
 230 HOOK: %set-alien-integer-4 cpu ( ptr value -- )
 231 HOOK: %set-alien-cell      cpu ( ptr value -- )
 232 HOOK: %set-alien-float     cpu ( ptr value -- )
 233 HOOK: %set-alien-double    cpu ( ptr value -- )
 234 HOOK: %set-alien-vector    cpu ( ptr value rep -- )
 235
 236 HOOK: %alien-global cpu ( dst symbol library -- )
 237 HOOK: %vm-field-ptr cpu ( dst fieldname -- )
 238
 239 HOOK: %allot cpu ( dst size class temp -- )
 240 HOOK: %write-barrier cpu ( src card# table -- )
 241
 242 ! GC checks
 243 HOOK: %check-nursery cpu ( label temp1 temp2 -- )
 244 HOOK: %save-gc-root cpu ( gc-root register -- )
 245 HOOK: %load-gc-root cpu ( gc-root register -- )
 246 HOOK: %call-gc cpu ( gc-root-count -- )
 247
 248 HOOK: %prologue cpu ( n -- )
 249 HOOK: %epilogue cpu ( n -- )
 250
 251 HOOK: %compare cpu ( dst temp cc src1 src2 -- )
 252 HOOK: %compare-imm cpu ( dst temp cc src1 src2 -- )
 253 HOOK: %compare-float-ordered cpu ( dst temp cc src1 src2 -- )
 254 HOOK: %compare-float-unordered cpu ( dst temp cc src1 src2 -- )
 255
 256 HOOK: %compare-branch cpu ( label cc src1 src2 -- )
 257 HOOK: %compare-imm-branch cpu ( label cc src1 src2 -- )
 258 HOOK: %compare-float-ordered-branch cpu ( label cc src1 src2 -- )
 259 HOOK: %compare-float-unordered-branch cpu ( label cc src1 src2 -- )
 260
 261 HOOK: %spill cpu ( src rep n -- )
 262 HOOK: %reload cpu ( dst rep n -- )
 263
 264 HOOK: %loop-entry cpu ( -- )
 265
 266 ! FFI stuff
 267
 268 ! Return values of this class go here
 269 GENERIC: return-reg ( reg-class -- reg )
 270
 271 ! Sequence of registers used for parameter passing in class
 272 GENERIC: param-regs ( reg-class -- regs )
 273
 274 M: stack-params param-regs drop f ;
 275
 276 GENERIC: param-reg ( n reg-class -- reg )
 277
 278 M: reg-class param-reg param-regs nth ;
 279
 280 M: stack-params param-reg drop ;
 281
 282 ! Is this integer small enough to appear in value template
 283 ! slots?
 284 HOOK: small-enough? cpu ( n -- ? )
 285
 286 ! Is this structure small enough to be returned in registers?
 287 HOOK: return-struct-in-registers? cpu ( c-type -- ? )
 288
 289 ! Do we pass this struct by value or hidden reference?
 290 HOOK: value-struct? cpu ( c-type -- ? )
 291
 292 ! If t, all parameters are shadowed by dummy stack parameters
 293 HOOK: dummy-stack-params? cpu ( -- ? )
 294
 295 ! If t, all FP parameters are shadowed by dummy int parameters
 296 HOOK: dummy-int-params? cpu ( -- ? )
 297
 298 ! If t, all int parameters are shadowed by dummy FP parameters
 299 HOOK: dummy-fp-params? cpu ( -- ? )
 300
 301 HOOK: %prepare-unbox cpu ( -- )
 302
 303 HOOK: %unbox cpu ( n rep func -- )
 304
 305 HOOK: %unbox-long-long cpu ( n func -- )
 306
 307 HOOK: %unbox-small-struct cpu ( c-type -- )
 308
 309 HOOK: %unbox-large-struct cpu ( n c-type -- )
 310
 311 HOOK: %box cpu ( n rep func -- )
 312
 313 HOOK: %box-long-long cpu ( n func -- )
 314
 315 HOOK: %prepare-box-struct cpu ( -- )
 316
 317 HOOK: %box-small-struct cpu ( c-type -- )
 318
 319 HOOK: %box-large-struct cpu ( n c-type -- )
 320
 321 HOOK: %save-param-reg cpu ( stack reg rep -- )
 322
 323 HOOK: %load-param-reg cpu ( stack reg rep -- )
 324
 325 HOOK: %save-context cpu ( temp1 temp2 callback-allowed? -- )
 326
 327 HOOK: %prepare-var-args cpu ( -- )
 328
 329 M: object %prepare-var-args ;
 330
 331 HOOK: %alien-invoke cpu ( function library -- )
 332
 333 HOOK: %vm-invoke-1st-arg cpu ( function -- )
 334 HOOK: %vm-invoke-3rd-arg cpu ( function -- )
 335
 336 HOOK: %cleanup cpu ( params -- )
 337
 338 M: object %cleanup ( params -- ) drop ;
 339
 340 HOOK: %prepare-alien-indirect cpu ( -- )
 341
 342 HOOK: %alien-indirect cpu ( -- )
 343
 344 HOOK: %alien-callback cpu ( quot -- )
 345
 346 HOOK: %callback-value cpu ( ctype -- )
 347
 348 ! Return to caller with stdcall unwinding (only for x86)
 349 HOOK: %callback-return cpu ( params -- )
 350
 351 M: object %callback-return drop %return ;