-
Notifications
You must be signed in to change notification settings - Fork 0
/
CmmParse.y
1431 lines (1214 loc) · 54.9 KB
/
CmmParse.y
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
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
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
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
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
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
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
-----------------------------------------------------------------------------
--
-- (c) The University of Glasgow, 2004-2012
--
-- Parser for concrete Cmm.
--
-----------------------------------------------------------------------------
{- -----------------------------------------------------------------------------
Note [Syntax of .cmm files]
NOTE: You are very much on your own in .cmm. There is very little
error checking at all:
* Type errors are detected by the (optional) -dcmm-lint pass, if you
don't turn this on then a type error will likely result in a panic
from the native code generator.
* Passing the wrong number of arguments or arguments of the wrong
type is not detected.
There are two ways to write .cmm code:
(1) High-level Cmm code delegates the stack handling to GHC, and
never explicitly mentions Sp or registers.
(2) Low-level Cmm manages the stack itself, and must know about
calling conventions.
Whether you want high-level or low-level Cmm is indicated by the
presence of an argument list on a procedure. For example:
foo ( gcptr a, bits32 b )
{
// this is high-level cmm code
if (b > 0) {
// we can make tail calls passing arguments:
jump stg_ap_0_fast(a);
}
push (stg_upd_frame_info, a) {
// stack frames can be explicitly pushed
(x,y) = call wibble(a,b,3,4);
// calls pass arguments and return results using the native
// Haskell calling convention. The code generator will automatically
// construct a stack frame and an info table for the continuation.
return (x,y);
// we can return multiple values from the current proc
}
}
bar
{
// this is low-level cmm code, indicated by the fact that we did not
// put an argument list on bar.
x = R1; // the calling convention is explicit: better be careful
// that this works on all platforms!
jump %ENTRY_CODE(Sp(0))
}
Here is a list of rules for high-level and low-level code. If you
break the rules, you get a panic (for using a high-level construct in
a low-level proc), or wrong code (when using low-level code in a
high-level proc). This stuff isn't checked! (TODO!)
High-level only:
- tail-calls with arguments, e.g.
jump stg_fun (arg1, arg2);
- function calls:
(ret1,ret2) = call stg_fun (arg1, arg2);
This makes a call with the NativeNodeCall convention, and the
values are returned to the following code using the NativeReturn
convention.
- returning:
return (ret1, ret2)
These use the NativeReturn convention to return zero or more
results to the caller.
- pushing stack frames:
push (info_ptr, field1, ..., fieldN) { ... statements ... }
- reserving temporary stack space:
reserve N = x { ... }
this reserves an area of size N (words) on the top of the stack,
and binds its address to x (a local register). Typically this is
used for allocating temporary storage for passing to foreign
functions.
Note that if you make any native calls or invoke the GC in the
scope of the reserve block, you are responsible for ensuring that
the stack you reserved is laid out correctly with an info table.
Low-level only:
- References to Sp, R1-R8, F1-F4 etc.
NB. foreign calls may clobber the argument registers R1-R8, F1-F4
etc., so ensure they are saved into variables around foreign
calls.
- SAVE_THREAD_STATE() and LOAD_THREAD_STATE(), which modify Sp
directly.
Both high-level and low-level code can use a raw tail-call:
jump stg_fun [R1,R2]
NB. you *must* specify the list of GlobalRegs that are passed via a
jump, otherwise the register allocator will assume that all the
GlobalRegs are dead at the jump.
Calling Conventions
-------------------
High-level procedures use the NativeNode calling convention, or the
NativeReturn convention if the 'return' keyword is used (see Stack
Frames below).
Low-level procedures implement their own calling convention, so it can
be anything at all.
If a low-level procedure implements the NativeNode calling convention,
then it can be called by high-level code using an ordinary function
call. In general this is hard to arrange because the calling
convention depends on the number of physical registers available for
parameter passing, but there are two cases where the calling
convention is platform-independent:
- Zero arguments.
- One argument of pointer or non-pointer word type; this is always
passed in R1 according to the NativeNode convention.
- Returning a single value; these conventions are fixed and platform
independent.
Stack Frames
------------
A stack frame is written like this:
INFO_TABLE_RET ( label, FRAME_TYPE, info_ptr, field1, ..., fieldN )
return ( arg1, ..., argM )
{
... code ...
}
where field1 ... fieldN are the fields of the stack frame (with types)
arg1...argN are the values returned to the stack frame (with types).
The return values are assumed to be passed according to the
NativeReturn convention.
On entry to the code, the stack frame looks like:
|----------|
| fieldN |
| ... |
| field1 |
|----------|
| info_ptr |
|----------|
| argN |
| ... | <- Sp
and some of the args may be in registers.
We prepend the code by a copyIn of the args, and assign all the stack
frame fields to their formals. The initial "arg offset" for stack
layout purposes consists of the whole stack frame plus any args that
might be on the stack.
A tail-call may pass a stack frame to the callee using the following
syntax:
jump f (info_ptr, field1,..,fieldN) (arg1,..,argN)
where info_ptr and field1..fieldN describe the stack frame, and
arg1..argN are the arguments passed to f using the NativeNodeCall
convention. Note if a field is longer than a word (e.g. a D_ on
a 32-bit machine) then the call will push as many words as
necessary to the stack to accommodate it (e.g. 2).
----------------------------------------------------------------------------- -}
{
module CmmParse ( parseCmmFile ) where
import StgCmmExtCode
import CmmCallConv
import StgCmmProf
import StgCmmHeap
import StgCmmMonad hiding ( getCode, getCodeR, getCodeScoped, emitLabel, emit, emitStore
, emitAssign, emitOutOfLine, withUpdFrameOff
, getUpdFrameOff )
import qualified StgCmmMonad as F
import StgCmmUtils
import StgCmmForeign
import StgCmmExpr
import StgCmmClosure
import StgCmmLayout hiding (ArgRep(..))
import StgCmmTicky
import StgCmmBind ( emitBlackHoleCode, emitUpdateFrame )
import CoreSyn ( Tickish(SourceNote) )
import CmmOpt
import MkGraph
import Cmm
import CmmUtils
import CmmSwitch ( mkSwitchTargets )
import CmmInfo
import BlockId
import CmmLex
import CLabel
import SMRep
import Lexer
import CmmMonad
import CostCentre
import ForeignCall
import Module
import Platform
import Literal
import Unique
import UniqFM
import SrcLoc
import DynFlags
import ErrUtils
import StringBuffer
import FastString
import Panic
import Constants
import Outputable
import BasicTypes
import Bag ( emptyBag, unitBag )
import Var
import Control.Monad
import Data.Array
import Data.Char ( ord )
import System.Exit
import Data.Maybe
import qualified Data.Map as M
#include "HsVersions.h"
}
%expect 0
%token
':' { L _ (CmmT_SpecChar ':') }
';' { L _ (CmmT_SpecChar ';') }
'{' { L _ (CmmT_SpecChar '{') }
'}' { L _ (CmmT_SpecChar '}') }
'[' { L _ (CmmT_SpecChar '[') }
']' { L _ (CmmT_SpecChar ']') }
'(' { L _ (CmmT_SpecChar '(') }
')' { L _ (CmmT_SpecChar ')') }
'=' { L _ (CmmT_SpecChar '=') }
'`' { L _ (CmmT_SpecChar '`') }
'~' { L _ (CmmT_SpecChar '~') }
'/' { L _ (CmmT_SpecChar '/') }
'*' { L _ (CmmT_SpecChar '*') }
'%' { L _ (CmmT_SpecChar '%') }
'-' { L _ (CmmT_SpecChar '-') }
'+' { L _ (CmmT_SpecChar '+') }
'&' { L _ (CmmT_SpecChar '&') }
'^' { L _ (CmmT_SpecChar '^') }
'|' { L _ (CmmT_SpecChar '|') }
'>' { L _ (CmmT_SpecChar '>') }
'<' { L _ (CmmT_SpecChar '<') }
',' { L _ (CmmT_SpecChar ',') }
'!' { L _ (CmmT_SpecChar '!') }
'..' { L _ (CmmT_DotDot) }
'::' { L _ (CmmT_DoubleColon) }
'>>' { L _ (CmmT_Shr) }
'<<' { L _ (CmmT_Shl) }
'>=' { L _ (CmmT_Ge) }
'<=' { L _ (CmmT_Le) }
'==' { L _ (CmmT_Eq) }
'!=' { L _ (CmmT_Ne) }
'&&' { L _ (CmmT_BoolAnd) }
'||' { L _ (CmmT_BoolOr) }
'CLOSURE' { L _ (CmmT_CLOSURE) }
'INFO_TABLE' { L _ (CmmT_INFO_TABLE) }
'INFO_TABLE_RET'{ L _ (CmmT_INFO_TABLE_RET) }
'INFO_TABLE_FUN'{ L _ (CmmT_INFO_TABLE_FUN) }
'INFO_TABLE_CONSTR'{ L _ (CmmT_INFO_TABLE_CONSTR) }
'INFO_TABLE_SELECTOR'{ L _ (CmmT_INFO_TABLE_SELECTOR) }
'else' { L _ (CmmT_else) }
'export' { L _ (CmmT_export) }
'section' { L _ (CmmT_section) }
'goto' { L _ (CmmT_goto) }
'if' { L _ (CmmT_if) }
'call' { L _ (CmmT_call) }
'jump' { L _ (CmmT_jump) }
'foreign' { L _ (CmmT_foreign) }
'never' { L _ (CmmT_never) }
'prim' { L _ (CmmT_prim) }
'reserve' { L _ (CmmT_reserve) }
'return' { L _ (CmmT_return) }
'returns' { L _ (CmmT_returns) }
'import' { L _ (CmmT_import) }
'switch' { L _ (CmmT_switch) }
'case' { L _ (CmmT_case) }
'default' { L _ (CmmT_default) }
'push' { L _ (CmmT_push) }
'unwind' { L _ (CmmT_unwind) }
'bits8' { L _ (CmmT_bits8) }
'bits16' { L _ (CmmT_bits16) }
'bits32' { L _ (CmmT_bits32) }
'bits64' { L _ (CmmT_bits64) }
'bits128' { L _ (CmmT_bits128) }
'bits256' { L _ (CmmT_bits256) }
'bits512' { L _ (CmmT_bits512) }
'float32' { L _ (CmmT_float32) }
'float64' { L _ (CmmT_float64) }
'gcptr' { L _ (CmmT_gcptr) }
GLOBALREG { L _ (CmmT_GlobalReg $$) }
NAME { L _ (CmmT_Name $$) }
STRING { L _ (CmmT_String $$) }
INT { L _ (CmmT_Int $$) }
FLOAT { L _ (CmmT_Float $$) }
%monad { PD } { >>= } { return }
%lexer { cmmlex } { L _ CmmT_EOF }
%name cmmParse cmm
%tokentype { Located CmmToken }
-- C-- operator precedences, taken from the C-- spec
%right '||' -- non-std extension, called %disjoin in C--
%right '&&' -- non-std extension, called %conjoin in C--
%right '!'
%nonassoc '>=' '>' '<=' '<' '!=' '=='
%left '|'
%left '^'
%left '&'
%left '>>' '<<'
%left '-' '+'
%left '/' '*' '%'
%right '~'
%%
cmm :: { CmmParse () }
: {- empty -} { return () }
| cmmtop cmm { do $1; $2 }
cmmtop :: { CmmParse () }
: cmmproc { $1 }
| cmmdata { $1 }
| decl { $1 }
| 'CLOSURE' '(' NAME ',' NAME lits ')' ';'
{% liftP . withThisPackage $ \pkg ->
do lits <- sequence $6;
staticClosure pkg $3 $5 (map getLit lits) }
-- The only static closures in the RTS are dummy closures like
-- stg_END_TSO_QUEUE_closure and stg_dummy_ret. We don't need
-- to provide the full generality of static closures here.
-- In particular:
-- * CCS can always be CCS_DONT_CARE
-- * closure is always extern
-- * payload is always empty
-- * we can derive closure and info table labels from a single NAME
cmmdata :: { CmmParse () }
: 'section' STRING '{' data_label statics '}'
{ do lbl <- $4;
ss <- sequence $5;
code (emitDecl (CmmData (Section (section $2) lbl) (Statics lbl $ concat ss))) }
data_label :: { CmmParse CLabel }
: NAME ':'
{% liftP . withThisPackage $ \pkg ->
return (mkCmmDataLabel pkg $1) }
statics :: { [CmmParse [CmmStatic]] }
: {- empty -} { [] }
| static statics { $1 : $2 }
-- Strings aren't used much in the RTS HC code, so it doesn't seem
-- worth allowing inline strings. C-- doesn't allow them anyway.
static :: { CmmParse [CmmStatic] }
: type expr ';' { do e <- $2;
return [CmmStaticLit (getLit e)] }
| type ';' { return [CmmUninitialised
(widthInBytes (typeWidth $1))] }
| 'bits8' '[' ']' STRING ';' { return [mkString $4] }
| 'bits8' '[' INT ']' ';' { return [CmmUninitialised
(fromIntegral $3)] }
| typenot8 '[' INT ']' ';' { return [CmmUninitialised
(widthInBytes (typeWidth $1) *
fromIntegral $3)] }
| 'CLOSURE' '(' NAME lits ')'
{ do { lits <- sequence $4
; dflags <- getDynFlags
; return $ map CmmStaticLit $
mkStaticClosure dflags (mkForeignLabel $3 Nothing ForeignLabelInExternalPackage IsData)
-- mkForeignLabel because these are only used
-- for CHARLIKE and INTLIKE closures in the RTS.
dontCareCCS (map getLit lits) [] [] [] } }
-- arrays of closures required for the CHARLIKE & INTLIKE arrays
lits :: { [CmmParse CmmExpr] }
: {- empty -} { [] }
| ',' expr lits { $2 : $3 }
cmmproc :: { CmmParse () }
: info maybe_conv maybe_formals maybe_body
{ do ((entry_ret_label, info, stk_formals, formals), agraph) <-
getCodeScoped $ loopDecls $ do {
(entry_ret_label, info, stk_formals) <- $1;
dflags <- getDynFlags;
formals <- sequence (fromMaybe [] $3);
withName (showSDoc dflags (ppr entry_ret_label))
$4;
return (entry_ret_label, info, stk_formals, formals) }
let do_layout = isJust $3
code (emitProcWithStackFrame $2 info
entry_ret_label stk_formals formals agraph
do_layout ) }
maybe_conv :: { Convention }
: {- empty -} { NativeNodeCall }
| 'return' { NativeReturn }
maybe_body :: { CmmParse () }
: ';' { return () }
| '{' body '}' { withSourceNote $1 $3 $2 }
info :: { CmmParse (CLabel, Maybe CmmInfoTable, [LocalReg]) }
: NAME
{% liftP . withThisPackage $ \pkg ->
do newFunctionName $1 pkg
return (mkCmmCodeLabel pkg $1, Nothing, []) }
| 'INFO_TABLE' '(' NAME ',' INT ',' INT ',' INT ',' STRING ',' STRING ')'
-- ptrs, nptrs, closure type, description, type
{% liftP . withThisPackage $ \pkg ->
do dflags <- getDynFlags
let prof = profilingInfo dflags $11 $13
rep = mkRTSRep (fromIntegral $9) $
mkHeapRep dflags False (fromIntegral $5)
(fromIntegral $7) Thunk
-- not really Thunk, but that makes the info table
-- we want.
return (mkCmmEntryLabel pkg $3,
Just $ CmmInfoTable { cit_lbl = mkCmmInfoLabel pkg $3
, cit_rep = rep
, cit_prof = prof, cit_srt = NoC_SRT },
[]) }
| 'INFO_TABLE_FUN' '(' NAME ',' INT ',' INT ',' INT ',' STRING ',' STRING ',' INT ')'
-- ptrs, nptrs, closure type, description, type, fun type
{% liftP . withThisPackage $ \pkg ->
do dflags <- getDynFlags
let prof = profilingInfo dflags $11 $13
ty = Fun 0 (ArgSpec (fromIntegral $15))
-- Arity zero, arg_type $15
rep = mkRTSRep (fromIntegral $9) $
mkHeapRep dflags False (fromIntegral $5)
(fromIntegral $7) ty
return (mkCmmEntryLabel pkg $3,
Just $ CmmInfoTable { cit_lbl = mkCmmInfoLabel pkg $3
, cit_rep = rep
, cit_prof = prof, cit_srt = NoC_SRT },
[]) }
-- we leave most of the fields zero here. This is only used
-- to generate the BCO info table in the RTS at the moment.
| 'INFO_TABLE_CONSTR' '(' NAME ',' INT ',' INT ',' INT ',' INT ',' STRING ',' STRING ')'
-- ptrs, nptrs, tag, closure type, description, type
{% liftP . withThisPackage $ \pkg ->
do dflags <- getDynFlags
let prof = profilingInfo dflags $13 $15
ty = Constr (fromIntegral $9) -- Tag
(stringToWord8s $13)
rep = mkRTSRep (fromIntegral $11) $
mkHeapRep dflags False (fromIntegral $5)
(fromIntegral $7) ty
return (mkCmmEntryLabel pkg $3,
Just $ CmmInfoTable { cit_lbl = mkCmmInfoLabel pkg $3
, cit_rep = rep
, cit_prof = prof, cit_srt = NoC_SRT },
[]) }
-- If profiling is on, this string gets duplicated,
-- but that's the way the old code did it we can fix it some other time.
| 'INFO_TABLE_SELECTOR' '(' NAME ',' INT ',' INT ',' STRING ',' STRING ')'
-- selector, closure type, description, type
{% liftP . withThisPackage $ \pkg ->
do dflags <- getDynFlags
let prof = profilingInfo dflags $9 $11
ty = ThunkSelector (fromIntegral $5)
rep = mkRTSRep (fromIntegral $7) $
mkHeapRep dflags False 0 0 ty
return (mkCmmEntryLabel pkg $3,
Just $ CmmInfoTable { cit_lbl = mkCmmInfoLabel pkg $3
, cit_rep = rep
, cit_prof = prof, cit_srt = NoC_SRT },
[]) }
| 'INFO_TABLE_RET' '(' NAME ',' INT ')'
-- closure type (no live regs)
{% liftP . withThisPackage $ \pkg ->
do let prof = NoProfilingInfo
rep = mkRTSRep (fromIntegral $5) $ mkStackRep []
return (mkCmmRetLabel pkg $3,
Just $ CmmInfoTable { cit_lbl = mkCmmRetInfoLabel pkg $3
, cit_rep = rep
, cit_prof = prof, cit_srt = NoC_SRT },
[]) }
| 'INFO_TABLE_RET' '(' NAME ',' INT ',' formals0 ')'
-- closure type, live regs
{% liftP . withThisPackage $ \pkg ->
do dflags <- getDynFlags
live <- sequence $7
let prof = NoProfilingInfo
-- drop one for the info pointer
bitmap = mkLiveness dflags (map Just (drop 1 live))
rep = mkRTSRep (fromIntegral $5) $ mkStackRep bitmap
return (mkCmmRetLabel pkg $3,
Just $ CmmInfoTable { cit_lbl = mkCmmRetInfoLabel pkg $3
, cit_rep = rep
, cit_prof = prof, cit_srt = NoC_SRT },
live) }
body :: { CmmParse () }
: {- empty -} { return () }
| decl body { do $1; $2 }
| stmt body { do $1; $2 }
decl :: { CmmParse () }
: type names ';' { mapM_ (newLocal $1) $2 }
| 'import' importNames ';' { mapM_ newImport $2 }
| 'export' names ';' { return () } -- ignore exports
-- an imported function name, with optional packageId
importNames
:: { [(FastString, CLabel)] }
: importName { [$1] }
| importName ',' importNames { $1 : $3 }
importName
:: { (FastString, CLabel) }
-- A label imported without an explicit packageId.
-- These are taken to come frome some foreign, unnamed package.
: NAME
{ ($1, mkForeignLabel $1 Nothing ForeignLabelInExternalPackage IsFunction) }
-- as previous 'NAME', but 'IsData'
| 'CLOSURE' NAME
{ ($2, mkForeignLabel $2 Nothing ForeignLabelInExternalPackage IsData) }
-- A label imported with an explicit packageId.
| STRING NAME
{ ($2, mkCmmCodeLabel (fsToUnitId (mkFastString $1)) $2) }
names :: { [FastString] }
: NAME { [$1] }
| NAME ',' names { $1 : $3 }
stmt :: { CmmParse () }
: ';' { return () }
| NAME ':'
{ do l <- newLabel $1; emitLabel l }
| lreg '=' expr ';'
{ do reg <- $1; e <- $3; withSourceNote $2 $4 (emitAssign reg e) }
| type '[' expr ']' '=' expr ';'
{ withSourceNote $2 $7 (doStore $1 $3 $6) }
-- Gah! We really want to say "foreign_results" but that causes
-- a shift/reduce conflict with assignment. We either
-- we expand out the no-result and single result cases or
-- we tweak the syntax to avoid the conflict. The later
-- option is taken here because the other way would require
-- multiple levels of expanding and get unwieldy.
| foreign_results 'foreign' STRING foreignLabel '(' cmm_hint_exprs0 ')' safety opt_never_returns ';'
{% foreignCall $3 $1 $4 $6 $8 $9 }
| foreign_results 'prim' '%' NAME '(' exprs0 ')' ';'
{% primCall $1 $4 $6 }
-- stmt-level macros, stealing syntax from ordinary C-- function calls.
-- Perhaps we ought to use the %%-form?
| NAME '(' exprs0 ')' ';'
{% stmtMacro $1 $3 }
| 'switch' maybe_range expr '{' arms default '}'
{ do as <- sequence $5; doSwitch $2 $3 as $6 }
| 'goto' NAME ';'
{ do l <- lookupLabel $2; emit (mkBranch l) }
| 'return' '(' exprs0 ')' ';'
{ doReturn $3 }
| 'jump' expr vols ';'
{ doRawJump $2 $3 }
| 'jump' expr '(' exprs0 ')' ';'
{ doJumpWithStack $2 [] $4 }
| 'jump' expr '(' exprs0 ')' '(' exprs0 ')' ';'
{ doJumpWithStack $2 $4 $7 }
| 'call' expr '(' exprs0 ')' ';'
{ doCall $2 [] $4 }
| '(' formals ')' '=' 'call' expr '(' exprs0 ')' ';'
{ doCall $6 $2 $8 }
| 'if' bool_expr 'goto' NAME
{ do l <- lookupLabel $4; cmmRawIf $2 l }
| 'if' bool_expr '{' body '}' else
{ cmmIfThenElse $2 (withSourceNote $3 $5 $4) $6 }
| 'push' '(' exprs0 ')' maybe_body
{ pushStackFrame $3 $5 }
| 'reserve' expr '=' lreg maybe_body
{ reserveStackFrame $2 $4 $5 }
| 'unwind' unwind_regs ';'
{ $2 >>= code . emitUnwind }
unwind_regs
:: { CmmParse [(GlobalReg, Maybe CmmExpr)] }
: GLOBALREG '=' expr_or_unknown ',' unwind_regs
{ do e <- $3; rest <- $5; return (($1, e) : rest) }
| GLOBALREG '=' expr_or_unknown
{ do e <- $3; return [($1, e)] }
-- | Used by unwind to indicate unknown unwinding values.
expr_or_unknown
:: { CmmParse (Maybe CmmExpr) }
: 'return'
{ do return Nothing }
| expr
{ do e <- $1; return (Just e) }
foreignLabel :: { CmmParse CmmExpr }
: NAME { return (CmmLit (CmmLabel (mkForeignLabel $1 Nothing ForeignLabelInThisPackage IsFunction))) }
opt_never_returns :: { CmmReturnInfo }
: { CmmMayReturn }
| 'never' 'returns' { CmmNeverReturns }
bool_expr :: { CmmParse BoolExpr }
: bool_op { $1 }
| expr { do e <- $1; return (BoolTest e) }
bool_op :: { CmmParse BoolExpr }
: bool_expr '&&' bool_expr { do e1 <- $1; e2 <- $3;
return (BoolAnd e1 e2) }
| bool_expr '||' bool_expr { do e1 <- $1; e2 <- $3;
return (BoolOr e1 e2) }
| '!' bool_expr { do e <- $2; return (BoolNot e) }
| '(' bool_op ')' { $2 }
safety :: { Safety }
: {- empty -} { PlayRisky }
| STRING {% parseSafety $1 }
vols :: { [GlobalReg] }
: '[' ']' { [] }
| '[' '*' ']' {% do df <- getDynFlags
; return (realArgRegsCover df) }
-- All of them. See comment attached
-- to realArgRegsCover
| '[' globals ']' { $2 }
globals :: { [GlobalReg] }
: GLOBALREG { [$1] }
| GLOBALREG ',' globals { $1 : $3 }
maybe_range :: { Maybe (Integer,Integer) }
: '[' INT '..' INT ']' { Just ($2, $4) }
| {- empty -} { Nothing }
arms :: { [CmmParse ([Integer],Either BlockId (CmmParse ()))] }
: {- empty -} { [] }
| arm arms { $1 : $2 }
arm :: { CmmParse ([Integer],Either BlockId (CmmParse ())) }
: 'case' ints ':' arm_body { do b <- $4; return ($2, b) }
arm_body :: { CmmParse (Either BlockId (CmmParse ())) }
: '{' body '}' { return (Right (withSourceNote $1 $3 $2)) }
| 'goto' NAME ';' { do l <- lookupLabel $2; return (Left l) }
ints :: { [Integer] }
: INT { [ $1 ] }
| INT ',' ints { $1 : $3 }
default :: { Maybe (CmmParse ()) }
: 'default' ':' '{' body '}' { Just (withSourceNote $3 $5 $4) }
-- taking a few liberties with the C-- syntax here; C-- doesn't have
-- 'default' branches
| {- empty -} { Nothing }
-- Note: OldCmm doesn't support a first class 'else' statement, though
-- CmmNode does.
else :: { CmmParse () }
: {- empty -} { return () }
| 'else' '{' body '}' { withSourceNote $2 $4 $3 }
-- we have to write this out longhand so that Happy's precedence rules
-- can kick in.
expr :: { CmmParse CmmExpr }
: expr '/' expr { mkMachOp MO_U_Quot [$1,$3] }
| expr '*' expr { mkMachOp MO_Mul [$1,$3] }
| expr '%' expr { mkMachOp MO_U_Rem [$1,$3] }
| expr '-' expr { mkMachOp MO_Sub [$1,$3] }
| expr '+' expr { mkMachOp MO_Add [$1,$3] }
| expr '>>' expr { mkMachOp MO_U_Shr [$1,$3] }
| expr '<<' expr { mkMachOp MO_Shl [$1,$3] }
| expr '&' expr { mkMachOp MO_And [$1,$3] }
| expr '^' expr { mkMachOp MO_Xor [$1,$3] }
| expr '|' expr { mkMachOp MO_Or [$1,$3] }
| expr '>=' expr { mkMachOp MO_U_Ge [$1,$3] }
| expr '>' expr { mkMachOp MO_U_Gt [$1,$3] }
| expr '<=' expr { mkMachOp MO_U_Le [$1,$3] }
| expr '<' expr { mkMachOp MO_U_Lt [$1,$3] }
| expr '!=' expr { mkMachOp MO_Ne [$1,$3] }
| expr '==' expr { mkMachOp MO_Eq [$1,$3] }
| '~' expr { mkMachOp MO_Not [$2] }
| '-' expr { mkMachOp MO_S_Neg [$2] }
| expr0 '`' NAME '`' expr0 {% do { mo <- nameToMachOp $3 ;
return (mkMachOp mo [$1,$5]) } }
| expr0 { $1 }
expr0 :: { CmmParse CmmExpr }
: INT maybe_ty { return (CmmLit (CmmInt $1 (typeWidth $2))) }
| FLOAT maybe_ty { return (CmmLit (CmmFloat $1 (typeWidth $2))) }
| STRING { do s <- code (newStringCLit $1);
return (CmmLit s) }
| reg { $1 }
| type '[' expr ']' { do e <- $3; return (CmmLoad e $1) }
| '%' NAME '(' exprs0 ')' {% exprOp $2 $4 }
| '(' expr ')' { $2 }
-- leaving out the type of a literal gives you the native word size in C--
maybe_ty :: { CmmType }
: {- empty -} {% do dflags <- getDynFlags; return $ bWord dflags }
| '::' type { $2 }
cmm_hint_exprs0 :: { [CmmParse (CmmExpr, ForeignHint)] }
: {- empty -} { [] }
| cmm_hint_exprs { $1 }
cmm_hint_exprs :: { [CmmParse (CmmExpr, ForeignHint)] }
: cmm_hint_expr { [$1] }
| cmm_hint_expr ',' cmm_hint_exprs { $1 : $3 }
cmm_hint_expr :: { CmmParse (CmmExpr, ForeignHint) }
: expr { do e <- $1;
return (e, inferCmmHint e) }
| expr STRING {% do h <- parseCmmHint $2;
return $ do
e <- $1; return (e, h) }
exprs0 :: { [CmmParse CmmExpr] }
: {- empty -} { [] }
| exprs { $1 }
exprs :: { [CmmParse CmmExpr] }
: expr { [ $1 ] }
| expr ',' exprs { $1 : $3 }
reg :: { CmmParse CmmExpr }
: NAME { lookupName $1 }
| GLOBALREG { return (CmmReg (CmmGlobal $1)) }
foreign_results :: { [CmmParse (LocalReg, ForeignHint)] }
: {- empty -} { [] }
| '(' foreign_formals ')' '=' { $2 }
foreign_formals :: { [CmmParse (LocalReg, ForeignHint)] }
: foreign_formal { [$1] }
| foreign_formal ',' { [$1] }
| foreign_formal ',' foreign_formals { $1 : $3 }
foreign_formal :: { CmmParse (LocalReg, ForeignHint) }
: local_lreg { do e <- $1; return (e, (inferCmmHint (CmmReg (CmmLocal e)))) }
| STRING local_lreg {% do h <- parseCmmHint $1;
return $ do
e <- $2; return (e,h) }
local_lreg :: { CmmParse LocalReg }
: NAME { do e <- lookupName $1;
return $
case e of
CmmReg (CmmLocal r) -> r
other -> pprPanic "CmmParse:" (ftext $1 <> text " not a local register") }
lreg :: { CmmParse CmmReg }
: NAME { do e <- lookupName $1;
return $
case e of
CmmReg r -> r
other -> pprPanic "CmmParse:" (ftext $1 <> text " not a register") }
| GLOBALREG { return (CmmGlobal $1) }
maybe_formals :: { Maybe [CmmParse LocalReg] }
: {- empty -} { Nothing }
| '(' formals0 ')' { Just $2 }
formals0 :: { [CmmParse LocalReg] }
: {- empty -} { [] }
| formals { $1 }
formals :: { [CmmParse LocalReg] }
: formal ',' { [$1] }
| formal { [$1] }
| formal ',' formals { $1 : $3 }
formal :: { CmmParse LocalReg }
: type NAME { newLocal $1 $2 }
type :: { CmmType }
: 'bits8' { b8 }
| typenot8 { $1 }
typenot8 :: { CmmType }
: 'bits16' { b16 }
| 'bits32' { b32 }
| 'bits64' { b64 }
| 'bits128' { b128 }
| 'bits256' { b256 }
| 'bits512' { b512 }
| 'float32' { f32 }
| 'float64' { f64 }
| 'gcptr' {% do dflags <- getDynFlags; return $ gcWord dflags }
{
section :: String -> SectionType
section "text" = Text
section "data" = Data
section "rodata" = ReadOnlyData
section "relrodata" = RelocatableReadOnlyData
section "bss" = UninitialisedData
section s = OtherSection s
mkString :: String -> CmmStatic
mkString s = CmmString (map (fromIntegral.ord) s)
-- |
-- Given an info table, decide what the entry convention for the proc
-- is. That is, for an INFO_TABLE_RET we want the return convention,
-- otherwise it is a NativeNodeCall.
--
infoConv :: Maybe CmmInfoTable -> Convention
infoConv Nothing = NativeNodeCall
infoConv (Just info)
| isStackRep (cit_rep info) = NativeReturn
| otherwise = NativeNodeCall
-- mkMachOp infers the type of the MachOp from the type of its first
-- argument. We assume that this is correct: for MachOps that don't have
-- symmetrical args (e.g. shift ops), the first arg determines the type of
-- the op.
mkMachOp :: (Width -> MachOp) -> [CmmParse CmmExpr] -> CmmParse CmmExpr
mkMachOp fn args = do
dflags <- getDynFlags
arg_exprs <- sequence args
return (CmmMachOp (fn (typeWidth (cmmExprType dflags (head arg_exprs)))) arg_exprs)
getLit :: CmmExpr -> CmmLit
getLit (CmmLit l) = l
getLit (CmmMachOp (MO_S_Neg _) [CmmLit (CmmInt i r)]) = CmmInt (negate i) r
getLit _ = panic "invalid literal" -- TODO messy failure
nameToMachOp :: FastString -> PD (Width -> MachOp)
nameToMachOp name =
case lookupUFM machOps name of
Nothing -> fail ("unknown primitive " ++ unpackFS name)
Just m -> return m
exprOp :: FastString -> [CmmParse CmmExpr] -> PD (CmmParse CmmExpr)
exprOp name args_code = do
dflags <- getDynFlags
case lookupUFM (exprMacros dflags) name of
Just f -> return $ do
args <- sequence args_code
return (f args)
Nothing -> do
mo <- nameToMachOp name
return $ mkMachOp mo args_code
exprMacros :: DynFlags -> UniqFM ([CmmExpr] -> CmmExpr)
exprMacros dflags = listToUFM [
( fsLit "ENTRY_CODE", \ [x] -> entryCode dflags x ),
( fsLit "INFO_PTR", \ [x] -> closureInfoPtr dflags x ),
( fsLit "STD_INFO", \ [x] -> infoTable dflags x ),
( fsLit "FUN_INFO", \ [x] -> funInfoTable dflags x ),
( fsLit "GET_ENTRY", \ [x] -> entryCode dflags (closureInfoPtr dflags x) ),
( fsLit "GET_STD_INFO", \ [x] -> infoTable dflags (closureInfoPtr dflags x) ),
( fsLit "GET_FUN_INFO", \ [x] -> funInfoTable dflags (closureInfoPtr dflags x) ),
( fsLit "INFO_TYPE", \ [x] -> infoTableClosureType dflags x ),
( fsLit "INFO_PTRS", \ [x] -> infoTablePtrs dflags x ),
( fsLit "INFO_NPTRS", \ [x] -> infoTableNonPtrs dflags x )
]
-- we understand a subset of C-- primitives:
machOps = listToUFM $
map (\(x, y) -> (mkFastString x, y)) [
( "add", MO_Add ),
( "sub", MO_Sub ),
( "eq", MO_Eq ),
( "ne", MO_Ne ),
( "mul", MO_Mul ),
( "neg", MO_S_Neg ),
( "quot", MO_S_Quot ),
( "rem", MO_S_Rem ),
( "divu", MO_U_Quot ),
( "modu", MO_U_Rem ),
( "ge", MO_S_Ge ),
( "le", MO_S_Le ),
( "gt", MO_S_Gt ),
( "lt", MO_S_Lt ),
( "geu", MO_U_Ge ),
( "leu", MO_U_Le ),
( "gtu", MO_U_Gt ),
( "ltu", MO_U_Lt ),
( "and", MO_And ),
( "or", MO_Or ),
( "xor", MO_Xor ),
( "com", MO_Not ),
( "shl", MO_Shl ),
( "shrl", MO_U_Shr ),
( "shra", MO_S_Shr ),
( "fadd", MO_F_Add ),
( "fsub", MO_F_Sub ),
( "fneg", MO_F_Neg ),
( "fmul", MO_F_Mul ),
( "fquot", MO_F_Quot ),
( "feq", MO_F_Eq ),
( "fne", MO_F_Ne ),
( "fge", MO_F_Ge ),
( "fle", MO_F_Le ),
( "fgt", MO_F_Gt ),
( "flt", MO_F_Lt ),
( "lobits8", flip MO_UU_Conv W8 ),
( "lobits16", flip MO_UU_Conv W16 ),
( "lobits32", flip MO_UU_Conv W32 ),
( "lobits64", flip MO_UU_Conv W64 ),
( "zx16", flip MO_UU_Conv W16 ),
( "zx32", flip MO_UU_Conv W32 ),
( "zx64", flip MO_UU_Conv W64 ),
( "sx16", flip MO_SS_Conv W16 ),
( "sx32", flip MO_SS_Conv W32 ),
( "sx64", flip MO_SS_Conv W64 ),
( "f2f32", flip MO_FF_Conv W32 ), -- TODO; rounding mode
( "f2f64", flip MO_FF_Conv W64 ), -- TODO; rounding mode
( "f2i8", flip MO_FS_Conv W8 ),
( "f2i16", flip MO_FS_Conv W16 ),
( "f2i32", flip MO_FS_Conv W32 ),
( "f2i64", flip MO_FS_Conv W64 ),
( "i2f32", flip MO_SF_Conv W32 ),
( "i2f64", flip MO_SF_Conv W64 )
]
callishMachOps :: UniqFM ([CmmExpr] -> (CallishMachOp, [CmmExpr]))
callishMachOps = listToUFM $
map (\(x, y) -> (mkFastString x, y)) [
( "write_barrier", (,) MO_WriteBarrier ),
( "memcpy", memcpyLikeTweakArgs MO_Memcpy ),
( "memset", memcpyLikeTweakArgs MO_Memset ),
( "memmove", memcpyLikeTweakArgs MO_Memmove ),
("prefetch0", (,) $ MO_Prefetch_Data 0),
("prefetch1", (,) $ MO_Prefetch_Data 1),
("prefetch2", (,) $ MO_Prefetch_Data 2),
("prefetch3", (,) $ MO_Prefetch_Data 3),