/[pcre]/code/trunk/sljit/sljitLir.h
ViewVC logotype

Contents of /code/trunk/sljit/sljitLir.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1493 - (hide annotations) (download)
Wed Jul 9 04:41:15 2014 UTC (3 weeks, 3 days ago) by zherczeg
File MIME type: text/plain
File size: 49190 byte(s)
Minor JIT compiler update.
1 ph10 662 /*
2     * Stack-less Just-In-Time compiler
3     *
4 ph10 836 * Copyright 2009-2012 Zoltan Herczeg (hzmester@freemail.hu). All rights reserved.
5 ph10 662 *
6     * Redistribution and use in source and binary forms, with or without modification, are
7     * permitted provided that the following conditions are met:
8     *
9     * 1. Redistributions of source code must retain the above copyright notice, this list of
10     * conditions and the following disclaimer.
11     *
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.
15     *
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.
25     */
26    
27     #ifndef _SLJIT_LIR_H_
28     #define _SLJIT_LIR_H_
29    
30     /*
31     ------------------------------------------------------------------------
32     Stack-Less JIT compiler for multiple architectures (x86, ARM, PowerPC)
33     ------------------------------------------------------------------------
34    
35     Short description
36     Advantages:
37 zherczeg 1216 - 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 ph10 662 - although it is not suggested to do it frequently
45 zherczeg 1216 - 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 ph10 662 - A fixed stack space can be allocated for local variables
51     - The compiler is thread-safe
52 zherczeg 951 - 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 ph10 662 Disadvantages:
57 zherczeg 1216 - No automatic register allocation, and temporary results are
58     not stored on the stack. (hence the name comes)
59 ph10 662 In practice:
60     - This approach is very effective for interpreters
61 zherczeg 880 - One of the saved registers typically points to a stack interface
62 zherczeg 1216 - 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 ph10 662 of the fastest execution path of the dynamic language
66     - SLJIT supports complex memory addressing modes
67 zherczeg 1216 - mainly position and context independent code (except some cases)
68 zherczeg 742
69     For valgrind users:
70     - pass --smc-check=all argument to valgrind, since JIT is a "self-modifying code"
71 ph10 662 */
72    
73     #if !(defined SLJIT_NO_DEFAULT_CONFIG && SLJIT_NO_DEFAULT_CONFIG)
74     #include "sljitConfig.h"
75     #endif
76 zherczeg 839
77     /* The following header file defines useful macros for fine tuning
78 ph10 1325 sljit based code generators. They are listed in the beginning
79 zherczeg 839 of sljitConfigInternal.h */
80    
81 ph10 662 #include "sljitConfigInternal.h"
82    
83     /* --------------------------------------------------------------------- */
84     /* Error codes */
85     /* --------------------------------------------------------------------- */
86    
87     /* Indicates no error. */
88     #define SLJIT_SUCCESS 0
89     /* After the call of sljit_generate_code(), the error code of the compiler
90     is set to this value to avoid future sljit calls (in debug mode at least).
91     The complier should be freed after sljit_generate_code(). */
92     #define SLJIT_ERR_COMPILED 1
93     /* Cannot allocate non executable memory. */
94     #define SLJIT_ERR_ALLOC_FAILED 2
95     /* Cannot allocate executable memory.
96     Only for sljit_generate_code() */
97     #define SLJIT_ERR_EX_ALLOC_FAILED 3
98     /* return value for SLJIT_CONFIG_UNSUPPORTED empty architecture. */
99     #define SLJIT_ERR_UNSUPPORTED 4
100    
101     /* --------------------------------------------------------------------- */
102     /* Registers */
103     /* --------------------------------------------------------------------- */
104    
105 zherczeg 1491 /*
106     Scratch (R) registers: registers whose may not preserve their values
107     across function calls.
108    
109     Saved (S) registers: registers whose preserve their values across
110     function calls.
111    
112     The scratch and saved register sets are overlap. The last scratch register
113     is the first saved register, the one before the last is the second saved
114     register, and so on.
115    
116     If an architecture provides two scratch and three saved registers,
117     its scratch and saved register sets are the following:
118    
119     R0 | [S4] | R0 and S4 represent the same physical register
120     R1 | [S3] | R1 and S3 represent the same physical register
121     [R2] | S2 | R2 and S2 represent the same physical register
122     [R3] | S1 | R3 and S1 represent the same physical register
123     [R4] | S0 | R4 and S0 represent the same physical register
124    
125     Note: SLJIT_NUMBER_OF_SCRATCH_REGISTERS would be 2 and
126     SLJIT_NUMBER_OF_SAVED_REGISTERS would be 3 for this architecture.
127    
128     Note: On all supported architectures SLJIT_NUMBER_OF_REGISTERS >= 10
129     and SLJIT_NUMBER_OF_SAVED_REGISTERS >= 5. However, 4 registers
130     are virtual on x86-32. See below.
131    
132     The purpose of this definition is convenience. Although a register
133     is either scratch register or saved register, SLJIT allows accessing
134     them from the other set. For example, four registers can be used as
135     scratch registers and the fifth one as saved register on the architecture
136     above. Of course the last two scratch registers (R2 and R3) from this
137     four will be saved on the stack, because they are defined as saved
138     registers in the application binary interface. Still R2 and R3 can be
139     used for referencing to these registers instead of S2 and S1, which
140     makes easier to write platform independent code. Scratch registers
141     can be saved registers in a similar way, but these extra saved
142     registers will not be preserved across function calls! Hence the
143     application must save them on those platforms, where the number of
144     saved registers is too low. This can be done by copy them onto
145     the stack and restore them after a function call.
146    
147     Note: To emphasize that registers assigned to R2-R4 are saved
148     registers, they are enclosed by square brackets. S3-S4
149     are marked in a similar way.
150    
151     Note: sljit_emit_enter and sljit_set_context defines whether a register
152     is S or R register. E.g: when 3 scratches and 1 saved is mapped
153     by sljit_emit_enter, the allowed register set will be: R0-R2 and
154     S0. Although S2 is mapped to the same position as R2, it does not
155     available in the current configuration. Furthermore the R3 (S1)
156     register does not available as well.
157     */
158    
159     /* When SLJIT_UNUSED is specified as destination, the result is discarded. */
160 ph10 662 #define SLJIT_UNUSED 0
161    
162 zherczeg 1491 /* Scratch registers. */
163     #define SLJIT_R0 1
164     #define SLJIT_R1 2
165     #define SLJIT_R2 3
166 zherczeg 1493 /* Note: on x86-32, R3 - R6 (same as S3 - S6) are emulated (they
167     are allocated on the stack). These registers are called virtual
168     and cannot be used for memory addressing (cannot be part of
169     any SLJIT_MEM1, SLJIT_MEM2 construct). There is no such
170     limitation on other CPUs. See sljit_get_register_index(). */
171 zherczeg 1491 #define SLJIT_R3 4
172     #define SLJIT_R4 5
173     #define SLJIT_R5 6
174     #define SLJIT_R6 7
175     #define SLJIT_R7 8
176     #define SLJIT_R8 9
177     #define SLJIT_R9 10
178     /* All R registers provided by the architecture can be accessed by SLJIT_R(i)
179     The i parameter must be >= 0 and < SLJIT_NUMBER_OF_REGISTERS. */
180     #define SLJIT_R(i) (1 + (i))
181 ph10 662
182 zherczeg 1491 /* Saved registers. */
183     #define SLJIT_S0 (SLJIT_NUMBER_OF_REGISTERS)
184     #define SLJIT_S1 (SLJIT_NUMBER_OF_REGISTERS - 1)
185     #define SLJIT_S2 (SLJIT_NUMBER_OF_REGISTERS - 2)
186 zherczeg 1493 /* Note: on x86-32, S3 - S6 (same as R3 - R6) are emulated (they
187     are allocated on the stack). These registers are called virtual
188     and cannot be used for memory addressing (cannot be part of
189     any SLJIT_MEM1, SLJIT_MEM2 construct). There is no such
190     limitation on other CPUs. See sljit_get_register_index(). */
191 zherczeg 1491 #define SLJIT_S3 (SLJIT_NUMBER_OF_REGISTERS - 3)
192     #define SLJIT_S4 (SLJIT_NUMBER_OF_REGISTERS - 4)
193     #define SLJIT_S5 (SLJIT_NUMBER_OF_REGISTERS - 5)
194     #define SLJIT_S6 (SLJIT_NUMBER_OF_REGISTERS - 6)
195     #define SLJIT_S7 (SLJIT_NUMBER_OF_REGISTERS - 7)
196     #define SLJIT_S8 (SLJIT_NUMBER_OF_REGISTERS - 8)
197     #define SLJIT_S9 (SLJIT_NUMBER_OF_REGISTERS - 9)
198     /* All S registers provided by the architecture can be accessed by SLJIT_S(i)
199     The i parameter must be >= 0 and < SLJIT_NUMBER_OF_SAVED_REGISTERS. */
200     #define SLJIT_S(i) (SLJIT_NUMBER_OF_REGISTERS - (i))
201 ph10 662
202 zherczeg 1491 /* Registers >= SLJIT_FIRST_SAVED_REG are saved registers. */
203     #define SLJIT_FIRST_SAVED_REG (SLJIT_S0 - SLJIT_NUMBER_OF_SAVED_REGISTERS + 1)
204 ph10 662
205 zherczeg 1491 /* The SLJIT_SP provides direct access to the linear stack space allocated by
206     sljit_emit_enter. It can only be used in the following form: SLJIT_MEM1(SLJIT_SP).
207     The immediate offset is extended by the relative stack offset automatically.
208     The sljit_get_local_base can be used to obtain the absolute offset. */
209     #define SLJIT_SP (SLJIT_NUMBER_OF_REGISTERS + 1)
210 ph10 662
211     /* Return with machine word. */
212    
213 zherczeg 1491 #define SLJIT_RETURN_REG SLJIT_R0
214 ph10 662
215 zherczeg 847 /* x86 prefers specific registers for special purposes. In case of shift
216 zherczeg 1491 by register it supports only SLJIT_R2 for shift argument
217 zherczeg 847 (which is the src2 argument of sljit_emit_op2). If another register is
218     used, sljit must exchange data between registers which cause a minor
219     slowdown. Other architectures has no such limitation. */
220 ph10 662
221 zherczeg 1491 #define SLJIT_PREF_SHIFT_REG SLJIT_R2
222 ph10 662
223     /* --------------------------------------------------------------------- */
224     /* Floating point registers */
225     /* --------------------------------------------------------------------- */
226    
227 zherczeg 1491 /* Each floating point register can store a double or single precision
228     value. The FR and FS register sets are overlap in the same way as R
229     and S register sets. See above. */
230    
231 ph10 662 /* Note: SLJIT_UNUSED as destination is not valid for floating point
232 zherczeg 1491 operations, since they cannot be used for setting flags. */
233 ph10 662
234 zherczeg 1491 /* Floating point scratch registers. */
235     #define SLJIT_FR0 1
236     #define SLJIT_FR1 2
237     #define SLJIT_FR2 3
238     #define SLJIT_FR3 4
239     #define SLJIT_FR4 5
240     #define SLJIT_FR5 6
241     /* All FR registers provided by the architecture can be accessed by SLJIT_FR(i)
242     The i parameter must be >= 0 and < SLJIT_NUMBER_OF_FLOAT_REGISTERS. */
243     #define SLJIT_FR(i) (1 + (i))
244 ph10 662
245 zherczeg 1491 /* Floating point saved registers. */
246     #define SLJIT_FS0 (SLJIT_NUMBER_OF_FLOAT_REGISTERS)
247     #define SLJIT_FS1 (SLJIT_NUMBER_OF_FLOAT_REGISTERS - 1)
248     #define SLJIT_FS2 (SLJIT_NUMBER_OF_FLOAT_REGISTERS - 2)
249     #define SLJIT_FS3 (SLJIT_NUMBER_OF_FLOAT_REGISTERS - 3)
250     #define SLJIT_FS4 (SLJIT_NUMBER_OF_FLOAT_REGISTERS - 4)
251     #define SLJIT_FS5 (SLJIT_NUMBER_OF_FLOAT_REGISTERS - 5)
252     /* All S registers provided by the architecture can be accessed by SLJIT_FS(i)
253     The i parameter must be >= 0 and < SLJIT_NUMBER_OF_SAVED_FLOAT_REGISTERS. */
254     #define SLJIT_FS(i) (SLJIT_NUMBER_OF_FLOAT_REGISTERS - (i))
255 ph10 662
256 zherczeg 1491 /* Float registers >= SLJIT_FIRST_SAVED_FLOAT_REG are saved registers. */
257     #define SLJIT_FIRST_SAVED_FLOAT_REG (SLJIT_FS0 - SLJIT_NUMBER_OF_SAVED_FLOAT_REGISTERS + 1)
258 zherczeg 1280
259 ph10 662 /* --------------------------------------------------------------------- */
260     /* Main structures and functions */
261     /* --------------------------------------------------------------------- */
262    
263     struct sljit_memory_fragment {
264     struct sljit_memory_fragment *next;
265     sljit_uw used_size;
266 zherczeg 1195 /* Must be aligned to sljit_sw. */
267 ph10 662 sljit_ub memory[1];
268     };
269    
270     struct sljit_label {
271     struct sljit_label *next;
272     sljit_uw addr;
273     /* The maximum size difference. */
274     sljit_uw size;
275     };
276    
277     struct sljit_jump {
278     struct sljit_jump *next;
279     sljit_uw addr;
280 zherczeg 1195 sljit_sw flags;
281 ph10 662 union {
282     sljit_uw target;
283     struct sljit_label* label;
284     } u;
285     };
286    
287     struct sljit_const {
288     struct sljit_const *next;
289     sljit_uw addr;
290     };
291    
292     struct sljit_compiler {
293 zherczeg 1195 sljit_si error;
294 ph10 662
295     struct sljit_label *labels;
296     struct sljit_jump *jumps;
297     struct sljit_const *consts;
298     struct sljit_label *last_label;
299     struct sljit_jump *last_jump;
300     struct sljit_const *last_const;
301    
302     struct sljit_memory_fragment *buf;
303     struct sljit_memory_fragment *abuf;
304    
305 zherczeg 1491 /* Used scratch registers. */
306 zherczeg 1215 sljit_si scratches;
307 zherczeg 880 /* Used saved registers. */
308 zherczeg 1195 sljit_si saveds;
309 zherczeg 1491 /* Used float scratch registers. */
310     sljit_si fscratches;
311     /* Used float saved registers. */
312     sljit_si fsaveds;
313 ph10 662 /* Local stack size. */
314 zherczeg 1195 sljit_si local_size;
315 ph10 662 /* Code size. */
316     sljit_uw size;
317 ph10 836 /* For statistical purposes. */
318     sljit_uw executable_size;
319 ph10 662
320     #if (defined SLJIT_CONFIG_X86_32 && SLJIT_CONFIG_X86_32)
321 zherczeg 1195 sljit_si args;
322 ph10 662 #endif
323    
324     #if (defined SLJIT_CONFIG_X86_64 && SLJIT_CONFIG_X86_64)
325 zherczeg 1195 sljit_si mode32;
326 ph10 662 #endif
327    
328 zherczeg 1483 #if (defined SLJIT_CONFIG_X86 && SLJIT_CONFIG_X86)
329 zherczeg 1195 sljit_si flags_saved;
330 ph10 662 #endif
331    
332     #if (defined SLJIT_CONFIG_ARM_V5 && SLJIT_CONFIG_ARM_V5)
333     /* Constant pool handling. */
334     sljit_uw *cpool;
335     sljit_ub *cpool_unique;
336     sljit_uw cpool_diff;
337     sljit_uw cpool_fill;
338 zherczeg 880 /* Other members. */
339 ph10 662 /* Contains pointer, "ldr pc, [...]" pairs. */
340     sljit_uw patches;
341     #endif
342    
343     #if (defined SLJIT_CONFIG_ARM_V5 && SLJIT_CONFIG_ARM_V5) || (defined SLJIT_CONFIG_ARM_V7 && SLJIT_CONFIG_ARM_V7)
344     /* Temporary fields. */
345     sljit_uw shift_imm;
346 zherczeg 1195 sljit_si cache_arg;
347     sljit_sw cache_argw;
348 ph10 662 #endif
349    
350     #if (defined SLJIT_CONFIG_ARM_THUMB2 && SLJIT_CONFIG_ARM_THUMB2)
351 zherczeg 1195 sljit_si cache_arg;
352     sljit_sw cache_argw;
353 ph10 662 #endif
354    
355 zherczeg 1453 #if (defined SLJIT_CONFIG_ARM_64 && SLJIT_CONFIG_ARM_64)
356     sljit_si locals_offset;
357     sljit_si cache_arg;
358     sljit_sw cache_argw;
359     #endif
360    
361 zherczeg 1483 #if (defined SLJIT_CONFIG_PPC && SLJIT_CONFIG_PPC)
362 zherczeg 1195 sljit_sw imm;
363     sljit_si cache_arg;
364     sljit_sw cache_argw;
365 ph10 662 #endif
366    
367 zherczeg 1483 #if (defined SLJIT_CONFIG_MIPS && SLJIT_CONFIG_MIPS)
368 zherczeg 1195 sljit_si delay_slot;
369     sljit_si cache_arg;
370     sljit_sw cache_argw;
371 ph10 662 #endif
372    
373 zherczeg 1149 #if (defined SLJIT_CONFIG_SPARC_32 && SLJIT_CONFIG_SPARC_32)
374 zherczeg 1195 sljit_si delay_slot;
375     sljit_si cache_arg;
376     sljit_sw cache_argw;
377 zherczeg 1149 #endif
378    
379 zherczeg 1378 #if (defined SLJIT_CONFIG_TILEGX && SLJIT_CONFIG_TILEGX)
380     sljit_si cache_arg;
381     sljit_sw cache_argw;
382     #endif
383    
384 ph10 662 #if (defined SLJIT_VERBOSE && SLJIT_VERBOSE)
385     FILE* verbose;
386     #endif
387    
388 zherczeg 955 #if (defined SLJIT_DEBUG && SLJIT_DEBUG)
389     /* Local size passed to the functions. */
390 zherczeg 1195 sljit_si logical_local_size;
391 zherczeg 955 #endif
392    
393 ph10 662 #if (defined SLJIT_VERBOSE && SLJIT_VERBOSE) || (defined SLJIT_DEBUG && SLJIT_DEBUG)
394 zherczeg 1195 sljit_si skip_checks;
395 ph10 662 #endif
396     };
397    
398     /* --------------------------------------------------------------------- */
399     /* Main functions */
400     /* --------------------------------------------------------------------- */
401    
402     /* Creates an sljit compiler.
403     Returns NULL if failed. */
404 zherczeg 740 SLJIT_API_FUNC_ATTRIBUTE struct sljit_compiler* sljit_create_compiler(void);
405 zherczeg 1216
406     /* Free everything except the compiled machine code. */
407 zherczeg 740 SLJIT_API_FUNC_ATTRIBUTE void sljit_free_compiler(struct sljit_compiler *compiler);
408 ph10 662
409 ph10 1325 /* Returns the current error code. If an error is occurred, future sljit
410 zherczeg 1216 calls which uses the same compiler argument returns early with the same
411     error code. Thus there is no need for checking the error after every
412     call, it is enough to do it before the code is compiled. Removing
413     these checks increases the performance of the compiling process. */
414 zherczeg 1195 static SLJIT_INLINE sljit_si sljit_get_compiler_error(struct sljit_compiler *compiler) { return compiler->error; }
415 ph10 662
416     /*
417     Allocate a small amount of memory. The size must be <= 64 bytes on 32 bit,
418 zherczeg 1216 and <= 128 bytes on 64 bit architectures. The memory area is owned by the
419     compiler, and freed by sljit_free_compiler. The returned pointer is
420     sizeof(sljit_sw) aligned. Excellent for allocating small blocks during
421     the compiling, and no need to worry about freeing them. The size is
422     enough to contain at most 16 pointers. If the size is outside of the range,
423     the function will return with NULL. However, this return value does not
424     indicate that there is no more memory (does not set the current error code
425     of the compiler to out-of-memory status).
426 ph10 662 */
427 zherczeg 1195 SLJIT_API_FUNC_ATTRIBUTE void* sljit_alloc_memory(struct sljit_compiler *compiler, sljit_si size);
428 ph10 662
429     #if (defined SLJIT_VERBOSE && SLJIT_VERBOSE)
430     /* Passing NULL disables verbose. */
431 zherczeg 740 SLJIT_API_FUNC_ATTRIBUTE void sljit_compiler_verbose(struct sljit_compiler *compiler, FILE* verbose);
432 ph10 662 #endif
433    
434 zherczeg 740 SLJIT_API_FUNC_ATTRIBUTE void* sljit_generate_code(struct sljit_compiler *compiler);
435     SLJIT_API_FUNC_ATTRIBUTE void sljit_free_code(void* code);
436 ph10 662
437 ph10 836 /*
438 zherczeg 1216 After the machine code generation is finished we can retrieve the allocated
439     executable memory size, although this area may not be fully filled with
440     instructions depending on some optimizations. This function is useful only
441     for statistical purposes.
442 ph10 836
443     Before a successful code generation, this function returns with 0.
444     */
445     static SLJIT_INLINE sljit_uw sljit_get_generated_code_size(struct sljit_compiler *compiler) { return compiler->executable_size; }
446    
447 zherczeg 1216 /* Instruction generation. Returns with any error code. If there is no
448     error, they return with SLJIT_SUCCESS. */
449 ph10 662
450     /*
451 zherczeg 1491 The executable code is a function call from the viewpoint of the C
452     language. The function calls must obey to the ABI (Application
453     Binary Interface) of the platform, which specify the purpose of
454     all machine registers and stack handling among other things. The
455     sljit_emit_enter function emits the necessary instructions for
456     setting up a new context for the executable code and moves function
457     arguments to the saved registers. The number of sljit_sw arguments
458     passed to the function are specified in the "args" parameter. The
459     number of arguments must be less than or equal to 3. The first
460     argument goes to SLJIT_S0, the second goes to SLJIT_S1 and so on.
461     The register set used by the function must be declared as well.
462     The number of scratch and saved registers used by the function must
463     be passed to sljit_emit_enter. Only R registers between R0 and
464     "scratches" argument can be used later. E.g. if "scratches" is set
465     to 2, the register set will be limited to R0 and R1. The S registers
466     and the floating point registers ("fscratches" and "fsaveds")
467     are specified in a similar way. The sljit_emit_enter is also capable
468     of allocating a stack space for local variables. The "local_size"
469     argument contains the size in bytes of this local area and its
470     staring address is stored in SLJIT_SP. The memory area between
471     SLJIT_SP (inclusive) and SLJIT_SP + local_size (exclusive) can be
472     modified freely until the function returns. The stack space is not
473     initialized.
474 ph10 662
475 zherczeg 1491 Note: the following conditions must met:
476     0 <= scratches <= SLJIT_NUMBER_OF_REGISTERS
477     0 <= saveds <= SLJIT_NUMBER_OF_REGISTERS
478     scratches + saveds <= SLJIT_NUMBER_OF_REGISTERS
479     0 <= fscratches <= SLJIT_NUMBER_OF_FLOAT_REGISTERS
480     0 <= fsaveds <= SLJIT_NUMBER_OF_FLOAT_REGISTERS
481     fscratches + fsaveds <= SLJIT_NUMBER_OF_FLOAT_REGISTERS
482    
483 zherczeg 1216 Note: every call of sljit_emit_enter and sljit_set_context
484 zherczeg 1491 overwrites the previous context.
485     */
486 ph10 662
487     #define SLJIT_MAX_LOCAL_SIZE 65536
488    
489 zherczeg 1195 SLJIT_API_FUNC_ATTRIBUTE sljit_si sljit_emit_enter(struct sljit_compiler *compiler,
490 zherczeg 1491 sljit_si args, sljit_si scratches, sljit_si saveds,
491     sljit_si fscratches, sljit_si fsaveds, sljit_si local_size);
492 ph10 662
493 zherczeg 860 /* The machine code has a context (which contains the local stack space size,
494     number of used registers, etc.) which initialized by sljit_emit_enter. Several
495     functions (like sljit_emit_return) requres this context to be able to generate
496     the appropriate code. However, some code fragments (like inline cache) may have
497 zherczeg 1491 no normal entry point so their context is unknown for the compiler. Their context
498     can be provided to the compiler by the sljit_set_context function.
499 ph10 662
500 zherczeg 860 Note: every call of sljit_emit_enter and sljit_set_context overwrites
501     the previous context. */
502    
503 zherczeg 875 SLJIT_API_FUNC_ATTRIBUTE void sljit_set_context(struct sljit_compiler *compiler,
504 zherczeg 1491 sljit_si args, sljit_si scratches, sljit_si saveds,
505     sljit_si fscratches, sljit_si fsaveds, sljit_si local_size);
506 ph10 662
507 zherczeg 875 /* Return from machine code. The op argument can be SLJIT_UNUSED which means the
508     function does not return with anything or any opcode between SLJIT_MOV and
509 zherczeg 1182 SLJIT_MOV_P (see sljit_emit_op1). As for src and srcw they must be 0 if op
510 zherczeg 875 is SLJIT_UNUSED, otherwise see below the description about source and
511     destination arguments. */
512 zherczeg 1216
513 zherczeg 1195 SLJIT_API_FUNC_ATTRIBUTE sljit_si sljit_emit_return(struct sljit_compiler *compiler, sljit_si op,
514     sljit_si src, sljit_sw srcw);
515 ph10 662
516 zherczeg 1216 /* Fast calling mechanism for utility functions (see SLJIT_FAST_CALL). All registers and
517     even the stack frame is passed to the callee. The return address is preserved in
518     dst/dstw by sljit_emit_fast_enter (the type of the value stored by this function
519     is sljit_p), and sljit_emit_fast_return can use this as a return value later. */
520 ph10 662
521 zherczeg 1182 /* Note: only for sljit specific, non ABI compilant calls. Fast, since only a few machine
522     instructions are needed. Excellent for small uility functions, where saving registers
523     and setting up a new stack frame would cost too much performance. However, it is still
524     possible to return to the address of the caller (or anywhere else). */
525 ph10 662
526     /* Note: flags are not changed (unlike sljit_emit_enter / sljit_emit_return). */
527    
528     /* Note: although sljit_emit_fast_return could be replaced by an ijump, it is not suggested,
529     since many architectures do clever branch prediction on call / return instruction pairs. */
530    
531 zherczeg 1195 SLJIT_API_FUNC_ATTRIBUTE sljit_si sljit_emit_fast_enter(struct sljit_compiler *compiler, sljit_si dst, sljit_sw dstw);
532     SLJIT_API_FUNC_ATTRIBUTE sljit_si sljit_emit_fast_return(struct sljit_compiler *compiler, sljit_si src, sljit_sw srcw);
533 ph10 662
534     /*
535     Source and destination values for arithmetical instructions
536     imm - a simple immediate value (cannot be used as a destination)
537     reg - any of the registers (immediate argument must be 0)
538     [imm] - absolute immediate memory address
539     [reg+imm] - indirect memory address
540     [reg+(reg<<imm)] - indirect indexed memory address (shift must be between 0 and 3)
541 zherczeg 1195 useful for (byte, half, int, sljit_sw) array access
542 ph10 662 (fully supported by both x86 and ARM architectures, and cheap operation on others)
543     */
544    
545     /*
546 zherczeg 847 IMPORATNT NOTE: memory access MUST be naturally aligned except
547     SLJIT_UNALIGNED macro is defined and its value is 1.
548    
549 ph10 662 length | alignment
550     ---------+-----------
551 zherczeg 1195 byte | 1 byte (any physical_address is accepted)
552     half | 2 byte (physical_address & 0x1 == 0)
553     int | 4 byte (physical_address & 0x3 == 0)
554     word | 4 byte if SLJIT_32BIT_ARCHITECTURE is defined and its value is 1
555 zherczeg 847 | 8 byte if SLJIT_64BIT_ARCHITECTURE is defined and its value is 1
556 zherczeg 1195 pointer | size of sljit_p type (4 byte on 32 bit machines, 4 or 8 byte
557     | on 64 bit machines)
558 ph10 662
559 zherczeg 1195 Note: Different architectures have different addressing limitations.
560     A single instruction is enough for the following addressing
561     modes. Other adrressing modes are emulated by instruction
562     sequences. This information could help to improve those code
563     generators which focuses only a few architectures.
564    
565 ph10 1325 x86: [reg+imm], -2^32+1 <= imm <= 2^32-1 (full address space on x86-32)
566 zherczeg 1195 [reg+(reg<<imm)] is supported
567     [imm], -2^32+1 <= imm <= 2^32-1 is supported
568     Write-back is not supported
569     arm: [reg+imm], -4095 <= imm <= 4095 or -255 <= imm <= 255 for signed
570     bytes, any halfs or floating point values)
571     [reg+(reg<<imm)] is supported
572     Write-back is supported
573     arm-t2: [reg+imm], -255 <= imm <= 4095
574     [reg+(reg<<imm)] is supported
575     Write back is supported only for [reg+imm], where -255 <= imm <= 255
576     ppc: [reg+imm], -65536 <= imm <= 65535. 64 bit loads/stores and 32 bit
577     signed load on 64 bit requires immediates divisible by 4.
578     [reg+imm] is not supported for signed 8 bit values.
579     [reg+reg] is supported
580     Write-back is supported except for one instruction: 32 bit signed
581     load with [reg+imm] addressing mode on 64 bit.
582     mips: [reg+imm], -65536 <= imm <= 65535
583     sparc: [reg+imm], -4096 <= imm <= 4095
584     [reg+reg] is supported
585 ph10 662 */
586    
587     /* Register output: simply the name of the register.
588     For destination, you can use SLJIT_UNUSED as well. */
589 zherczeg 1453 #define SLJIT_MEM 0x80
590 ph10 662 #define SLJIT_MEM0() (SLJIT_MEM)
591     #define SLJIT_MEM1(r1) (SLJIT_MEM | (r1))
592 zherczeg 1453 #define SLJIT_MEM2(r1, r2) (SLJIT_MEM | (r1) | ((r2) << 8))
593     #define SLJIT_IMM 0x40
594 ph10 662
595     /* Set 32 bit operation mode (I) on 64 bit CPUs. The flag is totally ignored on
596 zherczeg 1195 32 bit CPUs. If this flag is set for an arithmetic operation, it uses only the
597     lower 32 bit of the input register(s), and set the CPU status flags according
598     to the 32 bit result. The higher 32 bits are undefined for both the input and
599     output. However, the CPU might not ignore those higher 32 bits, like MIPS, which
600     expects it to be the sign extension of the lower 32 bit. All 32 bit operations
601     are undefined, if this condition is not fulfilled. Therefore, when SLJIT_INT_OP
602     is specified, all register arguments must be the result of other operations with
603     the same SLJIT_INT_OP flag. In other words, although a register can hold either
604     a 64 or 32 bit value, these values cannot be mixed. The only exceptions are
605 zherczeg 1460 SLJIT_IMOV and SLJIT_IMOVU (SLJIT_MOV_SI/SLJIT_MOVU_SI with SLJIT_INT_OP flag)
606     which can convert any source argument to SLJIT_INT_OP compatible result. This
607     conversion might be unnecessary on some CPUs like x86-64, since the upper 32
608     bit is always ignored. In this case SLJIT is clever enough to not generate any
609     instructions if the source and destination operands are the same registers.
610     Affects sljit_emit_op0, sljit_emit_op1 and sljit_emit_op2. */
611 ph10 662 #define SLJIT_INT_OP 0x100
612    
613 zherczeg 1195 /* Single precision mode (SP). This flag is similar to SLJIT_INT_OP, just
614     it applies to floating point registers (it is even the same bit). When
615     this flag is passed, the CPU performs single precision floating point
616     operations. Similar to SLJIT_INT_OP, all register arguments must be the
617     result of other floating point operations with this flag. Affects
618     sljit_emit_fop1, sljit_emit_fop2 and sljit_emit_fcmp. */
619     #define SLJIT_SINGLE_OP 0x100
620    
621 ph10 662 /* Common CPU status flags for all architectures (x86, ARM, PPC)
622     - carry flag
623     - overflow flag
624     - zero flag
625     - negative/positive flag (depends on arc)
626     On mips, these flags are emulated by software. */
627    
628     /* By default, the instructions may, or may not set the CPU status flags.
629     Forcing to set or keep status flags can be done with the following flags: */
630    
631     /* Note: sljit tries to emit the minimum number of instructions. Using these
632     flags can increase them, so use them wisely to avoid unnecessary code generation. */
633    
634     /* Set Equal (Zero) status flag (E). */
635     #define SLJIT_SET_E 0x0200
636 zherczeg 1460 /* Set unsigned status flag (U). */
637     #define SLJIT_SET_U 0x0400
638 ph10 662 /* Set signed status flag (S). */
639 zherczeg 1460 #define SLJIT_SET_S 0x0800
640 ph10 662 /* Set signed overflow flag (O). */
641     #define SLJIT_SET_O 0x1000
642     /* Set carry flag (C).
643     Note: Kinda unsigned overflow, but behaves differently on various cpus. */
644     #define SLJIT_SET_C 0x2000
645     /* Do not modify the flags (K).
646     Note: This flag cannot be combined with any other SLJIT_SET_* flag. */
647     #define SLJIT_KEEP_FLAGS 0x4000
648    
649     /* Notes:
650     - you cannot postpone conditional jump instructions except if noted that
651     the instruction does not set flags (See: SLJIT_KEEP_FLAGS).
652     - flag combinations: '|' means 'logical or'. */
653    
654     /* Flags: - (never set any flags)
655     Note: breakpoint instruction is not supported by all architectures (namely ppc)
656     It falls back to SLJIT_NOP in those cases. */
657     #define SLJIT_BREAKPOINT 0
658     /* Flags: - (never set any flags)
659     Note: may or may not cause an extra cycle wait
660     it can even decrease the runtime in a few cases. */
661     #define SLJIT_NOP 1
662 zherczeg 1195 /* Flags: - (may destroy flags)
663 zherczeg 1491 Unsigned multiplication of SLJIT_R0 and SLJIT_R1.
664     Result goes to SLJIT_R1:SLJIT_R0 (high:low) word */
665 zherczeg 847 #define SLJIT_UMUL 2
666 zherczeg 1195 /* Flags: - (may destroy flags)
667 zherczeg 1491 Signed multiplication of SLJIT_R0 and SLJIT_R1.
668     Result goes to SLJIT_R1:SLJIT_R0 (high:low) word */
669 zherczeg 847 #define SLJIT_SMUL 3
670 zherczeg 1195 /* Flags: I - (may destroy flags)
671 zherczeg 1491 Unsigned divide of the value in SLJIT_R0 by the value in SLJIT_R1.
672     The result is placed in SLJIT_R0 and the remainder goes to SLJIT_R1.
673     Note: if SLJIT_R1 contains 0, the behaviour is undefined. */
674 zherczeg 847 #define SLJIT_UDIV 4
675 zherczeg 1195 #define SLJIT_IUDIV (SLJIT_UDIV | SLJIT_INT_OP)
676     /* Flags: I - (may destroy flags)
677 zherczeg 1491 Signed divide of the value in SLJIT_R0 by the value in SLJIT_R1.
678     The result is placed in SLJIT_R0 and the remainder goes to SLJIT_R1.
679     Note: if SLJIT_R1 contains 0, the behaviour is undefined. */
680 zherczeg 847 #define SLJIT_SDIV 5
681 zherczeg 1195 #define SLJIT_ISDIV (SLJIT_SDIV | SLJIT_INT_OP)
682 ph10 662
683 zherczeg 1195 SLJIT_API_FUNC_ATTRIBUTE sljit_si sljit_emit_op0(struct sljit_compiler *compiler, sljit_si op);
684 ph10 662
685     /* Notes for MOV instructions:
686 zherczeg 1453 U = Mov with update (pre form). If source or destination defined as SLJIT_MEM1(r1)
687 ph10 662 or SLJIT_MEM2(r1, r2), r1 is increased by the sum of r2 and the constant argument
688     UB = unsigned byte (8 bit)
689     SB = signed byte (8 bit)
690 zherczeg 1182 UH = unsigned half (16 bit)
691     SH = signed half (16 bit)
692     UI = unsigned int (32 bit)
693     SI = signed int (32 bit)
694     P = pointer (sljit_p) size */
695 ph10 662
696     /* Flags: - (never set any flags) */
697 zherczeg 847 #define SLJIT_MOV 6
698 zherczeg 1195 /* Flags: I - (never set any flags) */
699 zherczeg 847 #define SLJIT_MOV_UB 7
700 zherczeg 1195 #define SLJIT_IMOV_UB (SLJIT_MOV_UB | SLJIT_INT_OP)
701     /* Flags: I - (never set any flags) */
702 zherczeg 847 #define SLJIT_MOV_SB 8
703 zherczeg 1195 #define SLJIT_IMOV_SB (SLJIT_MOV_SB | SLJIT_INT_OP)
704     /* Flags: I - (never set any flags) */
705 zherczeg 847 #define SLJIT_MOV_UH 9
706 zherczeg 1195 #define SLJIT_IMOV_UH (SLJIT_MOV_UH | SLJIT_INT_OP)
707     /* Flags: I - (never set any flags) */
708 zherczeg 847 #define SLJIT_MOV_SH 10
709 zherczeg 1195 #define SLJIT_IMOV_SH (SLJIT_MOV_SH | SLJIT_INT_OP)
710     /* Flags: I - (never set any flags)
711     Note: see SLJIT_INT_OP for further details. */
712 zherczeg 847 #define SLJIT_MOV_UI 11
713 zherczeg 1460 /* No SLJIT_INT_OP form, since it is the same as SLJIT_IMOV. */
714 zherczeg 1195 /* Flags: I - (never set any flags)
715     Note: see SLJIT_INT_OP for further details. */
716 zherczeg 847 #define SLJIT_MOV_SI 12
717 zherczeg 1195 #define SLJIT_IMOV (SLJIT_MOV_SI | SLJIT_INT_OP)
718 ph10 662 /* Flags: - (never set any flags) */
719 zherczeg 1182 #define SLJIT_MOV_P 13
720 ph10 662 /* Flags: - (never set any flags) */
721 zherczeg 1182 #define SLJIT_MOVU 14
722 zherczeg 1195 /* Flags: I - (never set any flags) */
723 zherczeg 1182 #define SLJIT_MOVU_UB 15
724 zherczeg 1195 #define SLJIT_IMOVU_UB (SLJIT_MOVU_UB | SLJIT_INT_OP)
725     /* Flags: I - (never set any flags) */
726 zherczeg 1182 #define SLJIT_MOVU_SB 16
727 zherczeg 1195 #define SLJIT_IMOVU_SB (SLJIT_MOVU_SB | SLJIT_INT_OP)
728     /* Flags: I - (never set any flags) */
729 zherczeg 1182 #define SLJIT_MOVU_UH 17
730 zherczeg 1195 #define SLJIT_IMOVU_UH (SLJIT_MOVU_UH | SLJIT_INT_OP)
731     /* Flags: I - (never set any flags) */
732 zherczeg 1182 #define SLJIT_MOVU_SH 18
733 zherczeg 1195 #define SLJIT_IMOVU_SH (SLJIT_MOVU_SH | SLJIT_INT_OP)
734     /* Flags: I - (never set any flags)
735     Note: see SLJIT_INT_OP for further details. */
736 zherczeg 1182 #define SLJIT_MOVU_UI 19
737 zherczeg 1460 /* No SLJIT_INT_OP form, since it is the same as SLJIT_IMOVU. */
738 zherczeg 1195 /* Flags: I - (never set any flags)
739     Note: see SLJIT_INT_OP for further details. */
740 zherczeg 1182 #define SLJIT_MOVU_SI 20
741 zherczeg 1195 #define SLJIT_IMOVU (SLJIT_MOVU_SI | SLJIT_INT_OP)
742 zherczeg 1182 /* Flags: - (never set any flags) */
743     #define SLJIT_MOVU_P 21
744 ph10 662 /* Flags: I | E | K */
745 zherczeg 1182 #define SLJIT_NOT 22
746 zherczeg 1195 #define SLJIT_INOT (SLJIT_NOT | SLJIT_INT_OP)
747 ph10 662 /* Flags: I | E | O | K */
748 zherczeg 1182 #define SLJIT_NEG 23
749 zherczeg 1195 #define SLJIT_INEG (SLJIT_NEG | SLJIT_INT_OP)
750 ph10 662 /* Count leading zeroes
751 zherczeg 1149 Flags: I | E | K
752     Important note! Sparc 32 does not support K flag, since
753     the required popc instruction is introduced only in sparc 64. */
754 zherczeg 1182 #define SLJIT_CLZ 24
755 zherczeg 1195 #define SLJIT_ICLZ (SLJIT_CLZ | SLJIT_INT_OP)
756 ph10 662
757 zherczeg 1195 SLJIT_API_FUNC_ATTRIBUTE sljit_si sljit_emit_op1(struct sljit_compiler *compiler, sljit_si op,
758     sljit_si dst, sljit_sw dstw,
759     sljit_si src, sljit_sw srcw);
760 ph10 662
761     /* Flags: I | E | O | C | K */
762 zherczeg 1182 #define SLJIT_ADD 25
763 zherczeg 1195 #define SLJIT_IADD (SLJIT_ADD | SLJIT_INT_OP)
764 ph10 662 /* Flags: I | C | K */
765 zherczeg 1182 #define SLJIT_ADDC 26
766 zherczeg 1195 #define SLJIT_IADDC (SLJIT_ADDC | SLJIT_INT_OP)
767 zherczeg 1460 /* Flags: I | E | U | S | O | C | K */
768 zherczeg 1182 #define SLJIT_SUB 27
769 zherczeg 1195 #define SLJIT_ISUB (SLJIT_SUB | SLJIT_INT_OP)
770 ph10 662 /* Flags: I | C | K */
771 zherczeg 1182 #define SLJIT_SUBC 28
772 zherczeg 1195 #define SLJIT_ISUBC (SLJIT_SUBC | SLJIT_INT_OP)
773 zherczeg 860 /* Note: integer mul
774     Flags: I | O (see SLJIT_C_MUL_*) | K */
775 zherczeg 1182 #define SLJIT_MUL 29
776 zherczeg 1195 #define SLJIT_IMUL (SLJIT_MUL | SLJIT_INT_OP)
777 ph10 662 /* Flags: I | E | K */
778 zherczeg 1182 #define SLJIT_AND 30
779 zherczeg 1195 #define SLJIT_IAND (SLJIT_AND | SLJIT_INT_OP)
780 ph10 662 /* Flags: I | E | K */
781 zherczeg 1182 #define SLJIT_OR 31
782 zherczeg 1195 #define SLJIT_IOR (SLJIT_OR | SLJIT_INT_OP)
783 ph10 662 /* Flags: I | E | K */
784 zherczeg 1182 #define SLJIT_XOR 32
785 zherczeg 1195 #define SLJIT_IXOR (SLJIT_XOR | SLJIT_INT_OP)
786 zherczeg 860 /* Flags: I | E | K
787     Let bit_length be the length of the shift operation: 32 or 64.
788     If src2 is immediate, src2w is masked by (bit_length - 1).
789     Otherwise, if the content of src2 is outside the range from 0
790     to bit_length - 1, the operation is undefined. */
791 zherczeg 1182 #define SLJIT_SHL 33
792 zherczeg 1195 #define SLJIT_ISHL (SLJIT_SHL | SLJIT_INT_OP)
793 zherczeg 860 /* Flags: I | E | K
794     Let bit_length be the length of the shift operation: 32 or 64.
795     If src2 is immediate, src2w is masked by (bit_length - 1).
796     Otherwise, if the content of src2 is outside the range from 0
797     to bit_length - 1, the operation is undefined. */
798 zherczeg 1182 #define SLJIT_LSHR 34
799 zherczeg 1195 #define SLJIT_ILSHR (SLJIT_LSHR | SLJIT_INT_OP)
800 zherczeg 860 /* Flags: I | E | K
801     Let bit_length be the length of the shift operation: 32 or 64.
802     If src2 is immediate, src2w is masked by (bit_length - 1).
803     Otherwise, if the content of src2 is outside the range from 0
804     to bit_length - 1, the operation is undefined. */
805 zherczeg 1182 #define SLJIT_ASHR 35
806 zherczeg 1195 #define SLJIT_IASHR (SLJIT_ASHR | SLJIT_INT_OP)
807 ph10 662
808 zherczeg 1195 SLJIT_API_FUNC_ATTRIBUTE sljit_si sljit_emit_op2(struct sljit_compiler *compiler, sljit_si op,
809     sljit_si dst, sljit_sw dstw,
810     sljit_si src1, sljit_sw src1w,
811     sljit_si src2, sljit_sw src2w);
812 ph10 662
813 zherczeg 839 /* The following function is a helper function for sljit_emit_op_custom.
814 zherczeg 1493 It returns with the real machine register index ( >=0 ) of any SLJIT_R,
815     SLJIT_S and SLJIT_SP registers.
816 zherczeg 839
817 zherczeg 1493 Note: it returns with -1 for virtual registers (only on x86-32). */
818    
819 zherczeg 1195 SLJIT_API_FUNC_ATTRIBUTE sljit_si sljit_get_register_index(sljit_si reg);
820 zherczeg 839
821 zherczeg 1280 /* The following function is a helper function for sljit_emit_op_custom.
822     It returns with the real machine register index of any SLJIT_FLOAT register.
823 zherczeg 1493
824     Note: the index is always an even number on ARM (except ARM-64), MIPS, and SPARC. */
825 zherczeg 1280
826     SLJIT_API_FUNC_ATTRIBUTE sljit_si sljit_get_float_register_index(sljit_si reg);
827    
828 zherczeg 839 /* Any instruction can be inserted into the instruction stream by
829     sljit_emit_op_custom. It has a similar purpose as inline assembly.
830     The size parameter must match to the instruction size of the target
831     architecture:
832    
833     x86: 0 < size <= 15. The instruction argument can be byte aligned.
834     Thumb2: if size == 2, the instruction argument must be 2 byte aligned.
835     if size == 4, the instruction argument must be 4 byte aligned.
836     Otherwise: size must be 4 and instruction argument must be 4 byte aligned. */
837    
838 zherczeg 1195 SLJIT_API_FUNC_ATTRIBUTE sljit_si sljit_emit_op_custom(struct sljit_compiler *compiler,
839     void *instruction, sljit_si size);
840 zherczeg 839
841     /* Returns with non-zero if fpu is available. */
842    
843 zherczeg 1195 SLJIT_API_FUNC_ATTRIBUTE sljit_si sljit_is_fpu_available(void);
844 ph10 662
845 zherczeg 1195 /* Flags: SP - (never set any flags) */
846 zherczeg 1483 #define SLJIT_MOVD 36
847 zherczeg 1195 #define SLJIT_MOVS (SLJIT_MOVD | SLJIT_SINGLE_OP)
848     /* Flags: SP - (never set any flags) */
849 zherczeg 1483 #define SLJIT_NEGD 37
850 zherczeg 1195 #define SLJIT_NEGS (SLJIT_NEGD | SLJIT_SINGLE_OP)
851     /* Flags: SP - (never set any flags) */
852 zherczeg 1483 #define SLJIT_ABSD 38
853 zherczeg 1195 #define SLJIT_ABSS (SLJIT_ABSD | SLJIT_SINGLE_OP)
854 zherczeg 1483 /* Convert opcodes: CONV[DST_TYPE].FROM[SRC_TYPE]
855     SRC/DST TYPE can be: D - double, S - single, W - signed word, I - signed int
856     Rounding mode when the destination is W or I: round towards zero. */
857     /* Flags: SP - (never set any flags) */
858     #define SLJIT_CONVD_FROMS 39
859     #define SLJIT_CONVS_FROMD (SLJIT_CONVD_FROMS | SLJIT_SINGLE_OP)
860     /* Flags: SP - (never set any flags) */
861     #define SLJIT_CONVW_FROMD 40
862     #define SLJIT_CONVW_FROMS (SLJIT_CONVW_FROMD | SLJIT_SINGLE_OP)
863     /* Flags: SP - (never set any flags) */
864     #define SLJIT_CONVI_FROMD 41
865     #define SLJIT_CONVI_FROMS (SLJIT_CONVI_FROMD | SLJIT_SINGLE_OP)
866     /* Flags: SP - (never set any flags) */
867     #define SLJIT_CONVD_FROMW 42
868     #define SLJIT_CONVS_FROMW (SLJIT_CONVD_FROMW | SLJIT_SINGLE_OP)
869     /* Flags: SP - (never set any flags) */
870     #define SLJIT_CONVD_FROMI 43
871     #define SLJIT_CONVS_FROMI (SLJIT_CONVD_FROMI | SLJIT_SINGLE_OP)
872     /* Note: dst is the left and src is the right operand for SLJIT_CMPD.
873     Note: NaN check is always performed. If SLJIT_C_FLOAT_UNORDERED flag
874     is set, the comparison result is unpredictable.
875     Flags: SP | E | S (see SLJIT_C_FLOAT_*) */
876     #define SLJIT_CMPD 44
877     #define SLJIT_CMPS (SLJIT_CMPD | SLJIT_SINGLE_OP)
878 ph10 662
879 zherczeg 1195 SLJIT_API_FUNC_ATTRIBUTE sljit_si sljit_emit_fop1(struct sljit_compiler *compiler, sljit_si op,
880     sljit_si dst, sljit_sw dstw,
881     sljit_si src, sljit_sw srcw);
882 ph10 662
883 zherczeg 1195 /* Flags: SP - (never set any flags) */
884 zherczeg 1483 #define SLJIT_ADDD 45
885 zherczeg 1195 #define SLJIT_ADDS (SLJIT_ADDD | SLJIT_SINGLE_OP)
886     /* Flags: SP - (never set any flags) */
887 zherczeg 1483 #define SLJIT_SUBD 46
888 zherczeg 1195 #define SLJIT_SUBS (SLJIT_SUBD | SLJIT_SINGLE_OP)
889     /* Flags: SP - (never set any flags) */
890 zherczeg 1483 #define SLJIT_MULD 47
891 zherczeg 1195 #define SLJIT_MULS (SLJIT_MULD | SLJIT_SINGLE_OP)
892     /* Flags: SP - (never set any flags) */
893 zherczeg 1483 #define SLJIT_DIVD 48
894 zherczeg 1195 #define SLJIT_DIVS (SLJIT_DIVD | SLJIT_SINGLE_OP)
895 ph10 662
896 zherczeg 1195 SLJIT_API_FUNC_ATTRIBUTE sljit_si sljit_emit_fop2(struct sljit_compiler *compiler, sljit_si op,
897     sljit_si dst, sljit_sw dstw,
898     sljit_si src1, sljit_sw src1w,
899     sljit_si src2, sljit_sw src2w);
900 ph10 662
901     /* Label and jump instructions. */
902    
903 zherczeg 740 SLJIT_API_FUNC_ATTRIBUTE struct sljit_label* sljit_emit_label(struct sljit_compiler *compiler);
904 ph10 662
905     /* Invert conditional instruction: xor (^) with 0x1 */
906     #define SLJIT_C_EQUAL 0
907     #define SLJIT_C_ZERO 0
908     #define SLJIT_C_NOT_EQUAL 1
909     #define SLJIT_C_NOT_ZERO 1
910    
911     #define SLJIT_C_LESS 2
912     #define SLJIT_C_GREATER_EQUAL 3
913     #define SLJIT_C_GREATER 4
914     #define SLJIT_C_LESS_EQUAL 5
915     #define SLJIT_C_SIG_LESS 6
916     #define SLJIT_C_SIG_GREATER_EQUAL 7
917     #define SLJIT_C_SIG_GREATER 8
918     #define SLJIT_C_SIG_LESS_EQUAL 9
919    
920     #define SLJIT_C_OVERFLOW 10
921     #define SLJIT_C_NOT_OVERFLOW 11
922    
923     #define SLJIT_C_MUL_OVERFLOW 12
924     #define SLJIT_C_MUL_NOT_OVERFLOW 13
925    
926     #define SLJIT_C_FLOAT_EQUAL 14
927     #define SLJIT_C_FLOAT_NOT_EQUAL 15
928     #define SLJIT_C_FLOAT_LESS 16
929     #define SLJIT_C_FLOAT_GREATER_EQUAL 17
930     #define SLJIT_C_FLOAT_GREATER 18
931     #define SLJIT_C_FLOAT_LESS_EQUAL 19
932 zherczeg 1149 #define SLJIT_C_FLOAT_UNORDERED 20
933     #define SLJIT_C_FLOAT_ORDERED 21
934 ph10 662
935     #define SLJIT_JUMP 22
936 zherczeg 722 #define SLJIT_FAST_CALL 23
937     #define SLJIT_CALL0 24
938     #define SLJIT_CALL1 25
939     #define SLJIT_CALL2 26
940     #define SLJIT_CALL3 27
941 ph10 662
942     /* Fast calling method. See sljit_emit_fast_enter / sljit_emit_fast_return. */
943    
944     /* The target can be changed during runtime (see: sljit_set_jump_addr). */
945     #define SLJIT_REWRITABLE_JUMP 0x1000
946    
947     /* Emit a jump instruction. The destination is not set, only the type of the jump.
948     type must be between SLJIT_C_EQUAL and SLJIT_CALL3
949     type can be combined (or'ed) with SLJIT_REWRITABLE_JUMP
950     Flags: - (never set any flags) for both conditional and unconditional jumps.
951     Flags: destroy all flags for calls. */
952 zherczeg 1195 SLJIT_API_FUNC_ATTRIBUTE struct sljit_jump* sljit_emit_jump(struct sljit_compiler *compiler, sljit_si type);
953 ph10 662
954 zherczeg 867 /* Basic arithmetic comparison. In most architectures it is implemented as
955     an SLJIT_SUB operation (with SLJIT_UNUSED destination and setting
956     appropriate flags) followed by a sljit_emit_jump. However some
957     architectures (i.e: MIPS) may employ special optimizations here. It is
958     suggested to use this comparison form when appropriate.
959 ph10 662 type must be between SLJIT_C_EQUAL and SLJIT_C_SIG_LESS_EQUAL
960     type can be combined (or'ed) with SLJIT_REWRITABLE_JUMP or SLJIT_INT_OP
961     Flags: destroy flags. */
962 zherczeg 1195 SLJIT_API_FUNC_ATTRIBUTE struct sljit_jump* sljit_emit_cmp(struct sljit_compiler *compiler, sljit_si type,
963     sljit_si src1, sljit_sw src1w,
964     sljit_si src2, sljit_sw src2w);
965 ph10 662
966 zherczeg 867 /* Basic floating point comparison. In most architectures it is implemented as
967     an SLJIT_FCMP operation (setting appropriate flags) followed by a
968     sljit_emit_jump. However some architectures (i.e: MIPS) may employ
969     special optimizations here. It is suggested to use this comparison form
970     when appropriate.
971 zherczeg 1149 type must be between SLJIT_C_FLOAT_EQUAL and SLJIT_C_FLOAT_ORDERED
972 zherczeg 1195 type can be combined (or'ed) with SLJIT_REWRITABLE_JUMP and SLJIT_SINGLE_OP
973 zherczeg 867 Flags: destroy flags.
974     Note: if either operand is NaN, the behaviour is undefined for
975     type <= SLJIT_C_FLOAT_LESS_EQUAL. */
976 zherczeg 1195 SLJIT_API_FUNC_ATTRIBUTE struct sljit_jump* sljit_emit_fcmp(struct sljit_compiler *compiler, sljit_si type,
977     sljit_si src1, sljit_sw src1w,
978     sljit_si src2, sljit_sw src2w);
979 zherczeg 867
980 ph10 662 /* Set the destination of the jump to this label. */
981 zherczeg 740 SLJIT_API_FUNC_ATTRIBUTE void sljit_set_label(struct sljit_jump *jump, struct sljit_label* label);
982 zherczeg 1460 /* Set the destination address of the jump to this label. */
983 zherczeg 740 SLJIT_API_FUNC_ATTRIBUTE void sljit_set_target(struct sljit_jump *jump, sljit_uw target);
984 ph10 662
985     /* Call function or jump anywhere. Both direct and indirect form
986     type must be between SLJIT_JUMP and SLJIT_CALL3
987     Direct form: set src to SLJIT_IMM() and srcw to the address
988     Indirect form: any other valid addressing mode
989     Flags: - (never set any flags) for unconditional jumps.
990     Flags: destroy all flags for calls. */
991 zherczeg 1195 SLJIT_API_FUNC_ATTRIBUTE sljit_si sljit_emit_ijump(struct sljit_compiler *compiler, sljit_si type, sljit_si src, sljit_sw srcw);
992 ph10 662
993 zherczeg 1209 /* Perform the operation using the conditional flags as the second argument.
994     Type must always be between SLJIT_C_EQUAL and SLJIT_C_FLOAT_ORDERED. The
995     value represented by the type is 1, if the condition represented by the type
996     is fulfilled, and 0 otherwise.
997    
998     If op == SLJIT_MOV, SLJIT_MOV_SI, SLJIT_MOV_UI:
999     Set dst to the value represented by the type (0 or 1).
1000     Src must be SLJIT_UNUSED, and srcw must be 0
1001 ph10 662 Flags: - (never set any flags)
1002 zherczeg 1209 If op == SLJIT_OR, op == SLJIT_AND, op == SLJIT_XOR
1003     Performs the binary operation using src as the first, and the value
1004     represented by type as the second argument.
1005     Important note: only dst=src and dstw=srcw is supported at the moment!
1006 zherczeg 1203 Flags: I | E | K
1007 zherczeg 1209 Note: sljit_emit_op_flags does nothing, if dst is SLJIT_UNUSED (regardless of op). */
1008     SLJIT_API_FUNC_ATTRIBUTE sljit_si sljit_emit_op_flags(struct sljit_compiler *compiler, sljit_si op,
1009     sljit_si dst, sljit_sw dstw,
1010     sljit_si src, sljit_sw srcw,
1011     sljit_si type);
1012 ph10 662
1013 zherczeg 1491 /* Copies the base address of SLJIT_SP + offset to dst.
1014 zherczeg 955 Flags: - (never set any flags) */
1015 zherczeg 1195 SLJIT_API_FUNC_ATTRIBUTE sljit_si sljit_get_local_base(struct sljit_compiler *compiler, sljit_si dst, sljit_sw dstw, sljit_sw offset);
1016 zherczeg 955
1017 ph10 662 /* The constant can be changed runtime (see: sljit_set_const)
1018     Flags: - (never set any flags) */
1019 zherczeg 1195 SLJIT_API_FUNC_ATTRIBUTE struct sljit_const* sljit_emit_const(struct sljit_compiler *compiler, sljit_si dst, sljit_sw dstw, sljit_sw init_value);
1020 ph10 662
1021     /* After the code generation the address for label, jump and const instructions
1022 zherczeg 1222 are computed. Since these structures are freed by sljit_free_compiler, the
1023 ph10 662 addresses must be preserved by the user program elsewere. */
1024     static SLJIT_INLINE sljit_uw sljit_get_label_addr(struct sljit_label *label) { return label->addr; }
1025     static SLJIT_INLINE sljit_uw sljit_get_jump_addr(struct sljit_jump *jump) { return jump->addr; }
1026     static SLJIT_INLINE sljit_uw sljit_get_const_addr(struct sljit_const *const_) { return const_->addr; }
1027    
1028     /* Only the address is required to rewrite the code. */
1029 zherczeg 740 SLJIT_API_FUNC_ATTRIBUTE void sljit_set_jump_addr(sljit_uw addr, sljit_uw new_addr);
1030 zherczeg 1195 SLJIT_API_FUNC_ATTRIBUTE void sljit_set_const(sljit_uw addr, sljit_sw new_constant);
1031 ph10 662
1032     /* --------------------------------------------------------------------- */
1033     /* Miscellaneous utility functions */
1034     /* --------------------------------------------------------------------- */
1035    
1036     #define SLJIT_MAJOR_VERSION 0
1037 zherczeg 1483 #define SLJIT_MINOR_VERSION 92
1038 ph10 662
1039 zherczeg 1222 /* Get the human readable name of the platform. Can be useful on platforms
1040 zherczeg 1216 like ARM, where ARM and Thumb2 functions can be mixed, and
1041     it is useful to know the type of the code generator. */
1042 zherczeg 740 SLJIT_API_FUNC_ATTRIBUTE SLJIT_CONST char* sljit_get_platform_name(void);
1043 ph10 662
1044 zherczeg 1222 /* Portable helper function to get an offset of a member. */
1045 zherczeg 1195 #define SLJIT_OFFSETOF(base, member) ((sljit_sw)(&((base*)0x10)->member) - 0x10)
1046 ph10 662
1047     #if (defined SLJIT_UTIL_GLOBAL_LOCK && SLJIT_UTIL_GLOBAL_LOCK)
1048     /* This global lock is useful to compile common functions. */
1049 zherczeg 740 SLJIT_API_FUNC_ATTRIBUTE void SLJIT_CALL sljit_grab_lock(void);
1050     SLJIT_API_FUNC_ATTRIBUTE void SLJIT_CALL sljit_release_lock(void);
1051 ph10 662 #endif
1052    
1053     #if (defined SLJIT_UTIL_STACK && SLJIT_UTIL_STACK)
1054    
1055     /* The sljit_stack is a utiliy feature of sljit, which allocates a
1056     writable memory region between base (inclusive) and limit (exclusive).
1057     Both base and limit is a pointer, and base is always <= than limit.
1058     This feature uses the "address space reserve" feature
1059     of modern operating systems. Basically we don't need to allocate a
1060     huge memory block in one step for the worst case, we can start with
1061     a smaller chunk and extend it later. Since the address space is
1062     reserved, the data never copied to other regions, thus it is safe
1063     to store pointers here. */
1064    
1065     /* Note: The base field is aligned to PAGE_SIZE bytes (usually 4k or more).
1066     Note: stack growing should not happen in small steps: 4k, 16k or even
1067     bigger growth is better.
1068     Note: this structure may not be supported by all operating systems.
1069     Some kind of fallback mechanism is suggested when SLJIT_UTIL_STACK
1070     is not defined. */
1071    
1072     struct sljit_stack {
1073     /* User data, anything can be stored here.
1074     Starting with the same value as base. */
1075     sljit_uw top;
1076     /* These members are read only. */
1077     sljit_uw base;
1078     sljit_uw limit;
1079     sljit_uw max_limit;
1080     };
1081    
1082     /* Returns NULL if unsuccessful.
1083     Note: limit and max_limit contains the size for stack allocation
1084     Note: the top field is initialized to base. */
1085 zherczeg 740 SLJIT_API_FUNC_ATTRIBUTE struct sljit_stack* SLJIT_CALL sljit_allocate_stack(sljit_uw limit, sljit_uw max_limit);
1086     SLJIT_API_FUNC_ATTRIBUTE void SLJIT_CALL sljit_free_stack(struct sljit_stack* stack);
1087 ph10 662
1088     /* Can be used to increase (allocate) or decrease (free) the memory area.
1089     Returns with a non-zero value if unsuccessful. If new_limit is greater than
1090     max_limit, it will fail. It is very easy to implement a stack data structure,
1091     since the growth ratio can be added to the current limit, and sljit_stack_resize
1092     will do all the necessary checks. The fields of the stack are not changed if
1093     sljit_stack_resize fails. */
1094 zherczeg 1195 SLJIT_API_FUNC_ATTRIBUTE sljit_sw SLJIT_CALL sljit_stack_resize(struct sljit_stack* stack, sljit_uw new_limit);
1095 ph10 662
1096     #endif /* (defined SLJIT_UTIL_STACK && SLJIT_UTIL_STACK) */
1097    
1098     #if !(defined SLJIT_INDIRECT_CALL && SLJIT_INDIRECT_CALL)
1099    
1100     /* Get the entry address of a given function. */
1101 zherczeg 1195 #define SLJIT_FUNC_OFFSET(func_name) ((sljit_sw)func_name)
1102 ph10 662
1103     #else /* !(defined SLJIT_INDIRECT_CALL && SLJIT_INDIRECT_CALL) */
1104    
1105     /* All JIT related code should be placed in the same context (library, binary, etc.). */
1106    
1107 zherczeg 1222 #define SLJIT_FUNC_OFFSET(func_name) (*(sljit_sw*)(void*)func_name)
1108 ph10 662
1109     /* For powerpc64, the function pointers point to a context descriptor. */
1110     struct sljit_function_context {
1111 zherczeg 1195 sljit_sw addr;
1112     sljit_sw r2;
1113     sljit_sw r11;
1114 ph10 662 };
1115    
1116     /* Fill the context arguments using the addr and the function.
1117     If func_ptr is NULL, it will not be set to the address of context
1118     If addr is NULL, the function address also comes from the func pointer. */
1119 zherczeg 1195 SLJIT_API_FUNC_ATTRIBUTE void sljit_set_function_context(void** func_ptr, struct sljit_function_context* context, sljit_sw addr, void* func);
1120 ph10 662
1121     #endif /* !(defined SLJIT_INDIRECT_CALL && SLJIT_INDIRECT_CALL) */
1122    
1123     #endif /* _SLJIT_LIR_H_ */

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12