summaryrefslogtreecommitdiff
path: root/src/vm/amd64/AsmMacros.inc
blob: f95a2919293121b4fbfcfe6644484bf908e20167 (plain)
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
; Licensed to the .NET Foundation under one or more agreements.
; The .NET Foundation licenses this file to you under the MIT license.
; See the LICENSE file in the project root for more information.

;
; Define macros to build unwind data for prologues.
;

push_nonvol_reg macro Reg

        .errnz ___STACK_ADJUSTMENT_FORBIDDEN, <push_nonvol_reg cannot be used after save_reg_postrsp>

        push    Reg
        .pushreg Reg

        endm

push_vol_reg macro Reg

        .errnz ___STACK_ADJUSTMENT_FORBIDDEN, push_vol_reg cannot be used after save_reg_postrsp

        push    Reg
        .allocstack 8

        endm

push_eflags macro

        .errnz ___STACK_ADJUSTMENT_FORBIDDEN, push_eflags cannot be used after save_reg_postrsp

        pushfq
        .allocstack 8

        endm

alloc_stack macro Size

        .errnz ___STACK_ADJUSTMENT_FORBIDDEN, alloc_stack cannot be used after save_reg_postrsp

        sub     rsp, Size
        .allocstack Size

        endm

save_reg_frame macro Reg, FrameReg, Offset

        .erre ___FRAME_REG_SET, save_reg_frame cannot be used before set_frame

        mov     Offset[FrameReg], Reg
        .savereg Reg, Offset

        endm

save_reg_postrsp macro Reg, Offset

        .errnz ___FRAME_REG_SET, save_reg_postrsp cannot be used after set_frame

        mov     Offset[rsp], Reg
        .savereg Reg, Offset

        ___STACK_ADJUSTMENT_FORBIDDEN = 1

        endm

save_xmm128_frame macro Reg, FrameReg, Offset

        .erre ___FRAME_REG_SET, save_xmm128_frame cannot be used before set_frame

        movdqa  Offset[FrameReg], Reg
        .savexmm128 Reg, Offset

        endm

save_xmm128_postrsp macro Reg, Offset

        .errnz ___FRAME_REG_SET, save_reg_postrsp cannot be used after set_frame

        movdqa  Offset[rsp], Reg
        .savexmm128 Reg, Offset
    
        ___STACK_ADJUSTMENT_FORBIDDEN = 1

        endm

set_frame macro Reg, Offset

        .errnz ___FRAME_REG_SET, set_frame cannot be used more than once

if Offset

        lea     Reg, Offset[rsp]

else

        mov     reg, rsp

endif

        .setframe Reg, Offset
        ___FRAME_REG_SET = 1

        endm

END_PROLOGUE macro

        .endprolog

        endm


;
; Define function entry/end macros.
;

LEAF_ENTRY macro Name, Section

Section segment para 'CODE'

        align   16

        public  Name
Name    proc

        endm

LEAF_END macro Name, section

Name    endp

Section ends

        endm

LEAF_END_MARKED macro Name, section
        public Name&_End
Name&_End label qword
        ; this nop is important to keep the label in 
        ; the right place in the face of BBT
        nop
        
Name    endp

Section ends

        endm


NESTED_ENTRY macro Name, Section, Handler

Section segment para 'CODE'

        align   16

        public  Name

ifb <Handler>

Name    proc    frame

else

Name    proc    frame:Handler

endif

        ___FRAME_REG_SET = 0
        ___STACK_ADJUSTMENT_FORBIDDEN = 0

        endm

NESTED_END macro Name, section

Name    endp

Section ends

        endm

NESTED_END_MARKED macro Name, section
        public Name&_End
Name&_End label qword

Name    endp

Section ends

        endm


;
; Macro to Call GetThread() correctly whether it is indirect or direct
;
CALL_GETTHREAD macro
ifndef GetThread
extern GetThread:proc
endif
        call    GetThread
        endm

CALL_GETAPPDOMAIN macro
ifndef GetAppDomain
extern GetAppDomain:proc
endif
        call    GetAppDomain
        endm

;
; if you change this code there will be corresponding code in JITInterfaceGen.cpp which will need to be changed
;

; DEFAULT_TARGET needs to always be futher away than the fixed up target will be


JIT_HELPER_MONITOR_THUNK macro THUNK_NAME, Section
Section segment para 'CODE'
        align 16
        public THUNK_NAME
THUNK_NAME proc
        xor     edx, edx
THUNK_NAME endp
Section ends
        endm

;
; Useful for enabling C++ to know where to patch code at runtime.
;
PATCH_LABEL macro Name
        public Name
Name::
        endm

;
; Define alternate entry macro.
;        
ALTERNATE_ENTRY macro Name
        public Name
Name label proc
        endm

; 
; Appropriate instructions for certain specific scenarios:
;  - REPRET: should be used as the return instruction when the return is a branch 
;            target or immediately follows a conditional branch 
;  - TAILJMP_RAX: ("jmp rax") should be used for tailcalls, this emits an instruction 
;            sequence which is recognized by the unwinder as a valid epilogue terminator
;
REPRET      TEXTEQU <DB 0F3h, 0C3h>
TAILJMP_RAX TEXTEQU <DB 048h, 0FFh, 0E0h>

NOP_2_BYTE macro

        xchg ax,ax

        endm

NOP_3_BYTE macro

        nop dword ptr [rax]

        endm

PUSH_CALLEE_SAVED_REGISTERS macro

        push_nonvol_reg r15
        push_nonvol_reg r14
        push_nonvol_reg r13
        push_nonvol_reg r12
        push_nonvol_reg rbp
        push_nonvol_reg rbx
        push_nonvol_reg rsi
        push_nonvol_reg rdi

        endm

SAVE_CALLEE_SAVED_REGISTERS macro ofs

        save_reg_postrsp    rdi, ofs + 0h
        save_reg_postrsp    rsi, ofs + 8h 
        save_reg_postrsp    rbx, ofs + 10h
        save_reg_postrsp    rbp, ofs + 18h 
        save_reg_postrsp    r12, ofs + 20h
        save_reg_postrsp    r13, ofs + 28h 
        save_reg_postrsp    r14, ofs + 30h
        save_reg_postrsp    r15, ofs + 38h 

        endm

POP_CALLEE_SAVED_REGISTERS macro

        pop             rdi
        pop             rsi
        pop             rbx
        pop             rbp
        pop             r12
        pop             r13
        pop             r14
        pop             r15

        endm

SAVE_ARGUMENT_REGISTERS macro ofs

        save_reg_postrsp rcx, ofs + 0h
        save_reg_postrsp rdx, ofs + 8h
        save_reg_postrsp r8,  ofs + 10h
        save_reg_postrsp r9,  ofs + 18h

        endm

RESTORE_ARGUMENT_REGISTERS macro ofs

        mov             rcx, [rsp + ofs + 0h]
        mov             rdx, [rsp + ofs + 8h]
        mov             r8,  [rsp + ofs + 10h]
        mov             r9,  [rsp + ofs + 18h]

        endm

SAVE_FLOAT_ARGUMENT_REGISTERS macro ofs

        save_xmm128_postrsp xmm0, ofs
        save_xmm128_postrsp xmm1, ofs + 10h
        save_xmm128_postrsp xmm2, ofs + 20h
        save_xmm128_postrsp xmm3, ofs + 30h

        endm

RESTORE_FLOAT_ARGUMENT_REGISTERS macro ofs

        movdqa          xmm0, [rsp + ofs]
        movdqa          xmm1, [rsp + ofs + 10h]
        movdqa          xmm2, [rsp + ofs + 20h]
        movdqa          xmm3, [rsp + ofs + 30h]

        endm


; Stack layout:
;
; (stack parameters)
; ...
; r9
; r8
; rdx
; rcx                       <- __PWTB_ArgumentRegisters
; return address
; CalleeSavedRegisters::r15
; CalleeSavedRegisters::r14
; CalleeSavedRegisters::r13
; CalleeSavedRegisters::r12
; CalleeSavedRegisters::rbp
; CalleeSavedRegisters::rbx
; CalleeSavedRegisters::rsi
; CalleeSavedRegisters::rdi <- __PWTB_StackAlloc
; padding to align xmm save area
; xmm3
; xmm2
; xmm1
; xmm0                      <- __PWTB_FloatArgumentRegisters
; extra locals + padding to qword align
; callee's r9
; callee's r8
; callee's rdx
; callee's rcx

PROLOG_WITH_TRANSITION_BLOCK macro extraLocals := <0>, stackAllocOnEntry := <0>, stackAllocSpill1, stackAllocSpill2, stackAllocSpill3

        __PWTB_FloatArgumentRegisters = SIZEOF_MAX_OUTGOING_ARGUMENT_HOMES + extraLocals

        if (__PWTB_FloatArgumentRegisters mod 16) ne 0
        __PWTB_FloatArgumentRegisters = __PWTB_FloatArgumentRegisters + 8
        endif

        __PWTB_StackAlloc = __PWTB_FloatArgumentRegisters + 4 * 16 + 8
        __PWTB_TransitionBlock = __PWTB_StackAlloc
        __PWTB_ArgumentRegisters = __PWTB_StackAlloc + 9 * 8

        .errnz stackAllocOnEntry ge 4*8, Max supported stackAllocOnEntry is 3*8

        if stackAllocOnEntry gt 0
        .allocstack stackAllocOnEntry
        endif

        ; PUSH_CALLEE_SAVED_REGISTERS expanded here

        if stackAllocOnEntry lt 8
        push_nonvol_reg r15
        endif

        if stackAllocOnEntry lt 2*8
        push_nonvol_reg r14
        endif

        if stackAllocOnEntry lt 3*8
        push_nonvol_reg r13
        endif

        push_nonvol_reg r12
        push_nonvol_reg rbp
        push_nonvol_reg rbx
        push_nonvol_reg rsi
        push_nonvol_reg rdi

        alloc_stack     __PWTB_StackAlloc
        SAVE_ARGUMENT_REGISTERS __PWTB_ArgumentRegisters
        SAVE_FLOAT_ARGUMENT_REGISTERS __PWTB_FloatArgumentRegisters

        if stackAllocOnEntry ge 3*8
        mov stackAllocSpill3, [rsp + __PWTB_StackAlloc + 28h]
        save_reg_postrsp    r13, __PWTB_StackAlloc + 28h 
        endif

        if stackAllocOnEntry ge 2*8
        mov stackAllocSpill2, [rsp + __PWTB_StackAlloc + 30h]
        save_reg_postrsp    r14, __PWTB_StackAlloc + 30h
        endif

        if stackAllocOnEntry ge 8
        mov stackAllocSpill1, [rsp + __PWTB_StackAlloc + 38h]
        save_reg_postrsp    r15, __PWTB_StackAlloc + 38h 
        endif

        END_PROLOGUE

        endm

EPILOG_WITH_TRANSITION_BLOCK_RETURN macro

        add rsp, __PWTB_StackAlloc
        POP_CALLEE_SAVED_REGISTERS
        ret

        endm

EPILOG_WITH_TRANSITION_BLOCK_TAILCALL macro

        RESTORE_FLOAT_ARGUMENT_REGISTERS __PWTB_FloatArgumentRegisters
        RESTORE_ARGUMENT_REGISTERS __PWTB_ArgumentRegisters
        add rsp, __PWTB_StackAlloc
        POP_CALLEE_SAVED_REGISTERS

        endm