Swap f32 and f64 argument types.
[sljit.git] / sljit_src / sljitLir.h
blob0f57ce20c7feca90633fb44777487a2e8aa43a5a
1 /*
2 * Stack-less Just-In-Time compiler
4 * Copyright Zoltan Herczeg (hzmester@freemail.hu). All rights reserved.
6 * Redistribution and use in source and binary forms, with or without modification, are
7 * permitted provided that the following conditions are met:
9 * 1. Redistributions of source code must retain the above copyright notice, this list of
10 * conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright notice, this list
13 * of conditions and the following disclaimer in the documentation and/or other materials
14 * provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND CONTRIBUTORS ``AS IS'' AND ANY
17 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
19 * SHALL THE COPYRIGHT HOLDER(S) OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
21 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
22 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
24 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 #ifndef SLJIT_LIR_H_
28 #define SLJIT_LIR_H_
31 ------------------------------------------------------------------------
32 Stack-Less JIT compiler for multiple architectures (x86, ARM, PowerPC)
33 ------------------------------------------------------------------------
35 Short description
36 Advantages:
37 - The execution can be continued from any LIR instruction. In other
38 words, it is possible to jump to any label from anywhere, even from
39 a code fragment, which is compiled later, if both compiled code
40 shares the same context. See sljit_emit_enter for more details
41 - Supports self modifying code: target of (conditional) jump and call
42 instructions and some constant values can be dynamically modified
43 during runtime
44 - although it is not suggested to do it frequently
45 - can be used for inline caching: save an important value once
46 in the instruction stream
47 - since this feature limits the optimization possibilities, a
48 special flag must be passed at compile time when these
49 instructions are emitted
50 - A fixed stack space can be allocated for local variables
51 - The compiler is thread-safe
52 - The compiler is highly configurable through preprocessor macros.
53 You can disable unneeded features (multithreading in single
54 threaded applications), and you can use your own system functions
55 (including memory allocators). See sljitConfig.h
56 Disadvantages:
57 - No automatic register allocation, and temporary results are
58 not stored on the stack. (hence the name comes)
59 In practice:
60 - This approach is very effective for interpreters
61 - One of the saved registers typically points to a stack interface
62 - It can jump to any exception handler anytime (even if it belongs
63 to another function)
64 - Hot paths can be modified during runtime reflecting the changes
65 of the fastest execution path of the dynamic language
66 - SLJIT supports complex memory addressing modes
67 - mainly position and context independent code (except some cases)
69 For valgrind users:
70 - pass --smc-check=all argument to valgrind, since JIT is a "self-modifying code"
73 #if (defined SLJIT_HAVE_CONFIG_PRE && SLJIT_HAVE_CONFIG_PRE)
74 #include "sljitConfigPre.h"
75 #endif /* SLJIT_HAVE_CONFIG_PRE */
77 #include "sljitConfig.h"
79 /* The following header file defines useful macros for fine tuning
80 sljit based code generators. They are listed in the beginning
81 of sljitConfigInternal.h */
83 #include "sljitConfigInternal.h"
85 #if (defined SLJIT_HAVE_CONFIG_POST && SLJIT_HAVE_CONFIG_POST)
86 #include "sljitConfigPost.h"
87 #endif /* SLJIT_HAVE_CONFIG_POST */
89 #ifdef __cplusplus
90 extern "C" {
91 #endif
93 /* --------------------------------------------------------------------- */
94 /* Error codes */
95 /* --------------------------------------------------------------------- */
97 /* Indicates no error. */
98 #define SLJIT_SUCCESS 0
99 /* After the call of sljit_generate_code(), the error code of the compiler
100 is set to this value to avoid future sljit calls (in debug mode at least).
101 The complier should be freed after sljit_generate_code(). */
102 #define SLJIT_ERR_COMPILED 1
103 /* Cannot allocate non executable memory. */
104 #define SLJIT_ERR_ALLOC_FAILED 2
105 /* Cannot allocate executable memory.
106 Only for sljit_generate_code() */
107 #define SLJIT_ERR_EX_ALLOC_FAILED 3
108 /* Return value for SLJIT_CONFIG_UNSUPPORTED placeholder architecture. */
109 #define SLJIT_ERR_UNSUPPORTED 4
110 /* An ivalid argument is passed to any SLJIT function. */
111 #define SLJIT_ERR_BAD_ARGUMENT 5
112 /* Dynamic code modification is not enabled. */
113 #define SLJIT_ERR_DYN_CODE_MOD 6
115 /* --------------------------------------------------------------------- */
116 /* Registers */
117 /* --------------------------------------------------------------------- */
120 Scratch (R) registers: registers whose may not preserve their values
121 across function calls.
123 Saved (S) registers: registers whose preserve their values across
124 function calls.
126 The scratch and saved register sets are overlap. The last scratch register
127 is the first saved register, the one before the last is the second saved
128 register, and so on.
130 If an architecture provides two scratch and three saved registers,
131 its scratch and saved register sets are the following:
133 R0 | | R0 is always a scratch register
134 R1 | | R1 is always a scratch register
135 [R2] | S2 | R2 and S2 represent the same physical register
136 [R3] | S1 | R3 and S1 represent the same physical register
137 [R4] | S0 | R4 and S0 represent the same physical register
139 Note: SLJIT_NUMBER_OF_SCRATCH_REGISTERS would be 2 and
140 SLJIT_NUMBER_OF_SAVED_REGISTERS would be 3 for this architecture.
142 Note: On all supported architectures SLJIT_NUMBER_OF_REGISTERS >= 12
143 and SLJIT_NUMBER_OF_SAVED_REGISTERS >= 6. However, 6 registers
144 are virtual on x86-32. See below.
146 The purpose of this definition is convenience: saved registers can
147 be used as extra scratch registers. For example four registers can
148 be specified as scratch registers and the fifth one as saved register
149 on the CPU above and any user code which requires four scratch
150 registers can run unmodified. The SLJIT compiler automatically saves
151 the content of the two extra scratch register on the stack. Scratch
152 registers can also be preserved by saving their value on the stack
153 but this needs to be done manually.
155 Note: To emphasize that registers assigned to R2-R4 are saved
156 registers, they are enclosed by square brackets.
158 Note: sljit_emit_enter and sljit_set_context defines whether a register
159 is S or R register. E.g: when 3 scratches and 1 saved is mapped
160 by sljit_emit_enter, the allowed register set will be: R0-R2 and
161 S0. Although S2 is mapped to the same position as R2, it does not
162 available in the current configuration. Furthermore the S1 register
163 is not available at all.
166 /* Scratch registers. */
167 #define SLJIT_R0 1
168 #define SLJIT_R1 2
169 #define SLJIT_R2 3
170 /* Note: on x86-32, R3 - R6 (same as S3 - S6) are emulated (they
171 are allocated on the stack). These registers are called virtual
172 and cannot be used for memory addressing (cannot be part of
173 any SLJIT_MEM1, SLJIT_MEM2 construct). There is no such
174 limitation on other CPUs. See sljit_get_register_index(). */
175 #define SLJIT_R3 4
176 #define SLJIT_R4 5
177 #define SLJIT_R5 6
178 #define SLJIT_R6 7
179 #define SLJIT_R7 8
180 #define SLJIT_R8 9
181 #define SLJIT_R9 10
182 /* All R registers provided by the architecture can be accessed by SLJIT_R(i)
183 The i parameter must be >= 0 and < SLJIT_NUMBER_OF_REGISTERS. */
184 #define SLJIT_R(i) (1 + (i))
186 /* Saved registers. */
187 #define SLJIT_S0 (SLJIT_NUMBER_OF_REGISTERS)
188 #define SLJIT_S1 (SLJIT_NUMBER_OF_REGISTERS - 1)
189 #define SLJIT_S2 (SLJIT_NUMBER_OF_REGISTERS - 2)
190 /* Note: on x86-32, S3 - S6 (same as R3 - R6) are emulated (they
191 are allocated on the stack). These registers are called virtual
192 and cannot be used for memory addressing (cannot be part of
193 any SLJIT_MEM1, SLJIT_MEM2 construct). There is no such
194 limitation on other CPUs. See sljit_get_register_index(). */
195 #define SLJIT_S3 (SLJIT_NUMBER_OF_REGISTERS - 3)
196 #define SLJIT_S4 (SLJIT_NUMBER_OF_REGISTERS - 4)
197 #define SLJIT_S5 (SLJIT_NUMBER_OF_REGISTERS - 5)
198 #define SLJIT_S6 (SLJIT_NUMBER_OF_REGISTERS - 6)
199 #define SLJIT_S7 (SLJIT_NUMBER_OF_REGISTERS - 7)
200 #define SLJIT_S8 (SLJIT_NUMBER_OF_REGISTERS - 8)
201 #define SLJIT_S9 (SLJIT_NUMBER_OF_REGISTERS - 9)
202 /* All S registers provided by the architecture can be accessed by SLJIT_S(i)
203 The i parameter must be >= 0 and < SLJIT_NUMBER_OF_SAVED_REGISTERS. */
204 #define SLJIT_S(i) (SLJIT_NUMBER_OF_REGISTERS - (i))
206 /* Registers >= SLJIT_FIRST_SAVED_REG are saved registers. */
207 #define SLJIT_FIRST_SAVED_REG (SLJIT_S0 - SLJIT_NUMBER_OF_SAVED_REGISTERS + 1)
209 /* The SLJIT_SP provides direct access to the linear stack space allocated by
210 sljit_emit_enter. It can only be used in the following form: SLJIT_MEM1(SLJIT_SP).
211 The immediate offset is extended by the relative stack offset automatically.
212 The sljit_get_local_base can be used to obtain the absolute offset. */
213 #define SLJIT_SP (SLJIT_NUMBER_OF_REGISTERS + 1)
215 /* Return with machine word. */
217 #define SLJIT_RETURN_REG SLJIT_R0
219 /* --------------------------------------------------------------------- */
220 /* Floating point registers */
221 /* --------------------------------------------------------------------- */
223 /* Each floating point register can store a 32 or a 64 bit precision
224 value. The FR and FS register sets are overlap in the same way as R
225 and S register sets. See above. */
227 /* Floating point scratch registers. */
228 #define SLJIT_FR0 1
229 #define SLJIT_FR1 2
230 #define SLJIT_FR2 3
231 #define SLJIT_FR3 4
232 #define SLJIT_FR4 5
233 #define SLJIT_FR5 6
234 /* All FR registers provided by the architecture can be accessed by SLJIT_FR(i)
235 The i parameter must be >= 0 and < SLJIT_NUMBER_OF_FLOAT_REGISTERS. */
236 #define SLJIT_FR(i) (1 + (i))
238 /* Floating point saved registers. */
239 #define SLJIT_FS0 (SLJIT_NUMBER_OF_FLOAT_REGISTERS)
240 #define SLJIT_FS1 (SLJIT_NUMBER_OF_FLOAT_REGISTERS - 1)
241 #define SLJIT_FS2 (SLJIT_NUMBER_OF_FLOAT_REGISTERS - 2)
242 #define SLJIT_FS3 (SLJIT_NUMBER_OF_FLOAT_REGISTERS - 3)
243 #define SLJIT_FS4 (SLJIT_NUMBER_OF_FLOAT_REGISTERS - 4)
244 #define SLJIT_FS5 (SLJIT_NUMBER_OF_FLOAT_REGISTERS - 5)
245 /* All S registers provided by the architecture can be accessed by SLJIT_FS(i)
246 The i parameter must be >= 0 and < SLJIT_NUMBER_OF_SAVED_FLOAT_REGISTERS. */
247 #define SLJIT_FS(i) (SLJIT_NUMBER_OF_FLOAT_REGISTERS - (i))
249 /* Float registers >= SLJIT_FIRST_SAVED_FLOAT_REG are saved registers. */
250 #define SLJIT_FIRST_SAVED_FLOAT_REG (SLJIT_FS0 - SLJIT_NUMBER_OF_SAVED_FLOAT_REGISTERS + 1)
252 /* --------------------------------------------------------------------- */
253 /* Argument type definitions */
254 /* --------------------------------------------------------------------- */
256 /* The following argument type definitions are used by sljit_emit_enter,
257 sljit_set_context, sljit_emit_call, and sljit_emit_icall functions.
259 As for sljit_emit_enter, the first integer argument is available in
260 SLJIT_R0, the second one in SLJIT_R1, and so on. Similarly the first
261 floating point argument is available in SLJIT_FR0, the second one in
262 SLJIT_FR1, and so on.
264 As for sljit_emit_call and sljit_emit_icall, the first integer argument
265 must be placed into SLJIT_R0, the second one into SLJIT_R1, and so on.
266 Similarly the first floating point argument must be placed into SLJIT_FR0,
267 the second one into SLJIT_FR1, and so on.
269 Example function definition:
270 sljit_f32 SLJIT_FUNC example_c_callback(void *arg_a,
271 sljit_f64 arg_b, sljit_u32 arg_c, sljit_f32 arg_d);
273 Argument type definition:
274 SLJIT_ARG_RETURN(SLJIT_ARG_TYPE_F32)
275 | SLJIT_ARG_VALUE(SLJIT_ARG_TYPE_P, 1) | SLJIT_ARG_VALUE(SLJIT_ARG_TYPE_F64, 2)
276 | SLJIT_ARG_VALUE(SLJIT_ARG_TYPE_32, 3) | SLJIT_ARG_VALUE(SLJIT_ARG_TYPE_F32, 4)
278 Short form of argument type definition:
279 SLJIT_ARGS4(F32, P, F64, 32, F32)
281 Argument passing:
282 arg_a must be placed in SLJIT_R0
283 arg_c must be placed in SLJIT_R1
284 arg_b must be placed in SLJIT_FR0
285 arg_d must be placed in SLJIT_FR1
288 /* Void result, can only be used by SLJIT_ARG_RETURN. */
289 #define SLJIT_ARG_TYPE_VOID 0
290 /* Machine word sized integer argument or result. */
291 #define SLJIT_ARG_TYPE_W 1
292 /* 32 bit integer argument or result. */
293 #define SLJIT_ARG_TYPE_32 2
294 /* Pointer sized integer argument or result. */
295 #define SLJIT_ARG_TYPE_P 3
296 /* 64 bit floating point argument or result. */
297 #define SLJIT_ARG_TYPE_F64 4
298 /* 32 bit floating point argument or result. */
299 #define SLJIT_ARG_TYPE_F32 5
301 #define SLJIT_ARG_SHIFT 4
302 #define SLJIT_ARG_RETURN(type) (type)
303 #define SLJIT_ARG_VALUE(type, idx) ((type) << ((idx) * SLJIT_ARG_SHIFT))
305 /* Simplified argument list definitions.
307 The following definition:
308 SLJIT_ARG_RETURN(SLJIT_ARG_TYPE_SW) | SLJIT_ARG_VALUE(SLJIT_ARG_TYPE_F32, 1)
310 can be shortened to:
311 SLJIT_ARGS1(W, F32)
314 #define SLJIT_ARG_TO_TYPE(type) SLJIT_ARG_TYPE_ ## type
316 #define SLJIT_ARGS0(ret) \
317 SLJIT_ARG_RETURN(SLJIT_ARG_TO_TYPE(ret))
319 #define SLJIT_ARGS1(ret, arg1) \
320 (SLJIT_ARGS0(ret) | SLJIT_ARG_VALUE(SLJIT_ARG_TO_TYPE(arg1), 1))
322 #define SLJIT_ARGS2(ret, arg1, arg2) \
323 (SLJIT_ARGS1(ret, arg1) | SLJIT_ARG_VALUE(SLJIT_ARG_TO_TYPE(arg2), 2))
325 #define SLJIT_ARGS3(ret, arg1, arg2, arg3) \
326 (SLJIT_ARGS2(ret, arg1, arg2) | SLJIT_ARG_VALUE(SLJIT_ARG_TO_TYPE(arg3), 3))
328 #define SLJIT_ARGS4(ret, arg1, arg2, arg3, arg4) \
329 (SLJIT_ARGS3(ret, arg1, arg2, arg3) | SLJIT_ARG_VALUE(SLJIT_ARG_TO_TYPE(arg4), 4))
331 /* --------------------------------------------------------------------- */
332 /* Main structures and functions */
333 /* --------------------------------------------------------------------- */
336 The following structures are private, and can be changed in the
337 future. Keeping them here allows code inlining.
340 struct sljit_memory_fragment {
341 struct sljit_memory_fragment *next;
342 sljit_uw used_size;
343 /* Must be aligned to sljit_sw. */
344 sljit_u8 memory[1];
347 struct sljit_label {
348 struct sljit_label *next;
349 sljit_uw addr;
350 /* The maximum size difference. */
351 sljit_uw size;
354 struct sljit_jump {
355 struct sljit_jump *next;
356 sljit_uw addr;
357 sljit_uw flags;
358 union {
359 sljit_uw target;
360 struct sljit_label *label;
361 } u;
364 struct sljit_put_label {
365 struct sljit_put_label *next;
366 struct sljit_label *label;
367 sljit_uw addr;
368 sljit_uw flags;
371 struct sljit_const {
372 struct sljit_const *next;
373 sljit_uw addr;
376 struct sljit_compiler {
377 sljit_s32 error;
378 sljit_s32 options;
380 struct sljit_label *labels;
381 struct sljit_jump *jumps;
382 struct sljit_put_label *put_labels;
383 struct sljit_const *consts;
384 struct sljit_label *last_label;
385 struct sljit_jump *last_jump;
386 struct sljit_const *last_const;
387 struct sljit_put_label *last_put_label;
389 void *allocator_data;
390 void *exec_allocator_data;
391 struct sljit_memory_fragment *buf;
392 struct sljit_memory_fragment *abuf;
394 /* Used scratch registers. */
395 sljit_s32 scratches;
396 /* Used saved registers. */
397 sljit_s32 saveds;
398 /* Used float scratch registers. */
399 sljit_s32 fscratches;
400 /* Used float saved registers. */
401 sljit_s32 fsaveds;
402 /* Local stack size. */
403 sljit_s32 local_size;
404 /* Code size. */
405 sljit_uw size;
406 /* Relative offset of the executable mapping from the writable mapping. */
407 sljit_uw executable_offset;
408 /* Executable size for statistical purposes. */
409 sljit_uw executable_size;
411 #if (defined SLJIT_HAS_STATUS_FLAGS_STATE && SLJIT_HAS_STATUS_FLAGS_STATE)
412 sljit_s32 status_flags_state;
413 #endif
415 #if (defined SLJIT_CONFIG_X86_32 && SLJIT_CONFIG_X86_32)
416 sljit_s32 args_size;
417 sljit_s32 locals_offset;
418 sljit_s32 saveds_offset;
419 sljit_s32 stack_tmp_size;
420 #endif
422 #if (defined SLJIT_CONFIG_X86_64 && SLJIT_CONFIG_X86_64)
423 sljit_s32 mode32;
424 #ifdef _WIN64
425 sljit_s32 locals_offset;
426 #endif
427 #endif
429 #if (defined SLJIT_CONFIG_ARM_V5 && SLJIT_CONFIG_ARM_V5)
430 /* Constant pool handling. */
431 sljit_uw *cpool;
432 sljit_u8 *cpool_unique;
433 sljit_uw cpool_diff;
434 sljit_uw cpool_fill;
435 /* Other members. */
436 /* Contains pointer, "ldr pc, [...]" pairs. */
437 sljit_uw patches;
438 #endif
440 #if (defined SLJIT_CONFIG_ARM_V5 && SLJIT_CONFIG_ARM_V5) || (defined SLJIT_CONFIG_ARM_V7 && SLJIT_CONFIG_ARM_V7)
441 /* Temporary fields. */
442 sljit_uw shift_imm;
443 #endif
445 #if (defined SLJIT_CONFIG_PPC && SLJIT_CONFIG_PPC)
446 sljit_sw imm;
447 #endif
449 #if (defined SLJIT_CONFIG_MIPS && SLJIT_CONFIG_MIPS)
450 sljit_s32 delay_slot;
451 sljit_s32 cache_arg;
452 sljit_sw cache_argw;
453 #endif
455 #if (defined SLJIT_CONFIG_SPARC_32 && SLJIT_CONFIG_SPARC_32)
456 sljit_s32 delay_slot;
457 sljit_s32 cache_arg;
458 sljit_sw cache_argw;
459 #endif
461 #if (defined SLJIT_CONFIG_S390X && SLJIT_CONFIG_S390X)
462 /* Need to allocate register save area to make calls. */
463 sljit_s32 mode;
464 #endif
466 #if (defined SLJIT_VERBOSE && SLJIT_VERBOSE)
467 FILE* verbose;
468 #endif
470 #if (defined SLJIT_ARGUMENT_CHECKS && SLJIT_ARGUMENT_CHECKS) \
471 || (defined SLJIT_DEBUG && SLJIT_DEBUG)
472 /* Flags specified by the last arithmetic instruction.
473 It contains the type of the variable flag. */
474 sljit_s32 last_flags;
475 /* Local size passed to the functions. */
476 sljit_s32 logical_local_size;
477 #endif
479 #if (defined SLJIT_ARGUMENT_CHECKS && SLJIT_ARGUMENT_CHECKS) \
480 || (defined SLJIT_DEBUG && SLJIT_DEBUG) \
481 || (defined SLJIT_VERBOSE && SLJIT_VERBOSE)
482 /* Trust arguments when the API function is called. */
483 sljit_s32 skip_checks;
484 #endif
487 /* --------------------------------------------------------------------- */
488 /* Main functions */
489 /* --------------------------------------------------------------------- */
491 /* Creates an sljit compiler. The allocator_data is required by some
492 custom memory managers. This pointer is passed to SLJIT_MALLOC
493 and SLJIT_FREE macros. Most allocators (including the default
494 one) ignores this value, and it is recommended to pass NULL
495 as a dummy value for allocator_data. The exec_allocator_data
496 has the same purpose but this one is passed to SLJIT_MALLOC_EXEC /
497 SLJIT_MALLOC_FREE functions.
499 Returns NULL if failed. */
500 SLJIT_API_FUNC_ATTRIBUTE struct sljit_compiler* sljit_create_compiler(void *allocator_data, void *exec_allocator_data);
502 /* Frees everything except the compiled machine code. */
503 SLJIT_API_FUNC_ATTRIBUTE void sljit_free_compiler(struct sljit_compiler *compiler);
505 /* Returns the current error code. If an error is occurred, future sljit
506 calls which uses the same compiler argument returns early with the same
507 error code. Thus there is no need for checking the error after every
508 call, it is enough to do it before the code is compiled. Removing
509 these checks increases the performance of the compiling process. */
510 static SLJIT_INLINE sljit_s32 sljit_get_compiler_error(struct sljit_compiler *compiler) { return compiler->error; }
512 /* Sets the compiler error code to SLJIT_ERR_ALLOC_FAILED except
513 if an error was detected before. After the error code is set
514 the compiler behaves as if the allocation failure happened
515 during an sljit function call. This can greatly simplify error
516 checking, since only the compiler status needs to be checked
517 after the compilation. */
518 SLJIT_API_FUNC_ATTRIBUTE void sljit_set_compiler_memory_error(struct sljit_compiler *compiler);
521 Allocate a small amount of memory. The size must be <= 64 bytes on 32 bit,
522 and <= 128 bytes on 64 bit architectures. The memory area is owned by the
523 compiler, and freed by sljit_free_compiler. The returned pointer is
524 sizeof(sljit_sw) aligned. Excellent for allocating small blocks during
525 the compiling, and no need to worry about freeing them. The size is
526 enough to contain at most 16 pointers. If the size is outside of the range,
527 the function will return with NULL. However, this return value does not
528 indicate that there is no more memory (does not set the current error code
529 of the compiler to out-of-memory status).
531 SLJIT_API_FUNC_ATTRIBUTE void* sljit_alloc_memory(struct sljit_compiler *compiler, sljit_s32 size);
533 #if (defined SLJIT_VERBOSE && SLJIT_VERBOSE)
534 /* Passing NULL disables verbose. */
535 SLJIT_API_FUNC_ATTRIBUTE void sljit_compiler_verbose(struct sljit_compiler *compiler, FILE* verbose);
536 #endif
539 Create executable code from the sljit instruction stream. This is the final step
540 of the code generation so no more instructions can be added after this call.
543 SLJIT_API_FUNC_ATTRIBUTE void* sljit_generate_code(struct sljit_compiler *compiler);
545 /* Free executable code. */
547 SLJIT_API_FUNC_ATTRIBUTE void sljit_free_code(void* code, void *exec_allocator_data);
550 When the protected executable allocator is used the JIT code is mapped
551 twice. The first mapping has read/write and the second mapping has read/exec
552 permissions. This function returns with the relative offset of the executable
553 mapping using the writable mapping as the base after the machine code is
554 successfully generated. The returned value is always 0 for the normal executable
555 allocator, since it uses only one mapping with read/write/exec permissions.
556 Dynamic code modifications requires this value.
558 Before a successful code generation, this function returns with 0.
560 static SLJIT_INLINE sljit_sw sljit_get_executable_offset(struct sljit_compiler *compiler) { return compiler->executable_offset; }
563 The executable memory consumption of the generated code can be retrieved by
564 this function. The returned value can be used for statistical purposes.
566 Before a successful code generation, this function returns with 0.
568 static SLJIT_INLINE sljit_uw sljit_get_generated_code_size(struct sljit_compiler *compiler) { return compiler->executable_size; }
570 /* Returns with non-zero if the feature or limitation type passed as its
571 argument is present on the current CPU.
573 Some features (e.g. floating point operations) require hardware (CPU)
574 support while others (e.g. move with update) are emulated if not available.
575 However even if a feature is emulated, specialized code paths can be faster
576 than the emulation. Some limitations are emulated as well so their general
577 case is supported but it has extra performance costs. */
579 /* [Not emulated] Floating-point support is available. */
580 #define SLJIT_HAS_FPU 0
581 /* [Limitation] Some registers are virtual registers. */
582 #define SLJIT_HAS_VIRTUAL_REGISTERS 1
583 /* [Emulated] Has zero register (setting a memory location to zero is efficient). */
584 #define SLJIT_HAS_ZERO_REGISTER 2
585 /* [Emulated] Count leading zero is supported. */
586 #define SLJIT_HAS_CLZ 3
587 /* [Emulated] Conditional move is supported. */
588 #define SLJIT_HAS_CMOV 4
589 /* [Emulated] Conditional move is supported. */
590 #define SLJIT_HAS_PREFETCH 5
592 #if (defined SLJIT_CONFIG_X86 && SLJIT_CONFIG_X86)
593 /* [Not emulated] SSE2 support is available on x86. */
594 #define SLJIT_HAS_SSE2 100
595 #endif
597 SLJIT_API_FUNC_ATTRIBUTE sljit_s32 sljit_has_cpu_feature(sljit_s32 feature_type);
599 /* Instruction generation. Returns with any error code. If there is no
600 error, they return with SLJIT_SUCCESS. */
603 The executable code is a function from the viewpoint of the C
604 language. The function calls must obey to the ABI (Application
605 Binary Interface) of the platform, which specify the purpose of
606 machine registers and stack handling among other things. The
607 sljit_emit_enter function emits the necessary instructions for
608 setting up a new context for the executable code and moves function
609 arguments to the saved registers. Furthermore the options argument
610 can be used to pass configuration options to the compiler. The
611 available options are listed before sljit_emit_enter.
613 The function argument list is the combination of SLJIT_ARGx
614 (SLJIT_DEF_ARG1) macros. Currently maximum 4 arguments are
615 supported. The first integer argument is loaded into SLJIT_S0,
616 the second one is loaded into SLJIT_S1, and so on. Similarly,
617 the first floating point argument is loaded into SLJIT_FR0,
618 the second one is loaded into SLJIT_FR1, and so on. Furthermore
619 the register set used by the function must be declared as well.
620 The number of scratch and saved registers used by the function
621 must be passed to sljit_emit_enter. Only R registers between R0
622 and "scratches" argument can be used later. E.g. if "scratches"
623 is set to 2, the scratch register set will be limited to SLJIT_R0
624 and SLJIT_R1. The S registers and the floating point registers
625 ("fscratches" and "fsaveds") are specified in a similar manner.
626 The sljit_emit_enter is also capable of allocating a stack space
627 for local variables. The "local_size" argument contains the size
628 in bytes of this local area and its staring address is stored
629 in SLJIT_SP. The memory area between SLJIT_SP (inclusive) and
630 SLJIT_SP + local_size (exclusive) can be modified freely until
631 the function returns. The stack space is not initialized.
633 Note: the following conditions must met:
634 0 <= scratches <= SLJIT_NUMBER_OF_REGISTERS
635 0 <= saveds <= SLJIT_NUMBER_OF_SAVED_REGISTERS
636 scratches + saveds <= SLJIT_NUMBER_OF_REGISTERS
637 0 <= fscratches <= SLJIT_NUMBER_OF_FLOAT_REGISTERS
638 0 <= fsaveds <= SLJIT_NUMBER_OF_SAVED_FLOAT_REGISTERS
639 fscratches + fsaveds <= SLJIT_NUMBER_OF_FLOAT_REGISTERS
641 Note: the compiler can use saved registers as scratch registers,
642 but the opposite is not supported
644 Note: every call of sljit_emit_enter and sljit_set_context
645 overwrites the previous context.
648 /* The absolute address returned by sljit_get_local_base with
649 offset 0 is aligned to sljit_f64. Otherwise it is aligned to sljit_sw. */
650 #define SLJIT_F64_ALIGNMENT 0x00000001
652 /* The local_size must be >= 0 and <= SLJIT_MAX_LOCAL_SIZE. */
653 #define SLJIT_MAX_LOCAL_SIZE 65536
655 SLJIT_API_FUNC_ATTRIBUTE sljit_s32 sljit_emit_enter(struct sljit_compiler *compiler,
656 sljit_s32 options, sljit_s32 arg_types, sljit_s32 scratches, sljit_s32 saveds,
657 sljit_s32 fscratches, sljit_s32 fsaveds, sljit_s32 local_size);
659 /* The machine code has a context (which contains the local stack space size,
660 number of used registers, etc.) which initialized by sljit_emit_enter. Several
661 functions (such as sljit_emit_return) requres this context to be able to generate
662 the appropriate code. However, some code fragments (like inline cache) may have
663 no normal entry point so their context is unknown for the compiler. Their context
664 can be provided to the compiler by the sljit_set_context function.
666 Note: every call of sljit_emit_enter and sljit_set_context overwrites
667 the previous context. */
669 SLJIT_API_FUNC_ATTRIBUTE sljit_s32 sljit_set_context(struct sljit_compiler *compiler,
670 sljit_s32 options, sljit_s32 arg_types, sljit_s32 scratches, sljit_s32 saveds,
671 sljit_s32 fscratches, sljit_s32 fsaveds, sljit_s32 local_size);
673 /* Return from machine code. The sljit_emit_return_void function does not return with
674 any value. The sljit_emit_return function returns with a single value which stores
675 the result of a data move instruction. The instruction is specified by the op
676 argument, and must be between SLJIT_MOV and SLJIT_MOV_P (see sljit_emit_op1). */
678 SLJIT_API_FUNC_ATTRIBUTE sljit_s32 sljit_emit_return_void(struct sljit_compiler *compiler);
680 SLJIT_API_FUNC_ATTRIBUTE sljit_s32 sljit_emit_return(struct sljit_compiler *compiler, sljit_s32 op,
681 sljit_s32 src, sljit_sw srcw);
683 /* Generating entry and exit points for fast call functions (see SLJIT_FAST_CALL).
684 Both sljit_emit_fast_enter and SLJIT_FAST_RETURN operations preserve the
685 values of all registers and stack frame. The return address is stored in the
686 dst argument of sljit_emit_fast_enter, and this return address can be passed
687 to SLJIT_FAST_RETURN to continue the execution after the fast call.
689 Fast calls are cheap operations (usually only a single call instruction is
690 emitted) but they do not preserve any registers. However the callee function
691 can freely use / update any registers and stack values which can be
692 efficiently exploited by various optimizations. Registers can be saved
693 manually by the callee function if needed.
695 Although returning to different address by SLJIT_FAST_RETURN is possible,
696 this address usually cannot be predicted by the return address predictor of
697 modern CPUs which may reduce performance. Furthermore certain security
698 enhancement technologies such as Intel Control-flow Enforcement Technology
699 (CET) may disallow returning to a different address.
701 Flags: - (does not modify flags). */
703 SLJIT_API_FUNC_ATTRIBUTE sljit_s32 sljit_emit_fast_enter(struct sljit_compiler *compiler, sljit_s32 dst, sljit_sw dstw);
706 Source and destination operands for arithmetical instructions
707 imm - a simple immediate value (cannot be used as a destination)
708 reg - any of the registers (immediate argument must be 0)
709 [imm] - absolute immediate memory address
710 [reg+imm] - indirect memory address
711 [reg+(reg<<imm)] - indirect indexed memory address (shift must be between 0 and 3)
712 useful for (byte, half, int, sljit_sw) array access
713 (fully supported by both x86 and ARM architectures, and cheap operation on others)
717 IMPORTANT NOTE: memory access MUST be naturally aligned unless
718 SLJIT_UNALIGNED macro is defined and its value is 1.
720 length | alignment
721 ---------+-----------
722 byte | 1 byte (any physical_address is accepted)
723 half | 2 byte (physical_address & 0x1 == 0)
724 int | 4 byte (physical_address & 0x3 == 0)
725 word | 4 byte if SLJIT_32BIT_ARCHITECTURE is defined and its value is 1
726 | 8 byte if SLJIT_64BIT_ARCHITECTURE is defined and its value is 1
727 pointer | size of sljit_p type (4 byte on 32 bit machines, 4 or 8 byte
728 | on 64 bit machines)
730 Note: Different architectures have different addressing limitations.
731 A single instruction is enough for the following addressing
732 modes. Other adrressing modes are emulated by instruction
733 sequences. This information could help to improve those code
734 generators which focuses only a few architectures.
736 x86: [reg+imm], -2^32+1 <= imm <= 2^32-1 (full address space on x86-32)
737 [reg+(reg<<imm)] is supported
738 [imm], -2^32+1 <= imm <= 2^32-1 is supported
739 Write-back is not supported
740 arm: [reg+imm], -4095 <= imm <= 4095 or -255 <= imm <= 255 for signed
741 bytes, any halfs or floating point values)
742 [reg+(reg<<imm)] is supported
743 Write-back is supported
744 arm-t2: [reg+imm], -255 <= imm <= 4095
745 [reg+(reg<<imm)] is supported
746 Write back is supported only for [reg+imm], where -255 <= imm <= 255
747 arm64: [reg+imm], -256 <= imm <= 255, 0 <= aligned imm <= 4095 * alignment
748 [reg+(reg<<imm)] is supported
749 Write back is supported only for [reg+imm], where -256 <= imm <= 255
750 ppc: [reg+imm], -65536 <= imm <= 65535. 64 bit loads/stores and 32 bit
751 signed load on 64 bit requires immediates divisible by 4.
752 [reg+imm] is not supported for signed 8 bit values.
753 [reg+reg] is supported
754 Write-back is supported except for one instruction: 32 bit signed
755 load with [reg+imm] addressing mode on 64 bit.
756 mips: [reg+imm], -65536 <= imm <= 65535
757 sparc: [reg+imm], -4096 <= imm <= 4095
758 [reg+reg] is supported
759 s390x: [reg+imm], -2^19 <= imm < 2^19
760 [reg+reg] is supported
761 Write-back is not supported
764 /* Macros for specifying operand types. */
765 #define SLJIT_MEM 0x80
766 #define SLJIT_MEM0() (SLJIT_MEM)
767 #define SLJIT_MEM1(r1) (SLJIT_MEM | (r1))
768 #define SLJIT_MEM2(r1, r2) (SLJIT_MEM | (r1) | ((r2) << 8))
769 #define SLJIT_IMM 0x40
771 /* Sets 32 bit operation mode on 64 bit CPUs. This option is ignored on
772 32 bit CPUs. When this option is set for an arithmetic operation, only
773 the lower 32 bit of the input registers are used, and the CPU status
774 flags are set according to the 32 bit result. Although the higher 32 bit
775 of the input and the result registers are not defined by SLJIT, it might
776 be defined by the CPU architecture (e.g. MIPS). To satisfy these CPU
777 requirements all source registers must be the result of those operations
778 where this option was also set. Memory loads read 32 bit values rather
779 than 64 bit ones. In other words 32 bit and 64 bit operations cannot be
780 mixed. The only exception is SLJIT_MOV32 whose source register can hold
781 any 32 or 64 bit value, and it is converted to a 32 bit compatible format
782 first. This conversion is free (no instructions are emitted) on most CPUs.
783 A 32 bit value can also be converted to a 64 bit value by SLJIT_MOV_S32
784 (sign extension) or SLJIT_MOV_U32 (zero extension).
786 As for floating-point operations, this option sets 32 bit single
787 precision mode. Similar to the integer operations, all register arguments
788 must be the result of those operations where this option was also set.
790 Note: memory addressing always uses 64 bit values on 64 bit systems so
791 the result of a 32 bit operation must not be used with SLJIT_MEMx
792 macros.
794 This option is part of the instruction name, so there is no need to
795 manually set it. E.g:
797 SLJIT_ADD32 == (SLJIT_ADD | SLJIT_32) */
798 #define SLJIT_32 0x100
800 /* Many CPUs (x86, ARM, PPC) have status flags which can be set according
801 to the result of an operation. Other CPUs (MIPS) do not have status
802 flags, and results must be stored in registers. To cover both architecture
803 types efficiently only two flags are defined by SLJIT:
805 * Zero (equal) flag: it is set if the result is zero
806 * Variable flag: its value is defined by the last arithmetic operation
808 SLJIT instructions can set any or both of these flags. The value of
809 these flags is undefined if the instruction does not specify their value.
810 The description of each instruction contains the list of allowed flag
811 types.
813 Example: SLJIT_ADD can set the Z, OVERFLOW, CARRY flags hence
815 sljit_op2(..., SLJIT_ADD, ...)
816 Both the zero and variable flags are undefined so they can
817 have any value after the operation is completed.
819 sljit_op2(..., SLJIT_ADD | SLJIT_SET_Z, ...)
820 Sets the zero flag if the result is zero, clears it otherwise.
821 The variable flag is undefined.
823 sljit_op2(..., SLJIT_ADD | SLJIT_SET_OVERFLOW, ...)
824 Sets the variable flag if an integer overflow occurs, clears
825 it otherwise. The zero flag is undefined.
827 sljit_op2(..., SLJIT_ADD | SLJIT_SET_Z | SLJIT_SET_CARRY, ...)
828 Sets the zero flag if the result is zero, clears it otherwise.
829 Sets the variable flag if unsigned overflow (carry) occurs,
830 clears it otherwise.
832 If an instruction (e.g. SLJIT_MOV) does not modify flags the flags are
833 unchanged.
835 Using these flags can reduce the number of emitted instructions. E.g. a
836 fast loop can be implemented by decreasing a counter register and set the
837 zero flag to jump back if the counter register has not reached zero.
839 Motivation: although CPUs can set a large number of flags, usually their
840 values are ignored or only one of them is used. Emulating a large number
841 of flags on systems without flag register is complicated so SLJIT
842 instructions must specify the flag they want to use and only that flag
843 will be emulated. The last arithmetic instruction can be repeated if
844 multiple flags need to be checked.
847 /* Set Zero status flag. */
848 #define SLJIT_SET_Z 0x0200
849 /* Set the variable status flag if condition is true.
850 See comparison types. */
851 #define SLJIT_SET(condition) ((condition) << 10)
853 /* Notes:
854 - you cannot postpone conditional jump instructions except if noted that
855 the instruction does not set flags (See: SLJIT_KEEP_FLAGS).
856 - flag combinations: '|' means 'logical or'. */
858 /* Starting index of opcodes for sljit_emit_op0. */
859 #define SLJIT_OP0_BASE 0
861 /* Flags: - (does not modify flags)
862 Note: breakpoint instruction is not supported by all architectures (e.g. ppc)
863 It falls back to SLJIT_NOP in those cases. */
864 #define SLJIT_BREAKPOINT (SLJIT_OP0_BASE + 0)
865 /* Flags: - (does not modify flags)
866 Note: may or may not cause an extra cycle wait
867 it can even decrease the runtime in a few cases. */
868 #define SLJIT_NOP (SLJIT_OP0_BASE + 1)
869 /* Flags: - (may destroy flags)
870 Unsigned multiplication of SLJIT_R0 and SLJIT_R1.
871 Result is placed into SLJIT_R1:SLJIT_R0 (high:low) word */
872 #define SLJIT_LMUL_UW (SLJIT_OP0_BASE + 2)
873 /* Flags: - (may destroy flags)
874 Signed multiplication of SLJIT_R0 and SLJIT_R1.
875 Result is placed into SLJIT_R1:SLJIT_R0 (high:low) word */
876 #define SLJIT_LMUL_SW (SLJIT_OP0_BASE + 3)
877 /* Flags: - (may destroy flags)
878 Unsigned divide of the value in SLJIT_R0 by the value in SLJIT_R1.
879 The result is placed into SLJIT_R0 and the remainder into SLJIT_R1.
880 Note: if SLJIT_R1 is 0, the behaviour is undefined. */
881 #define SLJIT_DIVMOD_UW (SLJIT_OP0_BASE + 4)
882 #define SLJIT_DIVMOD_U32 (SLJIT_DIVMOD_UW | SLJIT_32)
883 /* Flags: - (may destroy flags)
884 Signed divide of the value in SLJIT_R0 by the value in SLJIT_R1.
885 The result is placed into SLJIT_R0 and the remainder into SLJIT_R1.
886 Note: if SLJIT_R1 is 0, the behaviour is undefined.
887 Note: if SLJIT_R1 is -1 and SLJIT_R0 is integer min (0x800..00),
888 the behaviour is undefined. */
889 #define SLJIT_DIVMOD_SW (SLJIT_OP0_BASE + 5)
890 #define SLJIT_DIVMOD_S32 (SLJIT_DIVMOD_SW | SLJIT_32)
891 /* Flags: - (may destroy flags)
892 Unsigned divide of the value in SLJIT_R0 by the value in SLJIT_R1.
893 The result is placed into SLJIT_R0. SLJIT_R1 preserves its value.
894 Note: if SLJIT_R1 is 0, the behaviour is undefined. */
895 #define SLJIT_DIV_UW (SLJIT_OP0_BASE + 6)
896 #define SLJIT_DIV_U32 (SLJIT_DIV_UW | SLJIT_32)
897 /* Flags: - (may destroy flags)
898 Signed divide of the value in SLJIT_R0 by the value in SLJIT_R1.
899 The result is placed into SLJIT_R0. SLJIT_R1 preserves its value.
900 Note: if SLJIT_R1 is 0, the behaviour is undefined.
901 Note: if SLJIT_R1 is -1 and SLJIT_R0 is integer min (0x800..00),
902 the behaviour is undefined. */
903 #define SLJIT_DIV_SW (SLJIT_OP0_BASE + 7)
904 #define SLJIT_DIV_S32 (SLJIT_DIV_SW | SLJIT_32)
905 /* Flags: - (does not modify flags)
906 ENDBR32 instruction for x86-32 and ENDBR64 instruction for x86-64
907 when Intel Control-flow Enforcement Technology (CET) is enabled.
908 No instruction for other architectures. */
909 #define SLJIT_ENDBR (SLJIT_OP0_BASE + 8)
910 /* Flags: - (may destroy flags)
911 Skip stack frames before return. */
912 #define SLJIT_SKIP_FRAMES_BEFORE_RETURN (SLJIT_OP0_BASE + 9)
914 SLJIT_API_FUNC_ATTRIBUTE sljit_s32 sljit_emit_op0(struct sljit_compiler *compiler, sljit_s32 op);
916 /* Starting index of opcodes for sljit_emit_op1. */
917 #define SLJIT_OP1_BASE 32
919 /* The MOV instruction transfers data from source to destination.
921 MOV instruction suffixes:
923 U8 - unsigned 8 bit data transfer
924 S8 - signed 8 bit data transfer
925 U16 - unsigned 16 bit data transfer
926 S16 - signed 16 bit data transfer
927 U32 - unsigned int (32 bit) data transfer
928 S32 - signed int (32 bit) data transfer
929 P - pointer (sljit_p) data transfer
932 /* Flags: - (does not modify flags) */
933 #define SLJIT_MOV (SLJIT_OP1_BASE + 0)
934 /* Flags: - (does not modify flags) */
935 #define SLJIT_MOV_U8 (SLJIT_OP1_BASE + 1)
936 #define SLJIT_MOV32_U8 (SLJIT_MOV_U8 | SLJIT_32)
937 /* Flags: - (does not modify flags) */
938 #define SLJIT_MOV_S8 (SLJIT_OP1_BASE + 2)
939 #define SLJIT_MOV32_S8 (SLJIT_MOV_S8 | SLJIT_32)
940 /* Flags: - (does not modify flags) */
941 #define SLJIT_MOV_U16 (SLJIT_OP1_BASE + 3)
942 #define SLJIT_MOV32_U16 (SLJIT_MOV_U16 | SLJIT_32)
943 /* Flags: - (does not modify flags) */
944 #define SLJIT_MOV_S16 (SLJIT_OP1_BASE + 4)
945 #define SLJIT_MOV32_S16 (SLJIT_MOV_S16 | SLJIT_32)
946 /* Flags: - (does not modify flags)
947 Note: no SLJIT_MOV32_U32 form, since it is the same as SLJIT_MOV32 */
948 #define SLJIT_MOV_U32 (SLJIT_OP1_BASE + 5)
949 /* Flags: - (does not modify flags)
950 Note: no SLJIT_MOV32_S32 form, since it is the same as SLJIT_MOV32 */
951 #define SLJIT_MOV_S32 (SLJIT_OP1_BASE + 6)
952 /* Flags: - (does not modify flags) */
953 #define SLJIT_MOV32 (SLJIT_OP1_BASE + 7)
954 /* Flags: - (does not modify flags)
955 Note: load a pointer sized data, useful on x32 (a 32 bit mode on x86-64
956 where all x64 features are available, e.g. 16 register) or similar
957 compiling modes */
958 #define SLJIT_MOV_P (SLJIT_OP1_BASE + 8)
959 /* Flags: Z
960 Note: immediate source argument is not supported */
961 #define SLJIT_NOT (SLJIT_OP1_BASE + 9)
962 #define SLJIT_NOT32 (SLJIT_NOT | SLJIT_32)
963 /* Flags: Z | OVERFLOW
964 Note: immediate source argument is not supported */
965 #define SLJIT_NEG (SLJIT_OP1_BASE + 10)
966 #define SLJIT_NEG32 (SLJIT_NEG | SLJIT_32)
967 /* Count leading zeroes
968 Flags: - (may destroy flags)
969 Note: immediate source argument is not supported */
970 #define SLJIT_CLZ (SLJIT_OP1_BASE + 11)
971 #define SLJIT_CLZ32 (SLJIT_CLZ | SLJIT_32)
973 SLJIT_API_FUNC_ATTRIBUTE sljit_s32 sljit_emit_op1(struct sljit_compiler *compiler, sljit_s32 op,
974 sljit_s32 dst, sljit_sw dstw,
975 sljit_s32 src, sljit_sw srcw);
977 /* Starting index of opcodes for sljit_emit_op2. */
978 #define SLJIT_OP2_BASE 96
980 /* Flags: Z | OVERFLOW | CARRY */
981 #define SLJIT_ADD (SLJIT_OP2_BASE + 0)
982 #define SLJIT_ADD32 (SLJIT_ADD | SLJIT_32)
983 /* Flags: CARRY */
984 #define SLJIT_ADDC (SLJIT_OP2_BASE + 1)
985 #define SLJIT_ADDC32 (SLJIT_ADDC | SLJIT_32)
986 /* Flags: Z | LESS | GREATER_EQUAL | GREATER | LESS_EQUAL
987 SIG_LESS | SIG_GREATER_EQUAL | SIG_GREATER
988 SIG_LESS_EQUAL | CARRY */
989 #define SLJIT_SUB (SLJIT_OP2_BASE + 2)
990 #define SLJIT_SUB32 (SLJIT_SUB | SLJIT_32)
991 /* Flags: CARRY */
992 #define SLJIT_SUBC (SLJIT_OP2_BASE + 3)
993 #define SLJIT_SUBC32 (SLJIT_SUBC | SLJIT_32)
994 /* Note: integer mul
995 Flags: OVERFLOW */
996 #define SLJIT_MUL (SLJIT_OP2_BASE + 4)
997 #define SLJIT_MUL32 (SLJIT_MUL | SLJIT_32)
998 /* Flags: Z */
999 #define SLJIT_AND (SLJIT_OP2_BASE + 5)
1000 #define SLJIT_AND32 (SLJIT_AND | SLJIT_32)
1001 /* Flags: Z */
1002 #define SLJIT_OR (SLJIT_OP2_BASE + 6)
1003 #define SLJIT_OR32 (SLJIT_OR | SLJIT_32)
1004 /* Flags: Z */
1005 #define SLJIT_XOR (SLJIT_OP2_BASE + 7)
1006 #define SLJIT_XOR32 (SLJIT_XOR | SLJIT_32)
1007 /* Flags: Z
1008 Let bit_length be the length of the shift operation: 32 or 64.
1009 If src2 is immediate, src2w is masked by (bit_length - 1).
1010 Otherwise, if the content of src2 is outside the range from 0
1011 to bit_length - 1, the result is undefined. */
1012 #define SLJIT_SHL (SLJIT_OP2_BASE + 8)
1013 #define SLJIT_SHL32 (SLJIT_SHL | SLJIT_32)
1014 /* Flags: Z
1015 Let bit_length be the length of the shift operation: 32 or 64.
1016 If src2 is immediate, src2w is masked by (bit_length - 1).
1017 Otherwise, if the content of src2 is outside the range from 0
1018 to bit_length - 1, the result is undefined. */
1019 #define SLJIT_LSHR (SLJIT_OP2_BASE + 9)
1020 #define SLJIT_LSHR32 (SLJIT_LSHR | SLJIT_32)
1021 /* Flags: Z
1022 Let bit_length be the length of the shift operation: 32 or 64.
1023 If src2 is immediate, src2w is masked by (bit_length - 1).
1024 Otherwise, if the content of src2 is outside the range from 0
1025 to bit_length - 1, the result is undefined. */
1026 #define SLJIT_ASHR (SLJIT_OP2_BASE + 10)
1027 #define SLJIT_ASHR32 (SLJIT_ASHR | SLJIT_32)
1029 SLJIT_API_FUNC_ATTRIBUTE sljit_s32 sljit_emit_op2(struct sljit_compiler *compiler, sljit_s32 op,
1030 sljit_s32 dst, sljit_sw dstw,
1031 sljit_s32 src1, sljit_sw src1w,
1032 sljit_s32 src2, sljit_sw src2w);
1034 /* The sljit_emit_op2u function is the same as sljit_emit_op2 except the result is discarded. */
1036 SLJIT_API_FUNC_ATTRIBUTE sljit_s32 sljit_emit_op2u(struct sljit_compiler *compiler, sljit_s32 op,
1037 sljit_s32 src1, sljit_sw src1w,
1038 sljit_s32 src2, sljit_sw src2w);
1040 /* Starting index of opcodes for sljit_emit_op2. */
1041 #define SLJIT_OP_SRC_BASE 128
1043 /* Note: src cannot be an immedate value
1044 Flags: - (does not modify flags) */
1045 #define SLJIT_FAST_RETURN (SLJIT_OP_SRC_BASE + 0)
1046 /* Skip stack frames before fast return.
1047 Note: src cannot be an immedate value
1048 Flags: may destroy flags. */
1049 #define SLJIT_SKIP_FRAMES_BEFORE_FAST_RETURN (SLJIT_OP_SRC_BASE + 1)
1050 /* Prefetch value into the level 1 data cache
1051 Note: if the target CPU does not support data prefetch,
1052 no instructions are emitted.
1053 Note: this instruction never fails, even if the memory address is invalid.
1054 Flags: - (does not modify flags) */
1055 #define SLJIT_PREFETCH_L1 (SLJIT_OP_SRC_BASE + 2)
1056 /* Prefetch value into the level 2 data cache
1057 Note: same as SLJIT_PREFETCH_L1 if the target CPU
1058 does not support this instruction form.
1059 Note: this instruction never fails, even if the memory address is invalid.
1060 Flags: - (does not modify flags) */
1061 #define SLJIT_PREFETCH_L2 (SLJIT_OP_SRC_BASE + 3)
1062 /* Prefetch value into the level 3 data cache
1063 Note: same as SLJIT_PREFETCH_L2 if the target CPU
1064 does not support this instruction form.
1065 Note: this instruction never fails, even if the memory address is invalid.
1066 Flags: - (does not modify flags) */
1067 #define SLJIT_PREFETCH_L3 (SLJIT_OP_SRC_BASE + 4)
1068 /* Prefetch a value which is only used once (and can be discarded afterwards)
1069 Note: same as SLJIT_PREFETCH_L1 if the target CPU
1070 does not support this instruction form.
1071 Note: this instruction never fails, even if the memory address is invalid.
1072 Flags: - (does not modify flags) */
1073 #define SLJIT_PREFETCH_ONCE (SLJIT_OP_SRC_BASE + 5)
1075 SLJIT_API_FUNC_ATTRIBUTE sljit_s32 sljit_emit_op_src(struct sljit_compiler *compiler, sljit_s32 op,
1076 sljit_s32 src, sljit_sw srcw);
1078 /* Starting index of opcodes for sljit_emit_fop1. */
1079 #define SLJIT_FOP1_BASE 160
1081 /* Flags: - (does not modify flags) */
1082 #define SLJIT_MOV_F64 (SLJIT_FOP1_BASE + 0)
1083 #define SLJIT_MOV_F32 (SLJIT_MOV_F64 | SLJIT_32)
1084 /* Convert opcodes: CONV[DST_TYPE].FROM[SRC_TYPE]
1085 SRC/DST TYPE can be: D - double, S - single, W - signed word, I - signed int
1086 Rounding mode when the destination is W or I: round towards zero. */
1087 /* Flags: - (does not modify flags) */
1088 #define SLJIT_CONV_F64_FROM_F32 (SLJIT_FOP1_BASE + 1)
1089 #define SLJIT_CONV_F32_FROM_F64 (SLJIT_CONV_F64_FROM_F32 | SLJIT_32)
1090 /* Flags: - (does not modify flags) */
1091 #define SLJIT_CONV_SW_FROM_F64 (SLJIT_FOP1_BASE + 2)
1092 #define SLJIT_CONV_SW_FROM_F32 (SLJIT_CONV_SW_FROM_F64 | SLJIT_32)
1093 /* Flags: - (does not modify flags) */
1094 #define SLJIT_CONV_S32_FROM_F64 (SLJIT_FOP1_BASE + 3)
1095 #define SLJIT_CONV_S32_FROM_F32 (SLJIT_CONV_S32_FROM_F64 | SLJIT_32)
1096 /* Flags: - (does not modify flags) */
1097 #define SLJIT_CONV_F64_FROM_SW (SLJIT_FOP1_BASE + 4)
1098 #define SLJIT_CONV_F32_FROM_SW (SLJIT_CONV_F64_FROM_SW | SLJIT_32)
1099 /* Flags: - (does not modify flags) */
1100 #define SLJIT_CONV_F64_FROM_S32 (SLJIT_FOP1_BASE + 5)
1101 #define SLJIT_CONV_F32_FROM_S32 (SLJIT_CONV_F64_FROM_S32 | SLJIT_32)
1102 /* Note: dst is the left and src is the right operand for SLJIT_CMPD.
1103 Flags: EQUAL_F | LESS_F | GREATER_EQUAL_F | GREATER_F | LESS_EQUAL_F */
1104 #define SLJIT_CMP_F64 (SLJIT_FOP1_BASE + 6)
1105 #define SLJIT_CMP_F32 (SLJIT_CMP_F64 | SLJIT_32)
1106 /* Flags: - (does not modify flags) */
1107 #define SLJIT_NEG_F64 (SLJIT_FOP1_BASE + 7)
1108 #define SLJIT_NEG_F32 (SLJIT_NEG_F64 | SLJIT_32)
1109 /* Flags: - (does not modify flags) */
1110 #define SLJIT_ABS_F64 (SLJIT_FOP1_BASE + 8)
1111 #define SLJIT_ABS_F32 (SLJIT_ABS_F64 | SLJIT_32)
1113 SLJIT_API_FUNC_ATTRIBUTE sljit_s32 sljit_emit_fop1(struct sljit_compiler *compiler, sljit_s32 op,
1114 sljit_s32 dst, sljit_sw dstw,
1115 sljit_s32 src, sljit_sw srcw);
1117 /* Starting index of opcodes for sljit_emit_fop2. */
1118 #define SLJIT_FOP2_BASE 192
1120 /* Flags: - (does not modify flags) */
1121 #define SLJIT_ADD_F64 (SLJIT_FOP2_BASE + 0)
1122 #define SLJIT_ADD_F32 (SLJIT_ADD_F64 | SLJIT_32)
1123 /* Flags: - (does not modify flags) */
1124 #define SLJIT_SUB_F64 (SLJIT_FOP2_BASE + 1)
1125 #define SLJIT_SUB_F32 (SLJIT_SUB_F64 | SLJIT_32)
1126 /* Flags: - (does not modify flags) */
1127 #define SLJIT_MUL_F64 (SLJIT_FOP2_BASE + 2)
1128 #define SLJIT_MUL_F32 (SLJIT_MUL_F64 | SLJIT_32)
1129 /* Flags: - (does not modify flags) */
1130 #define SLJIT_DIV_F64 (SLJIT_FOP2_BASE + 3)
1131 #define SLJIT_DIV_F32 (SLJIT_DIV_F64 | SLJIT_32)
1133 SLJIT_API_FUNC_ATTRIBUTE sljit_s32 sljit_emit_fop2(struct sljit_compiler *compiler, sljit_s32 op,
1134 sljit_s32 dst, sljit_sw dstw,
1135 sljit_s32 src1, sljit_sw src1w,
1136 sljit_s32 src2, sljit_sw src2w);
1138 /* Label and jump instructions. */
1140 SLJIT_API_FUNC_ATTRIBUTE struct sljit_label* sljit_emit_label(struct sljit_compiler *compiler);
1142 /* Invert (negate) conditional type: xor (^) with 0x1 */
1144 /* Integer comparison types. */
1145 #define SLJIT_EQUAL 0
1146 #define SLJIT_ZERO SLJIT_EQUAL
1147 #define SLJIT_NOT_EQUAL 1
1148 #define SLJIT_NOT_ZERO SLJIT_NOT_EQUAL
1150 #define SLJIT_LESS 2
1151 #define SLJIT_SET_LESS SLJIT_SET(SLJIT_LESS)
1152 #define SLJIT_GREATER_EQUAL 3
1153 #define SLJIT_SET_GREATER_EQUAL SLJIT_SET(SLJIT_GREATER_EQUAL)
1154 #define SLJIT_GREATER 4
1155 #define SLJIT_SET_GREATER SLJIT_SET(SLJIT_GREATER)
1156 #define SLJIT_LESS_EQUAL 5
1157 #define SLJIT_SET_LESS_EQUAL SLJIT_SET(SLJIT_LESS_EQUAL)
1158 #define SLJIT_SIG_LESS 6
1159 #define SLJIT_SET_SIG_LESS SLJIT_SET(SLJIT_SIG_LESS)
1160 #define SLJIT_SIG_GREATER_EQUAL 7
1161 #define SLJIT_SET_SIG_GREATER_EQUAL SLJIT_SET(SLJIT_SIG_GREATER_EQUAL)
1162 #define SLJIT_SIG_GREATER 8
1163 #define SLJIT_SET_SIG_GREATER SLJIT_SET(SLJIT_SIG_GREATER)
1164 #define SLJIT_SIG_LESS_EQUAL 9
1165 #define SLJIT_SET_SIG_LESS_EQUAL SLJIT_SET(SLJIT_SIG_LESS_EQUAL)
1167 #define SLJIT_OVERFLOW 10
1168 #define SLJIT_SET_OVERFLOW SLJIT_SET(SLJIT_OVERFLOW)
1169 #define SLJIT_NOT_OVERFLOW 11
1171 /* There is no SLJIT_CARRY or SLJIT_NOT_CARRY. */
1172 #define SLJIT_SET_CARRY SLJIT_SET(12)
1174 /* Floating point comparison types. */
1175 #define SLJIT_EQUAL_F64 14
1176 #define SLJIT_EQUAL_F32 (SLJIT_EQUAL_F64 | SLJIT_32)
1177 #define SLJIT_SET_EQUAL_F SLJIT_SET(SLJIT_EQUAL_F64)
1178 #define SLJIT_NOT_EQUAL_F64 15
1179 #define SLJIT_NOT_EQUAL_F32 (SLJIT_NOT_EQUAL_F64 | SLJIT_32)
1180 #define SLJIT_SET_NOT_EQUAL_F SLJIT_SET(SLJIT_NOT_EQUAL_F64)
1181 #define SLJIT_LESS_F64 16
1182 #define SLJIT_LESS_F32 (SLJIT_LESS_F64 | SLJIT_32)
1183 #define SLJIT_SET_LESS_F SLJIT_SET(SLJIT_LESS_F64)
1184 #define SLJIT_GREATER_EQUAL_F64 17
1185 #define SLJIT_GREATER_EQUAL_F32 (SLJIT_GREATER_EQUAL_F64 | SLJIT_32)
1186 #define SLJIT_SET_GREATER_EQUAL_F SLJIT_SET(SLJIT_GREATER_EQUAL_F64)
1187 #define SLJIT_GREATER_F64 18
1188 #define SLJIT_GREATER_F32 (SLJIT_GREATER_F64 | SLJIT_32)
1189 #define SLJIT_SET_GREATER_F SLJIT_SET(SLJIT_GREATER_F64)
1190 #define SLJIT_LESS_EQUAL_F64 19
1191 #define SLJIT_LESS_EQUAL_F32 (SLJIT_LESS_EQUAL_F64 | SLJIT_32)
1192 #define SLJIT_SET_LESS_EQUAL_F SLJIT_SET(SLJIT_LESS_EQUAL_F64)
1193 #define SLJIT_UNORDERED_F64 20
1194 #define SLJIT_UNORDERED_F32 (SLJIT_UNORDERED_F64 | SLJIT_32)
1195 #define SLJIT_SET_UNORDERED_F SLJIT_SET(SLJIT_UNORDERED_F64)
1196 #define SLJIT_ORDERED_F64 21
1197 #define SLJIT_ORDERED_F32 (SLJIT_ORDERED_F64 | SLJIT_32)
1198 #define SLJIT_SET_ORDERED_F SLJIT_SET(SLJIT_ORDERED_F64)
1200 /* Unconditional jump types. */
1201 #define SLJIT_JUMP 22
1202 /* Fast calling method. See sljit_emit_fast_enter / SLJIT_FAST_RETURN. */
1203 #define SLJIT_FAST_CALL 23
1204 /* Called function must be declared with the SLJIT_FUNC attribute. */
1205 #define SLJIT_CALL 24
1206 /* Called function must be declared with cdecl attribute.
1207 This is the default attribute for C functions. */
1208 #define SLJIT_CALL_CDECL 25
1210 /* The target can be changed during runtime (see: sljit_set_jump_addr). */
1211 #define SLJIT_REWRITABLE_JUMP 0x1000
1213 /* Emit a jump instruction. The destination is not set, only the type of the jump.
1214 type must be between SLJIT_EQUAL and SLJIT_FAST_CALL
1215 type can be combined (or'ed) with SLJIT_REWRITABLE_JUMP
1217 Flags: does not modify flags. */
1218 SLJIT_API_FUNC_ATTRIBUTE struct sljit_jump* sljit_emit_jump(struct sljit_compiler *compiler, sljit_s32 type);
1220 /* Emit a C compiler (ABI) compatible function call.
1221 type must be SLJIT_CALL or SLJIT_CALL_CDECL
1222 type can be combined (or'ed) with SLJIT_REWRITABLE_JUMP
1223 arg_types is the combination of SLJIT_RET / SLJIT_ARGx (SLJIT_DEF_RET / SLJIT_DEF_ARGx) macros
1225 Flags: destroy all flags. */
1226 SLJIT_API_FUNC_ATTRIBUTE struct sljit_jump* sljit_emit_call(struct sljit_compiler *compiler, sljit_s32 type, sljit_s32 arg_types);
1228 /* Basic arithmetic comparison. In most architectures it is implemented as
1229 an compare operation followed by a sljit_emit_jump. However some
1230 architectures (i.e: ARM64 or MIPS) may employ special optimizations here.
1231 It is suggested to use this comparison form when appropriate.
1232 type must be between SLJIT_EQUAL and SLJIT_I_SIG_LESS_EQUAL
1233 type can be combined (or'ed) with SLJIT_REWRITABLE_JUMP
1235 Flags: may destroy flags. */
1236 SLJIT_API_FUNC_ATTRIBUTE struct sljit_jump* sljit_emit_cmp(struct sljit_compiler *compiler, sljit_s32 type,
1237 sljit_s32 src1, sljit_sw src1w,
1238 sljit_s32 src2, sljit_sw src2w);
1240 /* Basic floating point comparison. In most architectures it is implemented as
1241 an SLJIT_FCMP operation (setting appropriate flags) followed by a
1242 sljit_emit_jump. However some architectures (i.e: MIPS) may employ
1243 special optimizations here. It is suggested to use this comparison form
1244 when appropriate.
1245 type must be between SLJIT_EQUAL_F64 and SLJIT_ORDERED_F32
1246 type can be combined (or'ed) with SLJIT_REWRITABLE_JUMP
1247 Flags: destroy flags.
1248 Note: if either operand is NaN, the behaviour is undefined for
1249 types up to SLJIT_S_LESS_EQUAL. */
1250 SLJIT_API_FUNC_ATTRIBUTE struct sljit_jump* sljit_emit_fcmp(struct sljit_compiler *compiler, sljit_s32 type,
1251 sljit_s32 src1, sljit_sw src1w,
1252 sljit_s32 src2, sljit_sw src2w);
1254 /* Set the destination of the jump to this label. */
1255 SLJIT_API_FUNC_ATTRIBUTE void sljit_set_label(struct sljit_jump *jump, struct sljit_label* label);
1256 /* Set the destination address of the jump to this label. */
1257 SLJIT_API_FUNC_ATTRIBUTE void sljit_set_target(struct sljit_jump *jump, sljit_uw target);
1259 /* Emit an indirect jump or fast call.
1260 Direct form: set src to SLJIT_IMM() and srcw to the address
1261 Indirect form: any other valid addressing mode
1262 type must be between SLJIT_JUMP and SLJIT_FAST_CALL
1264 Flags: does not modify flags. */
1265 SLJIT_API_FUNC_ATTRIBUTE sljit_s32 sljit_emit_ijump(struct sljit_compiler *compiler, sljit_s32 type, sljit_s32 src, sljit_sw srcw);
1267 /* Emit a C compiler (ABI) compatible function call.
1268 Direct form: set src to SLJIT_IMM() and srcw to the address
1269 Indirect form: any other valid addressing mode
1270 type must be SLJIT_CALL or SLJIT_CALL_CDECL
1271 arg_types is the combination of SLJIT_RET / SLJIT_ARGx (SLJIT_DEF_RET / SLJIT_DEF_ARGx) macros
1273 Flags: destroy all flags. */
1274 SLJIT_API_FUNC_ATTRIBUTE sljit_s32 sljit_emit_icall(struct sljit_compiler *compiler, sljit_s32 type, sljit_s32 arg_types, sljit_s32 src, sljit_sw srcw);
1276 /* Perform the operation using the conditional flags as the second argument.
1277 Type must always be between SLJIT_EQUAL and SLJIT_ORDERED_F64. The value
1278 represented by the type is 1, if the condition represented by the type
1279 is fulfilled, and 0 otherwise.
1281 If op == SLJIT_MOV, SLJIT_MOV32:
1282 Set dst to the value represented by the type (0 or 1).
1283 Flags: - (does not modify flags)
1284 If op == SLJIT_OR, op == SLJIT_AND, op == SLJIT_XOR
1285 Performs the binary operation using dst as the first, and the value
1286 represented by type as the second argument. Result is written into dst.
1287 Flags: Z (may destroy flags) */
1288 SLJIT_API_FUNC_ATTRIBUTE sljit_s32 sljit_emit_op_flags(struct sljit_compiler *compiler, sljit_s32 op,
1289 sljit_s32 dst, sljit_sw dstw,
1290 sljit_s32 type);
1292 /* Emit a conditional mov instruction which moves source to destination,
1293 if the condition is satisfied. Unlike other arithmetic operations this
1294 instruction does not support memory access.
1296 type must be between SLJIT_EQUAL and SLJIT_ORDERED_F64
1297 dst_reg must be a valid register and it can be combined
1298 with SLJIT_32 to perform a 32 bit arithmetic operation
1299 src must be register or immediate (SLJIT_IMM)
1301 Flags: - (does not modify flags) */
1302 SLJIT_API_FUNC_ATTRIBUTE sljit_s32 sljit_emit_cmov(struct sljit_compiler *compiler, sljit_s32 type,
1303 sljit_s32 dst_reg,
1304 sljit_s32 src, sljit_sw srcw);
1306 /* The following flags are used by sljit_emit_mem() and sljit_emit_fmem(). */
1308 /* When SLJIT_MEM_SUPP is passed, no instructions are emitted.
1309 Instead the function returns with SLJIT_SUCCESS if the instruction
1310 form is supported and SLJIT_ERR_UNSUPPORTED otherwise. This flag
1311 allows runtime checking of available instruction forms. */
1312 #define SLJIT_MEM_SUPP 0x0200
1313 /* Memory load operation. This is the default. */
1314 #define SLJIT_MEM_LOAD 0x0000
1315 /* Memory store operation. */
1316 #define SLJIT_MEM_STORE 0x0400
1317 /* Base register is updated before the memory access. */
1318 #define SLJIT_MEM_PRE 0x0800
1319 /* Base register is updated after the memory access. */
1320 #define SLJIT_MEM_POST 0x1000
1322 /* Emit a single memory load or store with update instruction. When the
1323 requested instruction form is not supported by the CPU, it returns
1324 with SLJIT_ERR_UNSUPPORTED instead of emulating the instruction. This
1325 allows specializing tight loops based on the supported instruction
1326 forms (see SLJIT_MEM_SUPP flag).
1328 type must be between SLJIT_MOV and SLJIT_MOV_P and can be
1329 combined with SLJIT_MEM_* flags. Either SLJIT_MEM_PRE
1330 or SLJIT_MEM_POST must be specified.
1331 reg is the source or destination register, and must be
1332 different from the base register of the mem operand
1333 mem must be a SLJIT_MEM1() or SLJIT_MEM2() operand
1335 Flags: - (does not modify flags) */
1336 SLJIT_API_FUNC_ATTRIBUTE sljit_s32 sljit_emit_mem(struct sljit_compiler *compiler, sljit_s32 type,
1337 sljit_s32 reg,
1338 sljit_s32 mem, sljit_sw memw);
1340 /* Same as sljit_emit_mem except the followings:
1342 type must be SLJIT_MOV_F64 or SLJIT_MOV_F32 and can be
1343 combined with SLJIT_MEM_* flags. Either SLJIT_MEM_PRE
1344 or SLJIT_MEM_POST must be specified.
1345 freg is the source or destination floating point register */
1347 SLJIT_API_FUNC_ATTRIBUTE sljit_s32 sljit_emit_fmem(struct sljit_compiler *compiler, sljit_s32 type,
1348 sljit_s32 freg,
1349 sljit_s32 mem, sljit_sw memw);
1351 /* Copies the base address of SLJIT_SP + offset to dst. The offset can be
1352 anything to negate the effect of relative addressing. For example if an
1353 array of sljit_sw values is stored on the stack from offset 0x40, and R0
1354 contains the offset of an array item plus 0x120, this item can be
1355 overwritten by two SLJIT instructions:
1357 sljit_get_local_base(compiler, SLJIT_R1, 0, 0x40 - 0x120);
1358 sljit_emit_op1(compiler, SLJIT_MOV, SLJIT_MEM2(SLJIT_R1, SLJIT_R0), 0, SLJIT_IMM, 0x5);
1360 Flags: - (may destroy flags) */
1361 SLJIT_API_FUNC_ATTRIBUTE sljit_s32 sljit_get_local_base(struct sljit_compiler *compiler, sljit_s32 dst, sljit_sw dstw, sljit_sw offset);
1363 /* Store a value that can be changed runtime (see: sljit_get_const_addr / sljit_set_const)
1364 Flags: - (does not modify flags) */
1365 SLJIT_API_FUNC_ATTRIBUTE struct sljit_const* sljit_emit_const(struct sljit_compiler *compiler, sljit_s32 dst, sljit_sw dstw, sljit_sw init_value);
1367 /* Store the value of a label (see: sljit_set_put_label)
1368 Flags: - (does not modify flags) */
1369 SLJIT_API_FUNC_ATTRIBUTE struct sljit_put_label* sljit_emit_put_label(struct sljit_compiler *compiler, sljit_s32 dst, sljit_sw dstw);
1371 /* Set the value stored by put_label to this label. */
1372 SLJIT_API_FUNC_ATTRIBUTE void sljit_set_put_label(struct sljit_put_label *put_label, struct sljit_label *label);
1374 /* After the code generation the address for label, jump and const instructions
1375 are computed. Since these structures are freed by sljit_free_compiler, the
1376 addresses must be preserved by the user program elsewere. */
1377 static SLJIT_INLINE sljit_uw sljit_get_label_addr(struct sljit_label *label) { return label->addr; }
1378 static SLJIT_INLINE sljit_uw sljit_get_jump_addr(struct sljit_jump *jump) { return jump->addr; }
1379 static SLJIT_INLINE sljit_uw sljit_get_const_addr(struct sljit_const *const_) { return const_->addr; }
1381 /* Only the address and executable offset are required to perform dynamic
1382 code modifications. See sljit_get_executable_offset function. */
1383 SLJIT_API_FUNC_ATTRIBUTE void sljit_set_jump_addr(sljit_uw addr, sljit_uw new_target, sljit_sw executable_offset);
1384 SLJIT_API_FUNC_ATTRIBUTE void sljit_set_const(sljit_uw addr, sljit_sw new_constant, sljit_sw executable_offset);
1386 /* --------------------------------------------------------------------- */
1387 /* Miscellaneous utility functions */
1388 /* --------------------------------------------------------------------- */
1390 #define SLJIT_MAJOR_VERSION 0
1391 #define SLJIT_MINOR_VERSION 94
1393 /* Get the human readable name of the platform. Can be useful on platforms
1394 like ARM, where ARM and Thumb2 functions can be mixed, and
1395 it is useful to know the type of the code generator. */
1396 SLJIT_API_FUNC_ATTRIBUTE const char* sljit_get_platform_name(void);
1398 /* Portable helper function to get an offset of a member. */
1399 #define SLJIT_OFFSETOF(base, member) ((sljit_sw)(&((base*)0x10)->member) - 0x10)
1401 #if (defined SLJIT_UTIL_STACK && SLJIT_UTIL_STACK)
1403 /* The sljit_stack structure and its manipulation functions provides
1404 an implementation for a top-down stack. The stack top is stored
1405 in the end field of the sljit_stack structure and the stack goes
1406 down to the min_start field, so the memory region reserved for
1407 this stack is between min_start (inclusive) and end (exclusive)
1408 fields. However the application can only use the region between
1409 start (inclusive) and end (exclusive) fields. The sljit_stack_resize
1410 function can be used to extend this region up to min_start.
1412 This feature uses the "address space reserve" feature of modern
1413 operating systems. Instead of allocating a large memory block
1414 applications can allocate a small memory region and extend it
1415 later without moving the content of the memory area. Therefore
1416 after a successful resize by sljit_stack_resize all pointers into
1417 this region are still valid.
1419 Note:
1420 this structure may not be supported by all operating systems.
1421 end and max_limit fields are aligned to PAGE_SIZE bytes (usually
1422 4 Kbyte or more).
1423 stack should grow in larger steps, e.g. 4Kbyte, 16Kbyte or more. */
1425 struct sljit_stack {
1426 /* User data, anything can be stored here.
1427 Initialized to the same value as the end field. */
1428 sljit_u8 *top;
1429 /* These members are read only. */
1430 /* End address of the stack */
1431 sljit_u8 *end;
1432 /* Current start address of the stack. */
1433 sljit_u8 *start;
1434 /* Lowest start address of the stack. */
1435 sljit_u8 *min_start;
1438 /* Allocates a new stack. Returns NULL if unsuccessful.
1439 Note: see sljit_create_compiler for the explanation of allocator_data. */
1440 SLJIT_API_FUNC_ATTRIBUTE struct sljit_stack* SLJIT_FUNC sljit_allocate_stack(sljit_uw start_size, sljit_uw max_size, void *allocator_data);
1441 SLJIT_API_FUNC_ATTRIBUTE void SLJIT_FUNC sljit_free_stack(struct sljit_stack *stack, void *allocator_data);
1443 /* Can be used to increase (extend) or decrease (shrink) the stack
1444 memory area. Returns with new_start if successful and NULL otherwise.
1445 It always fails if new_start is less than min_start or greater or equal
1446 than end fields. The fields of the stack are not changed if the returned
1447 value is NULL (the current memory content is never lost). */
1448 SLJIT_API_FUNC_ATTRIBUTE sljit_u8 *SLJIT_FUNC sljit_stack_resize(struct sljit_stack *stack, sljit_u8 *new_start);
1450 #endif /* (defined SLJIT_UTIL_STACK && SLJIT_UTIL_STACK) */
1452 #if !(defined SLJIT_INDIRECT_CALL && SLJIT_INDIRECT_CALL)
1454 /* Get the entry address of a given function. */
1455 #define SLJIT_FUNC_OFFSET(func_name) ((sljit_sw)func_name)
1457 #else /* !(defined SLJIT_INDIRECT_CALL && SLJIT_INDIRECT_CALL) */
1459 /* All JIT related code should be placed in the same context (library, binary, etc.). */
1461 #define SLJIT_FUNC_OFFSET(func_name) (*(sljit_sw*)(void*)func_name)
1463 /* For powerpc64, the function pointers point to a context descriptor. */
1464 struct sljit_function_context {
1465 sljit_sw addr;
1466 sljit_sw r2;
1467 sljit_sw r11;
1470 /* Fill the context arguments using the addr and the function.
1471 If func_ptr is NULL, it will not be set to the address of context
1472 If addr is NULL, the function address also comes from the func pointer. */
1473 SLJIT_API_FUNC_ATTRIBUTE void sljit_set_function_context(void** func_ptr, struct sljit_function_context* context, sljit_sw addr, void* func);
1475 #endif /* !(defined SLJIT_INDIRECT_CALL && SLJIT_INDIRECT_CALL) */
1477 #if (defined SLJIT_EXECUTABLE_ALLOCATOR && SLJIT_EXECUTABLE_ALLOCATOR)
1478 /* Free unused executable memory. The allocator keeps some free memory
1479 around to reduce the number of OS executable memory allocations.
1480 This improves performance since these calls are costly. However
1481 it is sometimes desired to free all unused memory regions, e.g.
1482 before the application terminates. */
1483 SLJIT_API_FUNC_ATTRIBUTE void sljit_free_unused_memory_exec(void);
1484 #endif
1486 /* --------------------------------------------------------------------- */
1487 /* CPU specific functions */
1488 /* --------------------------------------------------------------------- */
1490 /* The following function is a helper function for sljit_emit_op_custom.
1491 It returns with the real machine register index ( >=0 ) of any SLJIT_R,
1492 SLJIT_S and SLJIT_SP registers.
1494 Note: it returns with -1 for virtual registers (only on x86-32). */
1496 SLJIT_API_FUNC_ATTRIBUTE sljit_s32 sljit_get_register_index(sljit_s32 reg);
1498 /* The following function is a helper function for sljit_emit_op_custom.
1499 It returns with the real machine register index of any SLJIT_FLOAT register.
1501 Note: the index is always an even number on ARM (except ARM-64), MIPS, and SPARC. */
1503 SLJIT_API_FUNC_ATTRIBUTE sljit_s32 sljit_get_float_register_index(sljit_s32 reg);
1505 /* Any instruction can be inserted into the instruction stream by
1506 sljit_emit_op_custom. It has a similar purpose as inline assembly.
1507 The size parameter must match to the instruction size of the target
1508 architecture:
1510 x86: 0 < size <= 15. The instruction argument can be byte aligned.
1511 Thumb2: if size == 2, the instruction argument must be 2 byte aligned.
1512 if size == 4, the instruction argument must be 4 byte aligned.
1513 Otherwise: size must be 4 and instruction argument must be 4 byte aligned. */
1515 SLJIT_API_FUNC_ATTRIBUTE sljit_s32 sljit_emit_op_custom(struct sljit_compiler *compiler,
1516 void *instruction, sljit_s32 size);
1518 /* Flags were set by a 32 bit operation. */
1519 #define SLJIT_CURRENT_FLAGS_32 SLJIT_32
1521 /* Flags were set by an ADD, ADDC, SUB, SUBC, or NEG operation. */
1522 #define SLJIT_CURRENT_FLAGS_ADD_SUB 0x01
1524 /* Flags were set by sljit_emit_op2u with SLJIT_SUB opcode.
1525 Must be combined with SLJIT_CURRENT_FLAGS_ADD_SUB. */
1526 #define SLJIT_CURRENT_FLAGS_COMPARE 0x02
1528 /* Define the currently available CPU status flags. It is usually used after
1529 an sljit_emit_label or sljit_emit_op_custom operations to define which CPU
1530 status flags are available.
1532 The current_flags must be a valid combination of SLJIT_SET_* and
1533 SLJIT_CURRENT_FLAGS_* constants. */
1535 SLJIT_API_FUNC_ATTRIBUTE void sljit_set_current_flags(struct sljit_compiler *compiler,
1536 sljit_s32 current_flags);
1538 #ifdef __cplusplus
1539 } /* extern "C" */
1540 #endif
1542 #endif /* SLJIT_LIR_H_ */