1 /*
2 ** IR CALL* instruction definitions.
3 ** Copyright (C) 2005-2021 Mike Pall. See Copyright Notice in luajit.h
4 */
5 
6 #ifndef _LJ_IRCALL_H
7 #define _LJ_IRCALL_H
8 
9 #include "lj_obj.h"
10 #include "lj_ir.h"
11 #include "lj_jit.h"
12 
13 /* C call info for CALL* instructions. */
14 typedef struct CCallInfo {
15   ASMFunction func;		/* Function pointer. */
16   uint32_t flags;		/* Number of arguments and flags. */
17 } CCallInfo;
18 
19 #define CCI_NARGS(ci)		((ci)->flags & 0xff)	/* # of args. */
20 #define CCI_NARGS_MAX		32			/* Max. # of args. */
21 
22 #define CCI_OTSHIFT		16
23 #define CCI_OPTYPE(ci)		((ci)->flags >> CCI_OTSHIFT)  /* Get op/type. */
24 #define CCI_TYPE(ci)		(((ci)->flags>>CCI_OTSHIFT) & IRT_TYPE)
25 #define CCI_OPSHIFT		24
26 #define CCI_OP(ci)		((ci)->flags >> CCI_OPSHIFT)  /* Get op. */
27 
28 #define CCI_CALL_N		(IR_CALLN << CCI_OPSHIFT)
29 #define CCI_CALL_A		(IR_CALLA << CCI_OPSHIFT)
30 #define CCI_CALL_L		(IR_CALLL << CCI_OPSHIFT)
31 #define CCI_CALL_S		(IR_CALLS << CCI_OPSHIFT)
32 #define CCI_CALL_FN		(CCI_CALL_N|CCI_CC_FASTCALL)
33 #define CCI_CALL_FA		(CCI_CALL_A|CCI_CC_FASTCALL)
34 #define CCI_CALL_FL		(CCI_CALL_L|CCI_CC_FASTCALL)
35 #define CCI_CALL_FS		(CCI_CALL_S|CCI_CC_FASTCALL)
36 
37 /* C call info flags. */
38 #define CCI_T			(IRT_GUARD << CCI_OTSHIFT)  /* May throw. */
39 #define CCI_L			0x0100	/* Implicit L arg. */
40 #define CCI_CASTU64		0x0200	/* Cast u64 result to number. */
41 #define CCI_NOFPRCLOBBER	0x0400	/* Does not clobber any FPRs. */
42 #define CCI_VARARG		0x0800	/* Vararg function. */
43 
44 #define CCI_CC_MASK		0x3000	/* Calling convention mask. */
45 #define CCI_CC_SHIFT		12
46 /* ORDER CC */
47 #define CCI_CC_CDECL		0x0000	/* Default cdecl calling convention. */
48 #define CCI_CC_THISCALL		0x1000	/* Thiscall calling convention. */
49 #define CCI_CC_FASTCALL		0x2000	/* Fastcall calling convention. */
50 #define CCI_CC_STDCALL		0x3000	/* Stdcall calling convention. */
51 
52 /* Extra args for SOFTFP, SPLIT 64 bit. */
53 #define CCI_XARGS_SHIFT		14
54 #define CCI_XARGS(ci)		(((ci)->flags >> CCI_XARGS_SHIFT) & 3)
55 #define CCI_XA			(1u << CCI_XARGS_SHIFT)
56 
57 #if LJ_SOFTFP32 || (LJ_32 && LJ_HASFFI)
58 #define CCI_XNARGS(ci)		(CCI_NARGS((ci)) + CCI_XARGS((ci)))
59 #else
60 #define CCI_XNARGS(ci)		CCI_NARGS((ci))
61 #endif
62 
63 /* Helpers for conditional function definitions. */
64 #define IRCALLCOND_ANY(x)		x
65 
66 #if LJ_TARGET_X86ORX64
67 #define IRCALLCOND_FPMATH(x)		NULL
68 #else
69 #define IRCALLCOND_FPMATH(x)		x
70 #endif
71 
72 #if LJ_SOFTFP
73 #define IRCALLCOND_SOFTFP(x)		x
74 #if LJ_HASFFI
75 #define IRCALLCOND_SOFTFP_FFI(x)	x
76 #else
77 #define IRCALLCOND_SOFTFP_FFI(x)	NULL
78 #endif
79 #else
80 #define IRCALLCOND_SOFTFP(x)		NULL
81 #define IRCALLCOND_SOFTFP_FFI(x)	NULL
82 #endif
83 
84 #if LJ_SOFTFP && LJ_TARGET_MIPS
85 #define IRCALLCOND_SOFTFP_MIPS(x)	x
86 #else
87 #define IRCALLCOND_SOFTFP_MIPS(x)	NULL
88 #endif
89 
90 #if LJ_SOFTFP && LJ_TARGET_MIPS64
91 #define IRCALLCOND_SOFTFP_MIPS64(x)	x
92 #else
93 #define IRCALLCOND_SOFTFP_MIPS64(x)	NULL
94 #endif
95 
96 #define LJ_NEED_FP64	(LJ_TARGET_ARM || LJ_TARGET_PPC || LJ_TARGET_MIPS)
97 
98 #if LJ_HASFFI && (LJ_SOFTFP || LJ_NEED_FP64)
99 #define IRCALLCOND_FP64_FFI(x)		x
100 #else
101 #define IRCALLCOND_FP64_FFI(x)		NULL
102 #endif
103 
104 #if LJ_HASFFI
105 #define IRCALLCOND_FFI(x)		x
106 #if LJ_32
107 #define IRCALLCOND_FFI32(x)		x
108 #else
109 #define IRCALLCOND_FFI32(x)		NULL
110 #endif
111 #else
112 #define IRCALLCOND_FFI(x)		NULL
113 #define IRCALLCOND_FFI32(x)		NULL
114 #endif
115 
116 #if LJ_HASBUFFER
117 #define IRCALLCOND_BUFFER(x)		x
118 #else
119 #define IRCALLCOND_BUFFER(x)		NULL
120 #endif
121 
122 #if LJ_HASBUFFER && LJ_HASFFI
123 #define IRCALLCOND_BUFFFI(x)		x
124 #else
125 #define IRCALLCOND_BUFFFI(x)		NULL
126 #endif
127 
128 #if LJ_SOFTFP
129 #define XA_FP		CCI_XA
130 #define XA2_FP		(CCI_XA+CCI_XA)
131 #else
132 #define XA_FP		0
133 #define XA2_FP		0
134 #endif
135 
136 #if LJ_SOFTFP32
137 #define XA_FP32		CCI_XA
138 #define XA2_FP32	(CCI_XA+CCI_XA)
139 #else
140 #define XA_FP32		0
141 #define XA2_FP32	0
142 #endif
143 
144 #if LJ_32
145 #define XA_64		CCI_XA
146 #define XA2_64		(CCI_XA+CCI_XA)
147 #else
148 #define XA_64		0
149 #define XA2_64		0
150 #endif
151 
152 /* Function definitions for CALL* instructions. */
153 #define IRCALLDEF(_) \
154   _(ANY,	lj_str_cmp,		2,  FN, INT, CCI_NOFPRCLOBBER) \
155   _(ANY,	lj_str_find,		4,   N, PGC, 0) \
156   _(ANY,	lj_str_new,		3,   S, STR, CCI_L|CCI_T) \
157   _(ANY,	lj_strscan_num,		2,  FN, INT, 0) \
158   _(ANY,	lj_strfmt_int,		2,  FN, STR, CCI_L|CCI_T) \
159   _(ANY,	lj_strfmt_num,		2,  FN, STR, CCI_L|CCI_T) \
160   _(ANY,	lj_strfmt_char,		2,  FN, STR, CCI_L|CCI_T) \
161   _(ANY,	lj_strfmt_putint,	2,  FL, PGC, CCI_T) \
162   _(ANY,	lj_strfmt_putnum,	2,  FL, PGC, CCI_T) \
163   _(ANY,	lj_strfmt_putquoted,	2,  FL, PGC, CCI_T) \
164   _(ANY,	lj_strfmt_putfxint,	3,   L, PGC, XA_64|CCI_T) \
165   _(ANY,	lj_strfmt_putfnum_int,	3,   L, PGC, XA_FP|CCI_T) \
166   _(ANY,	lj_strfmt_putfnum_uint,	3,   L, PGC, XA_FP|CCI_T) \
167   _(ANY,	lj_strfmt_putfnum,	3,   L, PGC, XA_FP|CCI_T) \
168   _(ANY,	lj_strfmt_putfstr,	3,   L, PGC, CCI_T) \
169   _(ANY,	lj_strfmt_putfchar,	3,   L, PGC, CCI_T) \
170   _(ANY,	lj_buf_putmem,		3,   S, PGC, CCI_T) \
171   _(ANY,	lj_buf_putstr,		2,  FL, PGC, CCI_T) \
172   _(ANY,	lj_buf_putchar,		2,  FL, PGC, CCI_T) \
173   _(ANY,	lj_buf_putstr_reverse,	2,  FL, PGC, CCI_T) \
174   _(ANY,	lj_buf_putstr_lower,	2,  FL, PGC, CCI_T) \
175   _(ANY,	lj_buf_putstr_upper,	2,  FL, PGC, CCI_T) \
176   _(ANY,	lj_buf_putstr_rep,	3,   L, PGC, CCI_T) \
177   _(ANY,	lj_buf_puttab,		5,   L, PGC, CCI_T) \
178   _(BUFFER,	lj_bufx_set,		4,   S, NIL, 0) \
179   _(BUFFFI,	lj_bufx_more,		2,  FS, INT, CCI_T) \
180   _(BUFFER,	lj_serialize_put,	2,  FS, PGC, CCI_T) \
181   _(BUFFER,	lj_serialize_get,	2,  FS, PTR, CCI_T) \
182   _(BUFFER,	lj_serialize_encode,	2,  FA, STR, CCI_L|CCI_T) \
183   _(BUFFER,	lj_serialize_decode,	3,   A, INT, CCI_L|CCI_T) \
184   _(ANY,	lj_buf_tostr,		1,  FL, STR, CCI_T) \
185   _(ANY,	lj_tab_new_ah,		3,   A, TAB, CCI_L|CCI_T) \
186   _(ANY,	lj_tab_new1,		2,  FA, TAB, CCI_L|CCI_T) \
187   _(ANY,	lj_tab_dup,		2,  FA, TAB, CCI_L|CCI_T) \
188   _(ANY,	lj_tab_clear,		1,  FS, NIL, 0) \
189   _(ANY,	lj_tab_newkey,		3,   S, PGC, CCI_L|CCI_T) \
190   _(ANY,	lj_tab_keyindex,	2,  FL, INT, 0) \
191   _(ANY,	lj_vm_next,		2,  FL, PTR, 0) \
192   _(ANY,	lj_tab_len,		1,  FL, INT, 0) \
193   _(ANY,	lj_tab_len_hint,	2,  FL, INT, 0) \
194   _(ANY,	lj_gc_step_jit,		2,  FS, NIL, CCI_L) \
195   _(ANY,	lj_gc_barrieruv,	2,  FS, NIL, 0) \
196   _(ANY,	lj_mem_newgco,		2,  FA, PGC, CCI_L|CCI_T) \
197   _(ANY,	lj_prng_u64d,		1,  FS, NUM, CCI_CASTU64) \
198   _(ANY,	lj_vm_modi,		2,  FN, INT, 0) \
199   _(ANY,	log10,			1,   N, NUM, XA_FP) \
200   _(ANY,	exp,			1,   N, NUM, XA_FP) \
201   _(ANY,	sin,			1,   N, NUM, XA_FP) \
202   _(ANY,	cos,			1,   N, NUM, XA_FP) \
203   _(ANY,	tan,			1,   N, NUM, XA_FP) \
204   _(ANY,	asin,			1,   N, NUM, XA_FP) \
205   _(ANY,	acos,			1,   N, NUM, XA_FP) \
206   _(ANY,	atan,			1,   N, NUM, XA_FP) \
207   _(ANY,	sinh,			1,   N, NUM, XA_FP) \
208   _(ANY,	cosh,			1,   N, NUM, XA_FP) \
209   _(ANY,	tanh,			1,   N, NUM, XA_FP) \
210   _(ANY,	fputc,			2,   S, INT, 0) \
211   _(ANY,	fwrite,			4,   S, INT, 0) \
212   _(ANY,	fflush,			1,   S, INT, 0) \
213   /* ORDER FPM */ \
214   _(FPMATH,	lj_vm_floor,		1,   N, NUM, XA_FP) \
215   _(FPMATH,	lj_vm_ceil,		1,   N, NUM, XA_FP) \
216   _(FPMATH,	lj_vm_trunc,		1,   N, NUM, XA_FP) \
217   _(FPMATH,	sqrt,			1,   N, NUM, XA_FP) \
218   _(ANY,	log,			1,   N, NUM, XA_FP) \
219   _(ANY,	lj_vm_log2,		1,   N, NUM, XA_FP) \
220   _(ANY,	lj_vm_powi,		2,   N, NUM, XA_FP) \
221   _(ANY,	pow,			2,   N, NUM, XA2_FP) \
222   _(ANY,	atan2,			2,   N, NUM, XA2_FP) \
223   _(ANY,	ldexp,			2,   N, NUM, XA_FP) \
224   _(SOFTFP,	lj_vm_tobit,		1,   N, INT, XA_FP32) \
225   _(SOFTFP,	softfp_add,		2,   N, NUM, XA2_FP32) \
226   _(SOFTFP,	softfp_sub,		2,   N, NUM, XA2_FP32) \
227   _(SOFTFP,	softfp_mul,		2,   N, NUM, XA2_FP32) \
228   _(SOFTFP,	softfp_div,		2,   N, NUM, XA2_FP32) \
229   _(SOFTFP,	softfp_cmp,		2,   N, NIL, XA2_FP32) \
230   _(SOFTFP,	softfp_i2d,		1,   N, NUM, 0) \
231   _(SOFTFP,	softfp_d2i,		1,   N, INT, XA_FP32) \
232   _(SOFTFP_MIPS, lj_vm_sfmin,		2,   N, NUM, XA2_FP32) \
233   _(SOFTFP_MIPS, lj_vm_sfmax,		2,   N, NUM, XA2_FP32) \
234   _(SOFTFP_MIPS64, lj_vm_tointg,	1,   N, INT, 0) \
235   _(SOFTFP_FFI,	softfp_ui2d,		1,   N, NUM, 0) \
236   _(SOFTFP_FFI,	softfp_f2d,		1,   N, NUM, 0) \
237   _(SOFTFP_FFI,	softfp_d2ui,		1,   N, INT, XA_FP32) \
238   _(SOFTFP_FFI,	softfp_d2f,		1,   N, FLOAT, XA_FP32) \
239   _(SOFTFP_FFI,	softfp_i2f,		1,   N, FLOAT, 0) \
240   _(SOFTFP_FFI,	softfp_ui2f,		1,   N, FLOAT, 0) \
241   _(SOFTFP_FFI,	softfp_f2i,		1,   N, INT, 0) \
242   _(SOFTFP_FFI,	softfp_f2ui,		1,   N, INT, 0) \
243   _(FP64_FFI,	fp64_l2d,		1,   N, NUM, XA_64) \
244   _(FP64_FFI,	fp64_ul2d,		1,   N, NUM, XA_64) \
245   _(FP64_FFI,	fp64_l2f,		1,   N, FLOAT, XA_64) \
246   _(FP64_FFI,	fp64_ul2f,		1,   N, FLOAT, XA_64) \
247   _(FP64_FFI,	fp64_d2l,		1,   N, I64, XA_FP) \
248   _(FP64_FFI,	fp64_d2ul,		1,   N, U64, XA_FP) \
249   _(FP64_FFI,	fp64_f2l,		1,   N, I64, 0) \
250   _(FP64_FFI,	fp64_f2ul,		1,   N, U64, 0) \
251   _(FFI,	lj_carith_divi64,	2,   N, I64, XA2_64|CCI_NOFPRCLOBBER) \
252   _(FFI,	lj_carith_divu64,	2,   N, U64, XA2_64|CCI_NOFPRCLOBBER) \
253   _(FFI,	lj_carith_modi64,	2,   N, I64, XA2_64|CCI_NOFPRCLOBBER) \
254   _(FFI,	lj_carith_modu64,	2,   N, U64, XA2_64|CCI_NOFPRCLOBBER) \
255   _(FFI,	lj_carith_powi64,	2,   N, I64, XA2_64|CCI_NOFPRCLOBBER) \
256   _(FFI,	lj_carith_powu64,	2,   N, U64, XA2_64|CCI_NOFPRCLOBBER) \
257   _(FFI,	lj_cdata_newv,		4,   S, CDATA, CCI_L) \
258   _(FFI,	lj_cdata_setfin,	4,   S, NIL, CCI_L) \
259   _(FFI,	strlen,			1,   L, INTP, 0) \
260   _(FFI,	memcpy,			3,   S, PTR, 0) \
261   _(FFI,	memset,			3,   S, PTR, 0) \
262   _(FFI,	lj_vm_errno,		0,   S, INT, CCI_NOFPRCLOBBER) \
263   _(FFI32,	lj_carith_mul64,	2,   N, I64, XA2_64|CCI_NOFPRCLOBBER) \
264   _(FFI32,	lj_carith_shl64,	2,   N, U64, XA_64|CCI_NOFPRCLOBBER) \
265   _(FFI32,	lj_carith_shr64,	2,   N, U64, XA_64|CCI_NOFPRCLOBBER) \
266   _(FFI32,	lj_carith_sar64,	2,   N, U64, XA_64|CCI_NOFPRCLOBBER) \
267   _(FFI32,	lj_carith_rol64,	2,   N, U64, XA_64|CCI_NOFPRCLOBBER) \
268   _(FFI32,	lj_carith_ror64,	2,   N, U64, XA_64|CCI_NOFPRCLOBBER) \
269   \
270   /* End of list. */
271 
272 typedef enum {
273 #define IRCALLENUM(cond, name, nargs, kind, type, flags)	IRCALL_##name,
274 IRCALLDEF(IRCALLENUM)
275 #undef IRCALLENUM
276   IRCALL__MAX
277 } IRCallID;
278 
279 LJ_FUNC TRef lj_ir_call(jit_State *J, IRCallID id, ...);
280 
281 LJ_DATA const CCallInfo lj_ir_callinfo[IRCALL__MAX+1];
282 
283 /* Soft-float declarations. */
284 #if LJ_SOFTFP
285 #if LJ_TARGET_ARM
286 #define softfp_add __aeabi_dadd
287 #define softfp_sub __aeabi_dsub
288 #define softfp_mul __aeabi_dmul
289 #define softfp_div __aeabi_ddiv
290 #define softfp_cmp __aeabi_cdcmple
291 #define softfp_i2d __aeabi_i2d
292 #define softfp_d2i __aeabi_d2iz
293 #define softfp_ui2d __aeabi_ui2d
294 #define softfp_f2d __aeabi_f2d
295 #define softfp_d2ui __aeabi_d2uiz
296 #define softfp_d2f __aeabi_d2f
297 #define softfp_i2f __aeabi_i2f
298 #define softfp_ui2f __aeabi_ui2f
299 #define softfp_f2i __aeabi_f2iz
300 #define softfp_f2ui __aeabi_f2uiz
301 #define fp64_l2d __aeabi_l2d
302 #define fp64_ul2d __aeabi_ul2d
303 #define fp64_l2f __aeabi_l2f
304 #define fp64_ul2f __aeabi_ul2f
305 #if LJ_TARGET_IOS
306 #define fp64_d2l __fixdfdi
307 #define fp64_d2ul __fixunsdfdi
308 #define fp64_f2l __fixsfdi
309 #define fp64_f2ul __fixunssfdi
310 #else
311 #define fp64_d2l __aeabi_d2lz
312 #define fp64_d2ul __aeabi_d2ulz
313 #define fp64_f2l __aeabi_f2lz
314 #define fp64_f2ul __aeabi_f2ulz
315 #endif
316 #elif LJ_TARGET_MIPS || LJ_TARGET_PPC
317 #define softfp_add __adddf3
318 #define softfp_sub __subdf3
319 #define softfp_mul __muldf3
320 #define softfp_div __divdf3
321 #define softfp_cmp __ledf2
322 #define softfp_i2d __floatsidf
323 #define softfp_d2i __fixdfsi
324 #define softfp_ui2d __floatunsidf
325 #define softfp_f2d __extendsfdf2
326 #define softfp_d2ui __fixunsdfsi
327 #define softfp_d2f __truncdfsf2
328 #define softfp_i2f __floatsisf
329 #define softfp_ui2f __floatunsisf
330 #define softfp_f2i __fixsfsi
331 #define softfp_f2ui __fixunssfsi
332 #else
333 #error "Missing soft-float definitions for target architecture"
334 #endif
335 extern double softfp_add(double a, double b);
336 extern double softfp_sub(double a, double b);
337 extern double softfp_mul(double a, double b);
338 extern double softfp_div(double a, double b);
339 extern void softfp_cmp(double a, double b);
340 extern double softfp_i2d(int32_t a);
341 extern int32_t softfp_d2i(double a);
342 #if LJ_HASFFI
343 extern double softfp_ui2d(uint32_t a);
344 extern double softfp_f2d(float a);
345 extern uint32_t softfp_d2ui(double a);
346 extern float softfp_d2f(double a);
347 extern float softfp_i2f(int32_t a);
348 extern float softfp_ui2f(uint32_t a);
349 extern int32_t softfp_f2i(float a);
350 extern uint32_t softfp_f2ui(float a);
351 #endif
352 #if LJ_TARGET_MIPS
353 extern double lj_vm_sfmin(double a, double b);
354 extern double lj_vm_sfmax(double a, double b);
355 #endif
356 #endif
357 
358 #if LJ_HASFFI && LJ_NEED_FP64 && !(LJ_TARGET_ARM && LJ_SOFTFP)
359 #if defined(__GNUC__) || defined(__clang__)
360 #define fp64_l2d __floatdidf
361 #define fp64_ul2d __floatundidf
362 #define fp64_l2f __floatdisf
363 #define fp64_ul2f __floatundisf
364 #define fp64_d2l __fixdfdi
365 #define fp64_d2ul __fixunsdfdi
366 #define fp64_f2l __fixsfdi
367 #define fp64_f2ul __fixunssfdi
368 #else
369 #error "Missing fp64 helper definitions for this compiler"
370 #endif
371 #endif
372 
373 #if LJ_HASFFI && (LJ_SOFTFP || LJ_NEED_FP64)
374 extern double fp64_l2d(int64_t a);
375 extern double fp64_ul2d(uint64_t a);
376 extern float fp64_l2f(int64_t a);
377 extern float fp64_ul2f(uint64_t a);
378 extern int64_t fp64_d2l(double a);
379 extern uint64_t fp64_d2ul(double a);
380 extern int64_t fp64_f2l(float a);
381 extern uint64_t fp64_f2ul(float a);
382 #endif
383 
384 #endif
385