2 ** FFI C call handling.
3 ** Copyright (C) 2005-2023 Mike Pall. See Copyright Notice in luajit.h
19 /* Target-specific handling of register arguments. */
21 /* -- x86 calling conventions --------------------------------------------- */
23 #define CCALL_PUSH(arg) \
24 *(GPRArg *)((uint8_t *)cc->stack + nsp) = (GPRArg)(arg), nsp += CTSIZE_PTR
28 #define CCALL_HANDLE_STRUCTRET \
29 /* Return structs bigger than 8 by reference (on stack only). */ \
30 cc->retref = (sz > 8); \
31 if (cc->retref) CCALL_PUSH(dp);
33 #define CCALL_HANDLE_COMPLEXRET CCALL_HANDLE_STRUCTRET
39 #define CCALL_HANDLE_STRUCTRET \
40 /* Return structs of size 1, 2, 4 or 8 in registers. */ \
41 cc->retref = !(sz == 1 || sz == 2 || sz == 4 || sz == 8); \
44 cc->gpr[ngpr++] = (GPRArg)dp; \
47 } else { /* Struct with single FP field ends up in FPR. */ \
48 cc->resx87 = ccall_classify_struct(cts, ctr); \
51 #define CCALL_HANDLE_STRUCTRET2 \
52 if (cc->resx87) sp = (uint8_t *)&cc->fpr[0]; \
53 memcpy(dp, sp, ctr->size);
57 #define CCALL_HANDLE_STRUCTRET \
58 cc->retref = 1; /* Return all structs by reference (in reg or on stack). */ \
60 cc->gpr[ngpr++] = (GPRArg)dp; \
66 #define CCALL_HANDLE_COMPLEXRET \
67 /* Return complex float in GPRs and complex double by reference. */ \
68 cc->retref = (sz > 8); \
71 cc->gpr[ngpr++] = (GPRArg)dp; \
78 #define CCALL_HANDLE_COMPLEXRET2 \
80 *(int64_t *)dp = *(int64_t *)sp; /* Copy complex float from GPRs. */
82 #define CCALL_HANDLE_STRUCTARG \
83 ngpr = maxgpr; /* Pass all structs by value on the stack. */
85 #define CCALL_HANDLE_COMPLEXARG \
86 isfp = 1; /* Pass complex by value on stack. */
88 #define CCALL_HANDLE_REGARG \
89 if (!isfp) { /* Only non-FP values may be passed in registers. */ \
90 if (n > 1) { /* Anything > 32 bit is passed on the stack. */ \
91 if (!LJ_ABI_WIN) ngpr = maxgpr; /* Prevent reordering. */ \
92 } else if (ngpr + 1 <= maxgpr) { \
93 dp = &cc->gpr[ngpr]; \
99 #elif LJ_TARGET_X64 && LJ_ABI_WIN
100 /* -- Windows/x64 calling conventions ------------------------------------- */
102 #define CCALL_HANDLE_STRUCTRET \
103 /* Return structs of size 1, 2, 4 or 8 in a GPR. */ \
104 cc->retref = !(sz == 1 || sz == 2 || sz == 4 || sz == 8); \
105 if (cc->retref) cc->gpr[ngpr++] = (GPRArg)dp;
107 #define CCALL_HANDLE_COMPLEXRET CCALL_HANDLE_STRUCTRET
109 #define CCALL_HANDLE_COMPLEXRET2 \
111 *(int64_t *)dp = *(int64_t *)sp; /* Copy complex float from GPRs. */
113 #define CCALL_HANDLE_STRUCTARG \
114 /* Pass structs of size 1, 2, 4 or 8 in a GPR by value. */ \
115 if (!(sz == 1 || sz == 2 || sz == 4 || sz == 8)) { \
116 rp = cdataptr(lj_cdata_new(cts, did, sz)); \
117 sz = CTSIZE_PTR; /* Pass all other structs by reference. */ \
120 #define CCALL_HANDLE_COMPLEXARG \
121 /* Pass complex float in a GPR and complex double by reference. */ \
122 if (sz != 2*sizeof(float)) { \
123 rp = cdataptr(lj_cdata_new(cts, did, sz)); \
127 /* Windows/x64 argument registers are strictly positional (use ngpr). */
128 #define CCALL_HANDLE_REGARG \
130 if (ngpr < maxgpr) { dp = &cc->fpr[ngpr++]; nfpr = ngpr; goto done; } \
132 if (ngpr < maxgpr) { dp = &cc->gpr[ngpr++]; goto done; } \
136 /* -- POSIX/x64 calling conventions --------------------------------------- */
138 #define CCALL_HANDLE_STRUCTRET \
139 int rcl[2]; rcl[0] = rcl[1] = 0; \
140 if (ccall_classify_struct(cts, ctr, rcl, 0)) { \
141 cc->retref = 1; /* Return struct by reference. */ \
142 cc->gpr[ngpr++] = (GPRArg)dp; \
144 cc->retref = 0; /* Return small structs in registers. */ \
147 #define CCALL_HANDLE_STRUCTRET2 \
148 int rcl[2]; rcl[0] = rcl[1] = 0; \
149 ccall_classify_struct(cts, ctr, rcl, 0); \
150 ccall_struct_ret(cc, rcl, dp, ctr->size);
152 #define CCALL_HANDLE_COMPLEXRET \
153 /* Complex values are returned in one or two FPRs. */ \
156 #define CCALL_HANDLE_COMPLEXRET2 \
157 if (ctr->size == 2*sizeof(float)) { /* Copy complex float from FPR. */ \
158 *(int64_t *)dp = cc->fpr[0].l[0]; \
159 } else { /* Copy non-contiguous complex double from FPRs. */ \
160 ((int64_t *)dp)[0] = cc->fpr[0].l[0]; \
161 ((int64_t *)dp)[1] = cc->fpr[1].l[0]; \
164 #define CCALL_HANDLE_STRUCTARG \
165 int rcl[2]; rcl[0] = rcl[1] = 0; \
166 if (!ccall_classify_struct(cts, d, rcl, 0)) { \
167 cc->nsp = nsp; cc->ngpr = ngpr; cc->nfpr = nfpr; \
168 if (ccall_struct_arg(cc, cts, d, rcl, o, narg)) goto err_nyi; \
169 nsp = cc->nsp; ngpr = cc->ngpr; nfpr = cc->nfpr; \
171 } /* Pass all other structs by value on stack. */
173 #define CCALL_HANDLE_COMPLEXARG \
174 isfp = 2; /* Pass complex in FPRs or on stack. Needs postprocessing. */
176 #define CCALL_HANDLE_REGARG \
177 if (isfp) { /* Try to pass argument in FPRs. */ \
178 int n2 = ctype_isvector(d->info) ? 1 : n; \
179 if (nfpr + n2 <= CCALL_NARG_FPR) { \
180 dp = &cc->fpr[nfpr]; \
184 } else { /* Try to pass argument in GPRs. */ \
185 /* Note that reordering is explicitly allowed in the x64 ABI. */ \
186 if (n <= 2 && ngpr + n <= maxgpr) { \
187 dp = &cc->gpr[ngpr]; \
194 /* -- ARM calling conventions --------------------------------------------- */
198 #define CCALL_HANDLE_STRUCTRET \
199 /* Return structs of size <= 4 in a GPR. */ \
200 cc->retref = !(sz <= 4); \
201 if (cc->retref) cc->gpr[ngpr++] = (GPRArg)dp;
203 #define CCALL_HANDLE_COMPLEXRET \
204 cc->retref = 1; /* Return all complex values by reference. */ \
205 cc->gpr[ngpr++] = (GPRArg)dp;
207 #define CCALL_HANDLE_COMPLEXRET2 \
208 UNUSED(dp); /* Nothing to do. */
210 #define CCALL_HANDLE_STRUCTARG \
211 /* Pass all structs by value in registers and/or on the stack. */
213 #define CCALL_HANDLE_COMPLEXARG \
214 /* Pass complex by value in 2 or 4 GPRs. */
216 #define CCALL_HANDLE_REGARG_FP1
217 #define CCALL_HANDLE_REGARG_FP2
221 #define CCALL_HANDLE_STRUCTRET \
222 cc->retref = !ccall_classify_struct(cts, ctr, ct); \
223 if (cc->retref) cc->gpr[ngpr++] = (GPRArg)dp;
225 #define CCALL_HANDLE_STRUCTRET2 \
226 if (ccall_classify_struct(cts, ctr, ct) > 1) sp = (uint8_t *)&cc->fpr[0]; \
227 memcpy(dp, sp, ctr->size);
229 #define CCALL_HANDLE_COMPLEXRET \
230 if (!(ct->info & CTF_VARARG)) cc->retref = 0; /* Return complex in FPRs. */
232 #define CCALL_HANDLE_COMPLEXRET2 \
233 if (!(ct->info & CTF_VARARG)) memcpy(dp, &cc->fpr[0], ctr->size);
235 #define CCALL_HANDLE_STRUCTARG \
236 isfp = (ccall_classify_struct(cts, d, ct) > 1);
237 /* Pass all structs by value in registers and/or on the stack. */
239 #define CCALL_HANDLE_COMPLEXARG \
240 isfp = 1; /* Pass complex by value in FPRs or on stack. */
242 #define CCALL_HANDLE_REGARG_FP1 \
243 if (isfp && !(ct->info & CTF_VARARG)) { \
244 if ((d->info & CTF_ALIGN) > CTALIGN_PTR) { \
245 if (nfpr + (n >> 1) <= CCALL_NARG_FPR) { \
246 dp = &cc->fpr[nfpr]; \
251 if (sz > 1 && fprodd != nfpr) fprodd = 0; \
253 if (2*nfpr+n <= 2*CCALL_NARG_FPR+1) { \
254 dp = (void *)&cc->fpr[fprodd-1].f[1]; \
256 if ((n & 1)) fprodd = 0; else fprodd = nfpr-1; \
260 if (2*nfpr+n <= 2*CCALL_NARG_FPR) { \
261 dp = (void *)&cc->fpr[nfpr]; \
263 if ((n & 1)) fprodd = ++nfpr; else fprodd = 0; \
268 fprodd = 0; /* No reordering after the first FP value is on stack. */ \
271 #define CCALL_HANDLE_REGARG_FP2 }
275 #define CCALL_HANDLE_REGARG \
276 CCALL_HANDLE_REGARG_FP1 \
277 if ((d->info & CTF_ALIGN) > CTALIGN_PTR) { \
279 ngpr = (ngpr + 1u) & ~1u; /* Align to regpair. */ \
281 if (ngpr < maxgpr) { \
282 dp = &cc->gpr[ngpr]; \
283 if (ngpr + n > maxgpr) { \
284 nsp += (ngpr + n - maxgpr) * CTSIZE_PTR; /* Assumes contiguous gpr/stack fields. */ \
285 if (nsp > CCALL_SIZE_STACK) goto err_nyi; /* Too many arguments. */ \
291 } CCALL_HANDLE_REGARG_FP2
293 #define CCALL_HANDLE_RET \
294 if ((ct->info & CTF_VARARG)) sp = (uint8_t *)&cc->gpr[0];
296 #elif LJ_TARGET_ARM64
297 /* -- ARM64 calling conventions ------------------------------------------- */
299 #define CCALL_HANDLE_STRUCTRET \
300 cc->retref = !ccall_classify_struct(cts, ctr); \
301 if (cc->retref) cc->retp = dp;
303 #define CCALL_HANDLE_STRUCTRET2 \
304 unsigned int cl = ccall_classify_struct(cts, ctr); \
305 if ((cl & 4)) { /* Combine float HFA from separate registers. */ \
306 CTSize i = (cl >> 8) - 1; \
307 do { ((uint32_t *)dp)[i] = cc->fpr[i].lo; } while (i--); \
309 if (cl > 1) sp = (uint8_t *)&cc->fpr[0]; \
310 memcpy(dp, sp, ctr->size); \
313 #define CCALL_HANDLE_COMPLEXRET \
314 /* Complex values are returned in one or two FPRs. */ \
317 #define CCALL_HANDLE_COMPLEXRET2 \
318 if (ctr->size == 2*sizeof(float)) { /* Copy complex float from FPRs. */ \
319 ((float *)dp)[0] = cc->fpr[0].f; \
320 ((float *)dp)[1] = cc->fpr[1].f; \
321 } else { /* Copy complex double from FPRs. */ \
322 ((double *)dp)[0] = cc->fpr[0].d; \
323 ((double *)dp)[1] = cc->fpr[1].d; \
326 #define CCALL_HANDLE_STRUCTARG \
327 unsigned int cl = ccall_classify_struct(cts, d); \
328 if (cl == 0) { /* Pass struct by reference. */ \
329 rp = cdataptr(lj_cdata_new(cts, did, sz)); \
331 } else if (cl > 1) { /* Pass struct in FPRs or on stack. */ \
332 isfp = (cl & 4) ? 2 : 1; \
333 } /* else: Pass struct in GPRs or on stack. */
335 #define CCALL_HANDLE_COMPLEXARG \
336 /* Pass complex by value in separate (!) FPRs or on stack. */ \
337 isfp = sz == 2*sizeof(float) ? 2 : 1;
339 #define CCALL_HANDLE_REGARG \
340 if (LJ_TARGET_OSX && isva) { \
341 /* IOS: All variadic arguments are on the stack. */ \
342 } else if (isfp) { /* Try to pass argument in FPRs. */ \
343 int n2 = ctype_isvector(d->info) ? 1 : \
344 isfp == 1 ? n : (d->size >> (4-isfp)); \
345 if (nfpr + n2 <= CCALL_NARG_FPR) { \
346 dp = &cc->fpr[nfpr]; \
350 nfpr = CCALL_NARG_FPR; /* Prevent reordering. */ \
352 } else { /* Try to pass argument in GPRs. */ \
353 if (!LJ_TARGET_OSX && (d->info & CTF_ALIGN) > CTALIGN_PTR) \
354 ngpr = (ngpr + 1u) & ~1u; /* Align to regpair. */ \
355 if (ngpr + n <= maxgpr) { \
356 dp = &cc->gpr[ngpr]; \
360 ngpr = maxgpr; /* Prevent reordering. */ \
365 #define CCALL_HANDLE_RET \
366 if (ctype_isfp(ctr->info) && ctr->size == sizeof(float)) \
367 sp = (uint8_t *)&cc->fpr[0].f;
372 /* -- PPC calling conventions --------------------------------------------- */
374 #define CCALL_HANDLE_STRUCTRET \
375 cc->retref = 1; /* Return all structs by reference. */ \
376 cc->gpr[ngpr++] = (GPRArg)dp;
378 #define CCALL_HANDLE_COMPLEXRET \
379 /* Complex values are returned in 2 or 4 GPRs. */ \
382 #define CCALL_HANDLE_COMPLEXRET2 \
383 memcpy(dp, sp, ctr->size); /* Copy complex from GPRs. */
385 #define CCALL_HANDLE_STRUCTARG \
386 rp = cdataptr(lj_cdata_new(cts, did, sz)); \
387 sz = CTSIZE_PTR; /* Pass all structs by reference. */
389 #define CCALL_HANDLE_COMPLEXARG \
390 /* Pass complex by value in 2 or 4 GPRs. */
392 #define CCALL_HANDLE_GPR \
393 /* Try to pass argument in GPRs. */ \
395 /* int64_t or complex (float). */ \
396 lj_assertL(n == 2 || n == 4, "bad GPR size %d", n); \
397 if (ctype_isinteger(d->info) || ctype_isfp(d->info)) \
398 ngpr = (ngpr + 1u) & ~1u; /* Align int64_t to regpair. */ \
399 else if (ngpr + n > maxgpr) \
400 ngpr = maxgpr; /* Prevent reordering. */ \
402 if (ngpr + n <= maxgpr) { \
403 dp = &cc->gpr[ngpr]; \
409 #define CCALL_HANDLE_REGARG CCALL_HANDLE_GPR
411 #define CCALL_HANDLE_REGARG \
412 if (isfp) { /* Try to pass argument in FPRs. */ \
413 if (nfpr + 1 <= CCALL_NARG_FPR) { \
414 dp = &cc->fpr[nfpr]; \
416 d = ctype_get(cts, CTID_DOUBLE); /* FPRs always hold doubles. */ \
425 #define CCALL_HANDLE_RET \
426 if (ctype_isfp(ctr->info) && ctr->size == sizeof(float)) \
427 ctr = ctype_get(cts, CTID_DOUBLE); /* FPRs always hold doubles. */
430 #elif LJ_TARGET_MIPS32
431 /* -- MIPS o32 calling conventions ---------------------------------------- */
433 #define CCALL_HANDLE_STRUCTRET \
434 cc->retref = 1; /* Return all structs by reference. */ \
435 cc->gpr[ngpr++] = (GPRArg)dp;
437 #define CCALL_HANDLE_COMPLEXRET \
438 /* Complex values are returned in 1 or 2 FPRs. */ \
442 #define CCALL_HANDLE_COMPLEXRET2 \
443 if (ctr->size == 2*sizeof(float)) { /* Copy complex float from GPRs. */ \
444 ((intptr_t *)dp)[0] = cc->gpr[0]; \
445 ((intptr_t *)dp)[1] = cc->gpr[1]; \
446 } else { /* Copy complex double from GPRs. */ \
447 ((intptr_t *)dp)[0] = cc->gpr[0]; \
448 ((intptr_t *)dp)[1] = cc->gpr[1]; \
449 ((intptr_t *)dp)[2] = cc->gpr[2]; \
450 ((intptr_t *)dp)[3] = cc->gpr[3]; \
453 #define CCALL_HANDLE_COMPLEXRET2 \
454 if (ctr->size == 2*sizeof(float)) { /* Copy complex float from FPRs. */ \
455 ((float *)dp)[0] = cc->fpr[0].f; \
456 ((float *)dp)[1] = cc->fpr[1].f; \
457 } else { /* Copy complex double from FPRs. */ \
458 ((double *)dp)[0] = cc->fpr[0].d; \
459 ((double *)dp)[1] = cc->fpr[1].d; \
463 #define CCALL_HANDLE_STRUCTARG \
464 /* Pass all structs by value in registers and/or on the stack. */
466 #define CCALL_HANDLE_COMPLEXARG \
467 /* Pass complex by value in 2 or 4 GPRs. */
469 #define CCALL_HANDLE_GPR \
470 if ((d->info & CTF_ALIGN) > CTALIGN_PTR) \
471 ngpr = (ngpr + 1u) & ~1u; /* Align to regpair. */ \
472 if (ngpr < maxgpr) { \
473 dp = &cc->gpr[ngpr]; \
474 if (ngpr + n > maxgpr) { \
475 nsp += (ngpr + n - maxgpr) * CTSIZE_PTR; /* Assumes contiguous gpr/stack fields. */ \
476 if (nsp > CCALL_SIZE_STACK) goto err_nyi; /* Too many arguments. */ \
484 #if !LJ_ABI_SOFTFP /* MIPS32 hard-float */
485 #define CCALL_HANDLE_REGARG \
486 if (isfp && nfpr < CCALL_NARG_FPR && !(ct->info & CTF_VARARG)) { \
487 /* Try to pass argument in FPRs. */ \
488 dp = n == 1 ? (void *)&cc->fpr[nfpr].f : (void *)&cc->fpr[nfpr].d; \
491 } else { /* Try to pass argument in GPRs. */ \
492 nfpr = CCALL_NARG_FPR; \
495 #else /* MIPS32 soft-float */
496 #define CCALL_HANDLE_REGARG CCALL_HANDLE_GPR
500 /* On MIPS64 soft-float, position of float return values is endian-dependant. */
501 #define CCALL_HANDLE_RET \
502 if (ctype_isfp(ctr->info) && ctr->size == sizeof(float)) \
503 sp = (uint8_t *)&cc->fpr[0].f;
506 #elif LJ_TARGET_MIPS64
507 /* -- MIPS n64 calling conventions ---------------------------------------- */
509 #define CCALL_HANDLE_STRUCTRET \
510 cc->retref = !(sz <= 16); \
511 if (cc->retref) cc->gpr[ngpr++] = (GPRArg)dp;
513 #define CCALL_HANDLE_STRUCTRET2 \
514 ccall_copy_struct(cc, ctr, dp, sp, ccall_classify_struct(cts, ctr, ct));
516 #define CCALL_HANDLE_COMPLEXRET \
517 /* Complex values are returned in 1 or 2 FPRs. */ \
520 #if LJ_ABI_SOFTFP /* MIPS64 soft-float */
522 #define CCALL_HANDLE_COMPLEXRET2 \
523 if (ctr->size == 2*sizeof(float)) { /* Copy complex float from GPRs. */ \
524 ((intptr_t *)dp)[0] = cc->gpr[0]; \
525 } else { /* Copy complex double from GPRs. */ \
526 ((intptr_t *)dp)[0] = cc->gpr[0]; \
527 ((intptr_t *)dp)[1] = cc->gpr[1]; \
530 #define CCALL_HANDLE_COMPLEXARG \
531 /* Pass complex by value in 2 or 4 GPRs. */
533 /* Position of soft-float 'float' return value depends on endianess. */
534 #define CCALL_HANDLE_RET \
535 if (ctype_isfp(ctr->info) && ctr->size == sizeof(float)) \
536 sp = (uint8_t *)cc->gpr + LJ_ENDIAN_SELECT(0, 4);
538 #else /* MIPS64 hard-float */
540 #define CCALL_HANDLE_COMPLEXRET2 \
541 if (ctr->size == 2*sizeof(float)) { /* Copy complex float from FPRs. */ \
542 ((float *)dp)[0] = cc->fpr[0].f; \
543 ((float *)dp)[1] = cc->fpr[1].f; \
544 } else { /* Copy complex double from FPRs. */ \
545 ((double *)dp)[0] = cc->fpr[0].d; \
546 ((double *)dp)[1] = cc->fpr[1].d; \
549 #define CCALL_HANDLE_COMPLEXARG \
550 if (sz == 2*sizeof(float)) { \
556 #define CCALL_HANDLE_RET \
557 if (ctype_isfp(ctr->info) && ctr->size == sizeof(float)) \
558 sp = (uint8_t *)&cc->fpr[0].f;
562 #define CCALL_HANDLE_STRUCTARG \
563 /* Pass all structs by value in registers and/or on the stack. */
565 #define CCALL_HANDLE_REGARG \
566 if (ngpr < maxgpr) { \
567 dp = &cc->gpr[ngpr]; \
568 if (ngpr + n > maxgpr) { \
569 nsp += (ngpr + n - maxgpr) * CTSIZE_PTR; /* Assumes contiguous gpr/stack fields. */ \
570 if (nsp > CCALL_SIZE_STACK) goto err_nyi; /* Too many arguments. */ \
579 #error "Missing calling convention definitions for this architecture"
582 #ifndef CCALL_HANDLE_STRUCTRET2
583 #define CCALL_HANDLE_STRUCTRET2 \
584 memcpy(dp, sp, ctr->size); /* Copy struct return value from GPRs. */
587 /* -- x86 OSX ABI struct classification ----------------------------------- */
589 #if LJ_TARGET_X86 && LJ_TARGET_OSX
591 /* Check for struct with single FP field. */
592 static int ccall_classify_struct(CTState
*cts
, CType
*ct
)
594 CTSize sz
= ct
->size
;
595 if (!(sz
== sizeof(float) || sz
== sizeof(double))) return 0;
596 if ((ct
->info
& CTF_UNION
)) return 0;
598 ct
= ctype_get(cts
, ct
->sib
);
599 if (ctype_isfield(ct
->info
)) {
600 CType
*sct
= ctype_rawchild(cts
, ct
);
601 if (ctype_isfp(sct
->info
)) {
603 return (sz
>> 2); /* Return 1 for float or 2 for double. */
604 } else if (ctype_isstruct(sct
->info
)) {
606 return ccall_classify_struct(cts
, sct
);
610 } else if (ctype_isbitfield(ct
->info
)) {
612 } else if (ctype_isxattrib(ct
->info
, CTA_SUBTYPE
)) {
613 CType
*sct
= ctype_rawchild(cts
, ct
);
615 return ccall_classify_struct(cts
, sct
);
623 /* -- x64 struct classification ------------------------------------------- */
625 #if LJ_TARGET_X64 && !LJ_ABI_WIN
627 /* Register classes for x64 struct classification. */
628 #define CCALL_RCL_INT 1
629 #define CCALL_RCL_SSE 2
630 #define CCALL_RCL_MEM 4
631 /* NYI: classify vectors. */
633 static int ccall_classify_struct(CTState
*cts
, CType
*ct
, int *rcl
, CTSize ofs
);
635 /* Classify a C type. */
636 static void ccall_classify_ct(CTState
*cts
, CType
*ct
, int *rcl
, CTSize ofs
)
638 if (ctype_isarray(ct
->info
)) {
639 CType
*cct
= ctype_rawchild(cts
, ct
);
640 CTSize eofs
, esz
= cct
->size
, asz
= ct
->size
;
641 for (eofs
= 0; eofs
< asz
; eofs
+= esz
)
642 ccall_classify_ct(cts
, cct
, rcl
, ofs
+eofs
);
643 } else if (ctype_isstruct(ct
->info
)) {
644 ccall_classify_struct(cts
, ct
, rcl
, ofs
);
646 int cl
= ctype_isfp(ct
->info
) ? CCALL_RCL_SSE
: CCALL_RCL_INT
;
647 lj_assertCTS(ctype_hassize(ct
->info
),
648 "classify ctype %08x without size", ct
->info
);
649 if ((ofs
& (ct
->size
-1))) cl
= CCALL_RCL_MEM
; /* Unaligned. */
650 rcl
[(ofs
>= 8)] |= cl
;
654 /* Recursively classify a struct based on its fields. */
655 static int ccall_classify_struct(CTState
*cts
, CType
*ct
, int *rcl
, CTSize ofs
)
657 if (ct
->size
> 16) return CCALL_RCL_MEM
; /* Too big, gets memory class. */
660 ct
= ctype_get(cts
, ct
->sib
);
662 if (ctype_isfield(ct
->info
))
663 ccall_classify_ct(cts
, ctype_rawchild(cts
, ct
), rcl
, fofs
);
664 else if (ctype_isbitfield(ct
->info
))
665 rcl
[(fofs
>= 8)] |= CCALL_RCL_INT
; /* NYI: unaligned bitfields? */
666 else if (ctype_isxattrib(ct
->info
, CTA_SUBTYPE
))
667 ccall_classify_struct(cts
, ctype_rawchild(cts
, ct
), rcl
, fofs
);
669 return ((rcl
[0]|rcl
[1]) & CCALL_RCL_MEM
); /* Memory class? */
672 /* Try to split up a small struct into registers. */
673 static int ccall_struct_reg(CCallState
*cc
, CTState
*cts
, GPRArg
*dp
, int *rcl
)
675 MSize ngpr
= cc
->ngpr
, nfpr
= cc
->nfpr
;
678 for (i
= 0; i
< 2; i
++) {
679 lj_assertCTS(!(rcl
[i
] & CCALL_RCL_MEM
), "pass mem struct in reg");
680 if ((rcl
[i
] & CCALL_RCL_INT
)) { /* Integer class takes precedence. */
681 if (ngpr
>= CCALL_NARG_GPR
) return 1; /* Register overflow. */
682 cc
->gpr
[ngpr
++] = dp
[i
];
683 } else if ((rcl
[i
] & CCALL_RCL_SSE
)) {
684 if (nfpr
>= CCALL_NARG_FPR
) return 1; /* Register overflow. */
685 cc
->fpr
[nfpr
++].l
[0] = dp
[i
];
688 cc
->ngpr
= ngpr
; cc
->nfpr
= nfpr
;
692 /* Pass a small struct argument. */
693 static int ccall_struct_arg(CCallState
*cc
, CTState
*cts
, CType
*d
, int *rcl
,
698 /* Convert to temp. struct. */
699 lj_cconv_ct_tv(cts
, d
, (uint8_t *)dp
, o
, CCF_ARG(narg
));
700 if (ccall_struct_reg(cc
, cts
, dp
, rcl
)) {
701 /* Register overflow? Pass on stack. */
702 MSize nsp
= cc
->nsp
, sz
= rcl
[1] ? 2*CTSIZE_PTR
: CTSIZE_PTR
;
703 if (nsp
+ sz
> CCALL_SIZE_STACK
)
704 return 1; /* Too many arguments. */
706 memcpy((uint8_t *)cc
->stack
+ nsp
, dp
, sz
);
711 /* Combine returned small struct. */
712 static void ccall_struct_ret(CCallState
*cc
, int *rcl
, uint8_t *dp
, CTSize sz
)
715 MSize ngpr
= 0, nfpr
= 0;
717 for (i
= 0; i
< 2; i
++) {
718 if ((rcl
[i
] & CCALL_RCL_INT
)) { /* Integer class takes precedence. */
719 sp
[i
] = cc
->gpr
[ngpr
++];
720 } else if ((rcl
[i
] & CCALL_RCL_SSE
)) {
721 sp
[i
] = cc
->fpr
[nfpr
++].l
[0];
728 /* -- ARM hard-float ABI struct classification ---------------------------- */
730 #if LJ_TARGET_ARM && !LJ_ABI_SOFTFP
732 /* Classify a struct based on its fields. */
733 static unsigned int ccall_classify_struct(CTState
*cts
, CType
*ct
, CType
*ctf
)
735 CTSize sz
= ct
->size
;
736 unsigned int r
= 0, n
= 0, isu
= (ct
->info
& CTF_UNION
);
737 if ((ctf
->info
& CTF_VARARG
)) goto noth
;
740 ct
= ctype_get(cts
, ct
->sib
);
741 if (ctype_isfield(ct
->info
)) {
742 sct
= ctype_rawchild(cts
, ct
);
743 if (ctype_isfp(sct
->info
)) {
745 if (!isu
) n
++; else if (n
== 0) n
= 1;
746 } else if (ctype_iscomplex(sct
->info
)) {
747 r
|= (sct
->size
>> 1);
748 if (!isu
) n
+= 2; else if (n
< 2) n
= 2;
749 } else if (ctype_isstruct(sct
->info
)) {
754 } else if (ctype_isbitfield(ct
->info
)) {
756 } else if (ctype_isxattrib(ct
->info
, CTA_SUBTYPE
)) {
757 sct
= ctype_rawchild(cts
, ct
);
760 unsigned int s
= ccall_classify_struct(cts
, sct
, ctf
);
761 if (s
<= 1) goto noth
;
763 if (!isu
) n
+= (s
>> 8); else if (n
< (s
>>8)) n
= (s
>> 8);
767 if ((r
== 4 || r
== 8) && n
<= 4)
769 noth
: /* Not a homogeneous float/double aggregate. */
770 return (sz
<= 4); /* Return structs of size <= 4 in a GPR. */
775 /* -- ARM64 ABI struct classification ------------------------------------- */
779 /* Classify a struct based on its fields. */
780 static unsigned int ccall_classify_struct(CTState
*cts
, CType
*ct
)
782 CTSize sz
= ct
->size
;
783 unsigned int r
= 0, n
= 0, isu
= (ct
->info
& CTF_UNION
);
786 ct
= ctype_get(cts
, ct
->sib
);
787 if (ctype_isfield(ct
->info
)) {
788 sct
= ctype_rawchild(cts
, ct
);
789 if (ctype_isfp(sct
->info
)) {
791 if (!isu
) n
++; else if (n
== 0) n
= 1;
792 } else if (ctype_iscomplex(sct
->info
)) {
793 r
|= (sct
->size
>> 1);
794 if (!isu
) n
+= 2; else if (n
< 2) n
= 2;
795 } else if (ctype_isstruct(sct
->info
)) {
800 } else if (ctype_isbitfield(ct
->info
)) {
802 } else if (ctype_isxattrib(ct
->info
, CTA_SUBTYPE
)) {
803 sct
= ctype_rawchild(cts
, ct
);
806 unsigned int s
= ccall_classify_struct(cts
, sct
);
807 if (s
<= 1) goto noth
;
809 if (!isu
) n
+= (s
>> 8); else if (n
< (s
>>8)) n
= (s
>> 8);
813 if ((r
== 4 || r
== 8) && n
<= 4)
815 noth
: /* Not a homogeneous float/double aggregate. */
816 return (sz
<= 16); /* Return structs of size <= 16 in GPRs. */
821 /* -- MIPS64 ABI struct classification ---------------------------- */
825 #define FTYPE_FLOAT 1
826 #define FTYPE_DOUBLE 2
828 /* Classify FP fields (max. 2) and their types. */
829 static unsigned int ccall_classify_struct(CTState
*cts
, CType
*ct
, CType
*ctf
)
832 if ((ctf
->info
& CTF_VARARG
) || (ct
->info
& CTF_UNION
))
836 ct
= ctype_get(cts
, ct
->sib
);
839 } else if (ctype_isfield(ct
->info
)) {
840 sct
= ctype_rawchild(cts
, ct
);
841 if (ctype_isfp(sct
->info
)) {
842 ft
|= (sct
->size
== 4 ? FTYPE_FLOAT
: FTYPE_DOUBLE
) << 2*n
;
847 } else if (ctype_isbitfield(ct
->info
) ||
848 ctype_isxattrib(ct
->info
, CTA_SUBTYPE
)) {
854 noth
: /* Not a homogeneous float/double aggregate. */
855 return 0; /* Struct is in GPRs. */
858 static void ccall_copy_struct(CCallState
*cc
, CType
*ctr
, void *dp
, void *sp
,
861 if (LJ_ABI_SOFTFP
? ft
:
862 ((ft
& 3) == FTYPE_FLOAT
|| (ft
>> 2) == FTYPE_FLOAT
)) {
864 for (i
= 0; ft
!= 0; i
++, ft
>>= 2) {
865 if ((ft
& 3) == FTYPE_FLOAT
) {
867 /* The 2nd FP struct result is in CARG1 (gpr[2]) and not CRET2. */
868 memcpy((uint8_t *)dp
+ ofs
,
869 (uint8_t *)&cc
->gpr
[2*i
] + LJ_ENDIAN_SELECT(0, 4), 4);
871 *(float *)((uint8_t *)dp
+ ofs
) = cc
->fpr
[i
].f
;
875 ofs
= (ofs
+ 7) & ~7; /* 64 bit alignment. */
877 *(intptr_t *)((uint8_t *)dp
+ ofs
) = cc
->gpr
[2*i
];
879 *(double *)((uint8_t *)dp
+ ofs
) = cc
->fpr
[i
].d
;
886 if (ft
) sp
= (uint8_t *)&cc
->fpr
[0];
888 memcpy(dp
, sp
, ctr
->size
);
894 /* -- Common C call handling ---------------------------------------------- */
896 /* Infer the destination CTypeID for a vararg argument. */
897 CTypeID
lj_ccall_ctid_vararg(CTState
*cts
, cTValue
*o
)
901 } else if (tviscdata(o
)) {
902 CTypeID id
= cdataV(o
)->ctypeid
;
903 CType
*s
= ctype_get(cts
, id
);
904 if (ctype_isrefarray(s
->info
)) {
905 return lj_ctype_intern(cts
,
906 CTINFO(CT_PTR
, CTALIGN_PTR
|ctype_cid(s
->info
)), CTSIZE_PTR
);
907 } else if (ctype_isstruct(s
->info
) || ctype_isfunc(s
->info
)) {
908 /* NYI: how to pass a struct by value in a vararg argument? */
909 return lj_ctype_intern(cts
, CTINFO(CT_PTR
, CTALIGN_PTR
|id
), CTSIZE_PTR
);
910 } else if (ctype_isfp(s
->info
) && s
->size
== sizeof(float)) {
915 } else if (tvisstr(o
)) {
917 } else if (tvisbool(o
)) {
924 /* Setup arguments for C call. */
925 static int ccall_set_args(lua_State
*L
, CTState
*cts
, CType
*ct
,
929 TValue
*o
, *top
= L
->top
;
932 MSize maxgpr
, ngpr
= 0, nsp
= 0, narg
;
940 /* Clear unused regs to get some determinism in case of misdeclaration. */
941 memset(cc
->gpr
, 0, sizeof(cc
->gpr
));
943 memset(cc
->fpr
, 0, sizeof(cc
->fpr
));
947 /* x86 has several different calling conventions. */
949 switch (ctype_cconv(ct
->info
)) {
950 case CTCC_FASTCALL
: maxgpr
= 2; break;
951 case CTCC_THISCALL
: maxgpr
= 1; break;
952 default: maxgpr
= 0; break;
955 maxgpr
= CCALL_NARG_GPR
;
958 /* Perform required setup for some result types. */
959 ctr
= ctype_rawchild(cts
, ct
);
960 if (ctype_isvector(ctr
->info
)) {
961 if (!(CCALL_VECTOR_REG
&& (ctr
->size
== 8 || ctr
->size
== 16)))
963 } else if (ctype_iscomplex(ctr
->info
) || ctype_isstruct(ctr
->info
)) {
964 /* Preallocate cdata object and anchor it after arguments. */
965 CTSize sz
= ctr
->size
;
966 GCcdata
*cd
= lj_cdata_new(cts
, ctype_cid(ct
->info
), sz
);
967 void *dp
= cdataptr(cd
);
968 setcdataV(L
, L
->top
++, cd
);
969 if (ctype_isstruct(ctr
->info
)) {
970 CCALL_HANDLE_STRUCTRET
972 CCALL_HANDLE_COMPLEXRET
975 } else if (ctype_isfp(ctr
->info
)) {
976 cc
->resx87
= ctr
->size
== sizeof(float) ? 1 : 2;
980 /* Skip initial attributes. */
983 CType
*ctf
= ctype_get(cts
, fid
);
984 if (!ctype_isattrib(ctf
->info
)) break;
988 #if LJ_TARGET_ARM64 && LJ_ABI_WIN
989 if ((ct
->info
& CTF_VARARG
)) {
990 nsp
-= maxgpr
* CTSIZE_PTR
; /* May end up with negative nsp. */
992 nfpr
= CCALL_NARG_FPR
;
996 /* Walk through all passed arguments. */
997 for (o
= L
->base
+1, narg
= 1; o
< top
; o
++, narg
++) {
1001 MSize n
, isfp
= 0, isva
= 0;
1002 void *dp
, *rp
= NULL
;
1004 if (fid
) { /* Get argument type from field. */
1005 CType
*ctf
= ctype_get(cts
, fid
);
1007 lj_assertL(ctype_isfield(ctf
->info
), "field expected");
1008 did
= ctype_cid(ctf
->info
);
1010 if (!(ct
->info
& CTF_VARARG
))
1011 lj_err_caller(L
, LJ_ERR_FFI_NUMARG
); /* Too many arguments. */
1012 did
= lj_ccall_ctid_vararg(cts
, o
); /* Infer vararg type. */
1015 d
= ctype_raw(cts
, did
);
1018 /* Find out how (by value/ref) and where (GPR/FPR) to pass an argument. */
1019 if (ctype_isnum(d
->info
)) {
1020 if (sz
> 8) goto err_nyi
;
1021 if ((d
->info
& CTF_FP
))
1023 } else if (ctype_isvector(d
->info
)) {
1024 if (CCALL_VECTOR_REG
&& (sz
== 8 || sz
== 16))
1028 } else if (ctype_isstruct(d
->info
)) {
1029 CCALL_HANDLE_STRUCTARG
1030 } else if (ctype_iscomplex(d
->info
)) {
1031 CCALL_HANDLE_COMPLEXARG
1032 } else if (!(CCALL_PACK_STACKARG
&& ctype_isenum(d
->info
))) {
1035 n
= (sz
+ CTSIZE_PTR
-1) / CTSIZE_PTR
; /* Number of GPRs or stack slots needed. */
1037 CCALL_HANDLE_REGARG
/* Handle register arguments. */
1039 /* Otherwise pass argument on stack. */
1040 if (CCALL_ALIGN_STACKARG
) { /* Align argument on stack. */
1041 MSize align
= (1u << ctype_align(d
->info
)) - 1;
1042 if (rp
|| (CCALL_PACK_STACKARG
&& isva
&& align
< CTSIZE_PTR
-1))
1043 align
= CTSIZE_PTR
-1;
1044 nsp
= (nsp
+ align
) & ~align
;
1046 #if LJ_TARGET_ARM64 && LJ_ABI_WIN
1047 /* A negative nsp points into cc->gpr. Blame MS for their messy ABI. */
1048 dp
= ((uint8_t *)cc
->stack
) + (int32_t)nsp
;
1050 dp
= ((uint8_t *)cc
->stack
) + nsp
;
1052 nsp
+= CCALL_PACK_STACKARG
? sz
: n
* CTSIZE_PTR
;
1053 if ((int32_t)nsp
> CCALL_SIZE_STACK
) { /* Too many arguments. */
1055 lj_err_caller(L
, LJ_ERR_FFI_NYICALL
);
1060 if (rp
) { /* Pass by reference. */
1065 lj_cconv_ct_tv(cts
, d
, (uint8_t *)dp
, o
, CCF_ARG(narg
));
1066 /* Extend passed integers to 32 bits at least. */
1067 if (ctype_isinteger_or_bool(d
->info
) && d
->size
< 4 &&
1068 (!CCALL_PACK_STACKARG
|| !((uintptr_t)dp
& 3))) { /* Assumes LJ_LE. */
1069 if (d
->info
& CTF_UNSIGNED
)
1070 *(uint32_t *)dp
= d
->size
== 1 ? (uint32_t)*(uint8_t *)dp
:
1071 (uint32_t)*(uint16_t *)dp
;
1073 *(int32_t *)dp
= d
->size
== 1 ? (int32_t)*(int8_t *)dp
:
1074 (int32_t)*(int16_t *)dp
;
1076 #if LJ_TARGET_ARM64 && LJ_BE
1077 if (isfp
&& d
->size
== sizeof(float))
1078 ((float *)dp
)[1] = ((float *)dp
)[0]; /* Floats occupy high slot. */
1080 #if LJ_TARGET_MIPS64 || (LJ_TARGET_ARM64 && LJ_BE)
1081 if ((ctype_isinteger_or_bool(d
->info
) || ctype_isenum(d
->info
)
1082 #if LJ_TARGET_MIPS64
1083 || (isfp
&& nsp
== 0)
1085 ) && d
->size
<= 4) {
1086 *(int64_t *)dp
= (int64_t)*(int32_t *)dp
; /* Sign-extend to 64 bit. */
1089 #if LJ_TARGET_X64 && LJ_ABI_WIN
1090 if (isva
) { /* Windows/x64 mirrors varargs in both register sets. */
1092 cc
->gpr
[ngpr
-1] = cc
->fpr
[ngpr
-1].l
[0];
1094 cc
->fpr
[ngpr
-1].l
[0] = cc
->gpr
[ngpr
-1];
1099 #if LJ_TARGET_X64 && !LJ_ABI_WIN
1100 if (isfp
== 2 && n
== 2 && (uint8_t *)dp
== (uint8_t *)&cc
->fpr
[nfpr
-2]) {
1101 cc
->fpr
[nfpr
-1].d
[0] = cc
->fpr
[nfpr
-2].d
[1]; /* Split complex double. */
1102 cc
->fpr
[nfpr
-2].d
[1] = 0;
1104 #elif LJ_TARGET_ARM64 || (LJ_TARGET_MIPS64 && !LJ_ABI_SOFTFP)
1105 if (isfp
== 2 && (uint8_t *)dp
< (uint8_t *)cc
->stack
) {
1106 /* Split float HFA or complex float into separate registers. */
1107 CTSize i
= (sz
>> 2) - 1;
1108 do { ((uint64_t *)dp
)[i
] = ((uint32_t *)dp
)[i
]; } while (i
--);
1114 if (fid
) lj_err_caller(L
, LJ_ERR_FFI_NUMARG
); /* Too few arguments. */
1115 #if LJ_TARGET_ARM64 && LJ_ABI_WIN
1116 if ((int32_t)nsp
< 0) nsp
= 0;
1119 #if LJ_TARGET_X64 || (LJ_TARGET_PPC && !LJ_ABI_SOFTFP)
1120 cc
->nfpr
= nfpr
; /* Required for vararg functions. */
1122 cc
->nsp
= (nsp
+ CTSIZE_PTR
-1) & ~(CTSIZE_PTR
-1);
1123 cc
->spadj
= (CCALL_SPS_FREE
+ CCALL_SPS_EXTRA
) * CTSIZE_PTR
;
1124 if (cc
->nsp
> CCALL_SPS_FREE
* CTSIZE_PTR
)
1125 cc
->spadj
+= (((cc
->nsp
- CCALL_SPS_FREE
* CTSIZE_PTR
) + 15u) & ~15u);
1129 /* Get results from C call. */
1130 static int ccall_get_results(lua_State
*L
, CTState
*cts
, CType
*ct
,
1131 CCallState
*cc
, int *ret
)
1133 CType
*ctr
= ctype_rawchild(cts
, ct
);
1134 uint8_t *sp
= (uint8_t *)&cc
->gpr
[0];
1135 if (ctype_isvoid(ctr
->info
)) {
1136 *ret
= 0; /* Zero results. */
1137 return 0; /* No additional GC step. */
1139 *ret
= 1; /* One result. */
1140 if (ctype_isstruct(ctr
->info
)) {
1141 /* Return cdata object which is already on top of stack. */
1143 void *dp
= cdataptr(cdataV(L
->top
-1)); /* Use preallocated object. */
1144 CCALL_HANDLE_STRUCTRET2
1146 return 1; /* One GC step. */
1148 if (ctype_iscomplex(ctr
->info
)) {
1149 /* Return cdata object which is already on top of stack. */
1150 void *dp
= cdataptr(cdataV(L
->top
-1)); /* Use preallocated object. */
1151 CCALL_HANDLE_COMPLEXRET2
1152 return 1; /* One GC step. */
1154 if (LJ_BE
&& ctr
->size
< CTSIZE_PTR
&&
1155 (ctype_isinteger_or_bool(ctr
->info
) || ctype_isenum(ctr
->info
)))
1156 sp
+= (CTSIZE_PTR
- ctr
->size
);
1158 if (ctype_isfp(ctr
->info
) || ctype_isvector(ctr
->info
))
1159 sp
= (uint8_t *)&cc
->fpr
[0];
1161 #ifdef CCALL_HANDLE_RET
1164 /* No reference types end up here, so there's no need for the CTypeID. */
1165 lj_assertL(!(ctype_isrefarray(ctr
->info
) || ctype_isstruct(ctr
->info
)),
1166 "unexpected reference ctype");
1167 return lj_cconv_tv_ct(cts
, ctr
, 0, L
->top
-1, sp
);
1170 /* Call C function. */
1171 int lj_ccall_func(lua_State
*L
, GCcdata
*cd
)
1173 CTState
*cts
= ctype_cts(L
);
1174 CType
*ct
= ctype_raw(cts
, cd
->ctypeid
);
1175 CTSize sz
= CTSIZE_PTR
;
1176 if (ctype_isptr(ct
->info
)) {
1178 ct
= ctype_rawchild(cts
, ct
);
1180 if (ctype_isfunc(ct
->info
)) {
1183 cc
.func
= (void (*)(void))cdata_getptr(cdataptr(cd
), sz
);
1184 gcsteps
= ccall_set_args(L
, cts
, ct
, &cc
);
1185 ct
= (CType
*)((intptr_t)ct
-(intptr_t)cts
->tab
);
1187 lj_vm_ffi_call(&cc
);
1188 if (cts
->cb
.slot
!= ~0u) { /* Blacklist function that called a callback. */
1190 tv
.u64
= ((uintptr_t)(void *)cc
.func
>> 2) | U64x(800000000, 00000000);
1191 setboolV(lj_tab_set(L
, cts
->miscmap
, &tv
), 1);
1193 ct
= (CType
*)((intptr_t)ct
+(intptr_t)cts
->tab
); /* May be reallocated. */
1194 gcsteps
+= ccall_get_results(L
, cts
, ct
, &cc
, &ret
);
1195 #if LJ_TARGET_X86 && LJ_ABI_WIN
1196 /* Automatically detect __stdcall and fix up C function declaration. */
1197 if (cc
.spadj
&& ctype_cconv(ct
->info
) == CTCC_CDECL
) {
1198 CTF_INSERT(ct
->info
, CCONV
, CTCC_STDCALL
);
1199 lj_trace_abort(G(L
));
1202 while (gcsteps
-- > 0)
1206 return -1; /* Not a function. */