1 /* A pure C API to enable client code to embed GCC as a JIT-compiler.
2 Copyright (C) 2013-2024 Free Software Foundation, Inc.
4 This file is part of GCC.
6 GCC is free software; you can redistribute it and/or modify it
7 under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3, or (at your option)
11 GCC is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GCC; see the file COPYING3. If not see
18 <http://www.gnu.org/licenses/>. */
27 #endif /* __cplusplus */
29 /**********************************************************************
31 **********************************************************************/
32 /* All structs within the API are opaque. */
34 /* A gcc_jit_context encapsulates the state of a compilation.
35 You can set up options on it, and add types, functions and code, using
38 Invoking gcc_jit_context_compile on it gives you a gcc_jit_result *
39 (or NULL), representing in-memory machine code.
41 You can call gcc_jit_context_compile repeatedly on one context, giving
42 multiple independent results.
44 Similarly, you can call gcc_jit_context_compile_to_file on a context
47 Eventually you can call gcc_jit_context_release to clean up the
48 context; any in-memory results created from it are still usable, and
49 should be cleaned up via gcc_jit_result_release. */
50 typedef struct gcc_jit_context gcc_jit_context
;
52 /* A gcc_jit_result encapsulates the result of an in-memory compilation. */
53 typedef struct gcc_jit_result gcc_jit_result
;
55 /* An object created within a context. Such objects are automatically
56 cleaned up when the context is released.
58 The class hierarchy looks like this:
64 +- gcc_jit_function_type
65 +- gcc_jit_vector_type
73 +- gcc_jit_extended_asm
75 typedef struct gcc_jit_object gcc_jit_object
;
77 /* A gcc_jit_location encapsulates a source code location, so that
78 you can (optionally) associate locations in your language with
79 statements in the JIT-compiled code, allowing the debugger to
80 single-step through your language.
82 Note that to do so, you also need to enable
83 GCC_JIT_BOOL_OPTION_DEBUGINFO
84 on the gcc_jit_context.
86 gcc_jit_location instances are optional; you can always pass
88 typedef struct gcc_jit_location gcc_jit_location
;
90 /* A gcc_jit_type encapsulates a type e.g. "int" or a "struct foo*". */
91 typedef struct gcc_jit_type gcc_jit_type
;
93 /* A gcc_jit_field encapsulates a field within a struct; it is used
94 when creating a struct type (using gcc_jit_context_new_struct_type).
95 Fields cannot be shared between structs. */
96 typedef struct gcc_jit_field gcc_jit_field
;
98 /* A gcc_jit_struct encapsulates a struct type, either one that we have
99 the layout for, or an opaque type. */
100 typedef struct gcc_jit_struct gcc_jit_struct
;
102 /* A gcc_jit_function_type encapsulates a function type. */
103 typedef struct gcc_jit_function_type gcc_jit_function_type
;
105 /* A gcc_jit_vector_type encapsulates a vector type. */
106 typedef struct gcc_jit_vector_type gcc_jit_vector_type
;
108 /* A gcc_jit_function encapsulates a function: either one that you're
109 creating yourself, or a reference to one that you're dynamically
110 linking to within the rest of the process. */
111 typedef struct gcc_jit_function gcc_jit_function
;
113 /* A gcc_jit_block encapsulates a "basic block" of statements within a
114 function (i.e. with one entry point and one exit point).
116 Every block within a function must be terminated with a conditional,
117 a branch, or a return.
119 The blocks within a function form a directed graph.
121 The entrypoint to the function is the first block created within
124 All of the blocks in a function must be reachable via some path from
127 It's OK to have more than one "return" from a function (i.e. multiple
128 blocks that terminate by returning). */
129 typedef struct gcc_jit_block gcc_jit_block
;
131 /* A gcc_jit_rvalue is an expression within your code, with some type. */
132 typedef struct gcc_jit_rvalue gcc_jit_rvalue
;
134 /* A gcc_jit_lvalue is a storage location within your code (e.g. a
135 variable, a parameter, etc). It is also a gcc_jit_rvalue; use
136 gcc_jit_lvalue_as_rvalue to cast. */
137 typedef struct gcc_jit_lvalue gcc_jit_lvalue
;
139 /* A gcc_jit_param is a function parameter, used when creating a
140 gcc_jit_function. It is also a gcc_jit_lvalue (and thus also an
141 rvalue); use gcc_jit_param_as_lvalue to convert. */
142 typedef struct gcc_jit_param gcc_jit_param
;
144 /* A gcc_jit_case is for use when building multiway branches via
145 gcc_jit_block_end_with_switch and represents a range of integer
146 values (or an individual integer value) together with an associated
147 destination block. */
148 typedef struct gcc_jit_case gcc_jit_case
;
150 /* A gcc_jit_extended_asm represents an assembly language statement,
151 analogous to an extended "asm" statement in GCC's C front-end: a series
152 of low-level instructions inside a function that convert inputs to
154 typedef struct gcc_jit_extended_asm gcc_jit_extended_asm
;
156 /* Acquire a JIT-compilation context. */
157 extern gcc_jit_context
*
158 gcc_jit_context_acquire (void);
160 /* Release the context. After this call, it's no longer valid to use
163 gcc_jit_context_release (gcc_jit_context
*ctxt
);
165 /* Options present in the initial release of libgccjit.
166 These were handled using enums. */
168 /* Options taking string values. */
169 enum gcc_jit_str_option
171 /* The name of the program, for use as a prefix when printing error
172 messages to stderr. If NULL, or default, "libgccjit.so" is used. */
173 GCC_JIT_STR_OPTION_PROGNAME
,
175 GCC_JIT_NUM_STR_OPTIONS
178 /* Options taking int values. */
179 enum gcc_jit_int_option
181 /* How much to optimize the code.
182 Valid values are 0-3, corresponding to GCC's command-line options
185 The default value is 0 (unoptimized). */
186 GCC_JIT_INT_OPTION_OPTIMIZATION_LEVEL
,
188 GCC_JIT_NUM_INT_OPTIONS
191 /* Options taking boolean values.
192 These all default to "false". */
193 enum gcc_jit_bool_option
195 /* If true, gcc_jit_context_compile will attempt to do the right
196 thing so that if you attach a debugger to the process, it will
197 be able to inspect variables and step through your code.
199 Note that you can't step through code unless you set up source
200 location information for the code (by creating and passing in
201 gcc_jit_location instances). */
202 GCC_JIT_BOOL_OPTION_DEBUGINFO
,
204 /* If true, gcc_jit_context_compile will dump its initial "tree"
205 representation of your code to stderr (before any
207 GCC_JIT_BOOL_OPTION_DUMP_INITIAL_TREE
,
209 /* If true, gcc_jit_context_compile will dump the "gimple"
210 representation of your code to stderr, before any optimizations
211 are performed. The dump resembles C code. */
212 GCC_JIT_BOOL_OPTION_DUMP_INITIAL_GIMPLE
,
214 /* If true, gcc_jit_context_compile will dump the final
215 generated code to stderr, in the form of assembly language. */
216 GCC_JIT_BOOL_OPTION_DUMP_GENERATED_CODE
,
218 /* If true, gcc_jit_context_compile will print information to stderr
219 on the actions it is performing, followed by a profile showing
220 the time taken and memory usage of each phase.
222 GCC_JIT_BOOL_OPTION_DUMP_SUMMARY
,
224 /* If true, gcc_jit_context_compile will dump copious
225 amount of information on what it's doing to various
226 files within a temporary directory. Use
227 GCC_JIT_BOOL_OPTION_KEEP_INTERMEDIATES (see below) to
228 see the results. The files are intended to be human-readable,
229 but the exact files and their formats are subject to change.
231 GCC_JIT_BOOL_OPTION_DUMP_EVERYTHING
,
233 /* If true, libgccjit will aggressively run its garbage collector, to
234 shake out bugs (greatly slowing down the compile). This is likely
235 to only be of interest to developers *of* the library. It is
236 used when running the selftest suite. */
237 GCC_JIT_BOOL_OPTION_SELFCHECK_GC
,
239 /* If true, gcc_jit_context_release will not clean up
240 intermediate files written to the filesystem, and will display
241 their location on stderr. */
242 GCC_JIT_BOOL_OPTION_KEEP_INTERMEDIATES
,
244 GCC_JIT_NUM_BOOL_OPTIONS
247 /* Set a string option on the given context.
249 The context takes a copy of the string, so the
250 (const char *) buffer is not needed anymore after the call
253 gcc_jit_context_set_str_option (gcc_jit_context
*ctxt
,
254 enum gcc_jit_str_option opt
,
257 /* Set an int option on the given context. */
259 gcc_jit_context_set_int_option (gcc_jit_context
*ctxt
,
260 enum gcc_jit_int_option opt
,
263 /* Set a boolean option on the given context.
265 Zero is "false" (the default), non-zero is "true". */
267 gcc_jit_context_set_bool_option (gcc_jit_context
*ctxt
,
268 enum gcc_jit_bool_option opt
,
271 /* Options added after the initial release of libgccjit.
272 These are handled by providing an entrypoint per option,
273 rather than by extending the enum gcc_jit_*_option,
274 so that client code that use these new options can be identified
275 from binary metadata. */
277 /* By default, libgccjit will issue an error about unreachable blocks
280 This option can be used to disable that error.
282 This entrypoint was added in LIBGCCJIT_ABI_2; you can test for
284 #ifdef LIBGCCJIT_HAVE_gcc_jit_context_set_bool_allow_unreachable_blocks
288 gcc_jit_context_set_bool_allow_unreachable_blocks (gcc_jit_context
*ctxt
,
291 /* Pre-canned feature macro to indicate the presence of
292 gcc_jit_context_set_bool_allow_unreachable_blocks. This can be
293 tested for with #ifdef. */
294 #define LIBGCCJIT_HAVE_gcc_jit_context_set_bool_allow_unreachable_blocks
296 /* By default, libgccjit will print errors to stderr.
298 This option can be used to disable the printing.
300 This entrypoint was added in LIBGCCJIT_ABI_23; you can test for
302 #ifdef LIBGCCJIT_HAVE_gcc_jit_context_set_bool_print_errors_to_stderr
306 gcc_jit_context_set_bool_print_errors_to_stderr (gcc_jit_context
*ctxt
,
309 /* Pre-canned feature macro to indicate the presence of
310 gcc_jit_context_set_bool_print_errors_to_stderr. This can be
311 tested for with #ifdef. */
312 #define LIBGCCJIT_HAVE_gcc_jit_context_set_bool_print_errors_to_stderr
314 /* Implementation detail:
315 libgccjit internally generates assembler, and uses "driver" code
316 for converting it to other formats (e.g. shared libraries).
318 By default, libgccjit will use an embedded copy of the driver
321 This option can be used to instead invoke an external driver executable
324 This entrypoint was added in LIBGCCJIT_ABI_5; you can test for
326 #ifdef LIBGCCJIT_HAVE_gcc_jit_context_set_bool_use_external_driver
330 gcc_jit_context_set_bool_use_external_driver (gcc_jit_context
*ctxt
,
333 /* Pre-canned feature macro to indicate the presence of
334 gcc_jit_context_set_bool_use_external_driver. This can be
335 tested for with #ifdef. */
336 #define LIBGCCJIT_HAVE_gcc_jit_context_set_bool_use_external_driver
338 /* Add an arbitrary gcc command-line option to the context.
339 The context takes a copy of the string, so the
340 (const char *) optname is not needed anymore after the call
343 Note that only some options are likely to be meaningful; there is no
344 "frontend" within libgccjit, so typically only those affecting
345 optimization and code-generation are likely to be useful.
347 This entrypoint was added in LIBGCCJIT_ABI_1; you can test for
349 #ifdef LIBGCCJIT_HAVE_gcc_jit_context_add_command_line_option
353 gcc_jit_context_add_command_line_option (gcc_jit_context
*ctxt
,
354 const char *optname
);
356 /* Pre-canned feature-test macro for detecting the presence of
357 gcc_jit_context_add_command_line_option within libgccjit.h. */
359 #define LIBGCCJIT_HAVE_gcc_jit_context_add_command_line_option
361 /* Add an arbitrary gcc driver option to the context.
362 The context takes a copy of the string, so the
363 (const char *) optname is not needed anymore after the call
366 Note that only some options are likely to be meaningful; there is no
367 "frontend" within libgccjit, so typically only those affecting
368 assembler and linker are likely to be useful.
370 This entrypoint was added in LIBGCCJIT_ABI_11; you can test for
372 #ifdef LIBGCCJIT_HAVE_gcc_jit_context_add_driver_option
375 gcc_jit_context_add_driver_option (gcc_jit_context
*ctxt
,
376 const char *optname
);
378 /* Pre-canned feature-test macro for detecting the presence of
379 gcc_jit_context_add_driver_option within libgccjit.h. */
381 #define LIBGCCJIT_HAVE_gcc_jit_context_add_driver_option
383 /* Compile the context to in-memory machine code.
385 This can be called more that once on a given context,
386 although any errors that occur will block further compilation. */
388 extern gcc_jit_result
*
389 gcc_jit_context_compile (gcc_jit_context
*ctxt
);
391 /* Kinds of ahead-of-time compilation, for use with
392 gcc_jit_context_compile_to_file. */
394 enum gcc_jit_output_kind
396 /* Compile the context to an assembler file. */
397 GCC_JIT_OUTPUT_KIND_ASSEMBLER
,
399 /* Compile the context to an object file. */
400 GCC_JIT_OUTPUT_KIND_OBJECT_FILE
,
402 /* Compile the context to a dynamic library. */
403 GCC_JIT_OUTPUT_KIND_DYNAMIC_LIBRARY
,
405 /* Compile the context to an executable. */
406 GCC_JIT_OUTPUT_KIND_EXECUTABLE
409 /* Compile the context to a file of the given kind.
411 This can be called more that once on a given context,
412 although any errors that occur will block further compilation. */
415 gcc_jit_context_compile_to_file (gcc_jit_context
*ctxt
,
416 enum gcc_jit_output_kind output_kind
,
417 const char *output_path
);
419 /* To help with debugging: dump a C-like representation to the given path,
420 describing what's been set up on the context.
422 If "update_locations" is true, then also set up gcc_jit_location
423 information throughout the context, pointing at the dump file as if it
424 were a source file. This may be of use in conjunction with
425 GCC_JIT_BOOL_OPTION_DEBUGINFO to allow stepping through the code in a
428 gcc_jit_context_dump_to_file (gcc_jit_context
*ctxt
,
430 int update_locations
);
432 /* To help with debugging; enable ongoing logging of the context's
433 activity to the given FILE *.
435 The caller remains responsible for closing "logfile".
437 Params "flags" and "verbosity" are reserved for future use, and
438 must both be 0 for now. */
440 gcc_jit_context_set_logfile (gcc_jit_context
*ctxt
,
445 /* To be called after any API call, this gives the first error message
446 that occurred on the context.
448 The returned string is valid for the rest of the lifetime of the
451 If no errors occurred, this will be NULL. */
453 gcc_jit_context_get_first_error (gcc_jit_context
*ctxt
);
455 /* To be called after any API call, this gives the last error message
456 that occurred on the context.
458 If no errors occurred, this will be NULL.
460 If non-NULL, the returned string is only guaranteed to be valid until
461 the next call to libgccjit relating to this context. */
463 gcc_jit_context_get_last_error (gcc_jit_context
*ctxt
);
465 /* Locate a given function within the built machine code.
466 This will need to be cast to a function pointer of the
467 correct type before it can be called. */
469 gcc_jit_result_get_code (gcc_jit_result
*result
,
470 const char *funcname
);
472 /* Locate a given global within the built machine code.
473 It must have been created using GCC_JIT_GLOBAL_EXPORTED.
474 This is a ptr to the global, so e.g. for an int this is an int *. */
476 gcc_jit_result_get_global (gcc_jit_result
*result
,
479 /* Once we're done with the code, this unloads the built .so file.
480 This cleans up the result; after calling this, it's no longer
481 valid to use the result. */
483 gcc_jit_result_release (gcc_jit_result
*result
);
486 /**********************************************************************
487 Functions for creating "contextual" objects.
489 All objects created by these functions share the lifetime of the context
490 they are created within, and are automatically cleaned up for you when
491 you call gcc_jit_context_release on the context.
493 Note that this means you can't use references to them after you've
494 released their context.
496 All (const char *) string arguments passed to these functions are
497 copied, so you don't need to keep them around.
499 You create code by adding a sequence of statements to blocks.
500 **********************************************************************/
502 /**********************************************************************
503 The base class of "contextual" object.
504 **********************************************************************/
505 /* Which context is "obj" within? */
506 extern gcc_jit_context
*
507 gcc_jit_object_get_context (gcc_jit_object
*obj
);
509 /* Get a human-readable description of this object.
510 The string buffer is created the first time this is called on a given
511 object, and persists until the object's context is released. */
513 gcc_jit_object_get_debug_string (gcc_jit_object
*obj
);
515 /**********************************************************************
516 Debugging information.
517 **********************************************************************/
519 /* Creating source code locations for use by the debugger.
520 Line and column numbers are 1-based. */
521 extern gcc_jit_location
*
522 gcc_jit_context_new_location (gcc_jit_context
*ctxt
,
523 const char *filename
,
527 /* Upcasting from location to object. */
528 extern gcc_jit_object
*
529 gcc_jit_location_as_object (gcc_jit_location
*loc
);
532 /**********************************************************************
534 **********************************************************************/
536 /* Upcasting from type to object. */
537 extern gcc_jit_object
*
538 gcc_jit_type_as_object (gcc_jit_type
*type
);
540 /* Access to specific types. */
543 /* C's "void" type. */
547 GCC_JIT_TYPE_VOID_PTR
,
549 /* C++'s bool type; also C99's "_Bool" type, aka "bool" if using
553 /* Various integer types. */
555 /* C's "char" (of some signedness) and the variants where the
556 signedness is specified. */
558 GCC_JIT_TYPE_SIGNED_CHAR
,
559 GCC_JIT_TYPE_UNSIGNED_CHAR
,
561 /* C's "short" and "unsigned short". */
562 GCC_JIT_TYPE_SHORT
, /* signed */
563 GCC_JIT_TYPE_UNSIGNED_SHORT
,
565 /* C's "int" and "unsigned int". */
566 GCC_JIT_TYPE_INT
, /* signed */
567 GCC_JIT_TYPE_UNSIGNED_INT
,
569 /* C's "long" and "unsigned long". */
570 GCC_JIT_TYPE_LONG
, /* signed */
571 GCC_JIT_TYPE_UNSIGNED_LONG
,
573 /* C99's "long long" and "unsigned long long". */
574 GCC_JIT_TYPE_LONG_LONG
, /* signed */
575 GCC_JIT_TYPE_UNSIGNED_LONG_LONG
,
577 /* Floating-point types */
581 GCC_JIT_TYPE_LONG_DOUBLE
,
583 /* C type: (const char *). */
584 GCC_JIT_TYPE_CONST_CHAR_PTR
,
586 /* The C "size_t" type. */
589 /* C type: (FILE *) */
590 GCC_JIT_TYPE_FILE_PTR
,
592 /* Complex numbers. */
593 GCC_JIT_TYPE_COMPLEX_FLOAT
,
594 GCC_JIT_TYPE_COMPLEX_DOUBLE
,
595 GCC_JIT_TYPE_COMPLEX_LONG_DOUBLE
,
597 /* Sized integer types. */
598 GCC_JIT_TYPE_UINT8_T
,
599 GCC_JIT_TYPE_UINT16_T
,
600 GCC_JIT_TYPE_UINT32_T
,
601 GCC_JIT_TYPE_UINT64_T
,
602 GCC_JIT_TYPE_UINT128_T
,
604 GCC_JIT_TYPE_INT16_T
,
605 GCC_JIT_TYPE_INT32_T
,
606 GCC_JIT_TYPE_INT64_T
,
607 GCC_JIT_TYPE_INT128_T
610 extern gcc_jit_type
*
611 gcc_jit_context_get_type (gcc_jit_context
*ctxt
,
612 enum gcc_jit_types type_
);
614 /* Get the integer type of the given size and signedness. */
615 extern gcc_jit_type
*
616 gcc_jit_context_get_int_type (gcc_jit_context
*ctxt
,
617 int num_bytes
, int is_signed
);
619 /* Constructing new types. */
621 /* Given type "T", get type "T*". */
622 extern gcc_jit_type
*
623 gcc_jit_type_get_pointer (gcc_jit_type
*type
);
625 /* Given type "T", get type "const T". */
626 extern gcc_jit_type
*
627 gcc_jit_type_get_const (gcc_jit_type
*type
);
629 /* Given type "T", get type "volatile T". */
630 extern gcc_jit_type
*
631 gcc_jit_type_get_volatile (gcc_jit_type
*type
);
633 #define LIBGCCJIT_HAVE_gcc_jit_type_get_restrict
635 /* Given type "T", get type "restrict T".
636 This API entrypoint was added in LIBGCCJIT_ABI_25; you can test for its
638 #ifdef LIBGCCJIT_HAVE_gcc_jit_type_get_restrict */
639 extern gcc_jit_type
*
640 gcc_jit_type_get_restrict (gcc_jit_type
*type
);
642 #define LIBGCCJIT_HAVE_SIZED_INTEGERS
644 /* Given types LTYPE and RTYPE, return non-zero if they are compatible.
645 This API entrypoint was added in LIBGCCJIT_ABI_20; you can test for its
647 #ifdef LIBGCCJIT_HAVE_SIZED_INTEGERS */
649 gcc_jit_compatible_types (gcc_jit_type
*ltype
,
650 gcc_jit_type
*rtype
);
652 /* Given type "T", get its size.
653 This API entrypoint was added in LIBGCCJIT_ABI_20; you can test for its
655 #ifdef LIBGCCJIT_HAVE_SIZED_INTEGERS */
657 gcc_jit_type_get_size (gcc_jit_type
*type
);
659 /* Given type "T", get type "T[N]" (for a constant N). */
660 extern gcc_jit_type
*
661 gcc_jit_context_new_array_type (gcc_jit_context
*ctxt
,
662 gcc_jit_location
*loc
,
663 gcc_jit_type
*element_type
,
666 /* Struct-handling. */
668 /* Create a field, for use within a struct or union. */
669 extern gcc_jit_field
*
670 gcc_jit_context_new_field (gcc_jit_context
*ctxt
,
671 gcc_jit_location
*loc
,
675 #define LIBGCCJIT_HAVE_gcc_jit_context_new_bitfield
677 /* Create a bit field, for use within a struct or union.
679 This API entrypoint was added in LIBGCCJIT_ABI_12; you can test for its
681 #ifdef LIBGCCJIT_HAVE_gcc_jit_context_new_bitfield
683 extern gcc_jit_field
*
684 gcc_jit_context_new_bitfield (gcc_jit_context
*ctxt
,
685 gcc_jit_location
*loc
,
690 /* Upcasting from field to object. */
691 extern gcc_jit_object
*
692 gcc_jit_field_as_object (gcc_jit_field
*field
);
694 /* Create a struct type from an array of fields. */
695 extern gcc_jit_struct
*
696 gcc_jit_context_new_struct_type (gcc_jit_context
*ctxt
,
697 gcc_jit_location
*loc
,
700 gcc_jit_field
**fields
);
702 /* Create an opaque struct type. */
703 extern gcc_jit_struct
*
704 gcc_jit_context_new_opaque_struct (gcc_jit_context
*ctxt
,
705 gcc_jit_location
*loc
,
708 /* Upcast a struct to a type. */
709 extern gcc_jit_type
*
710 gcc_jit_struct_as_type (gcc_jit_struct
*struct_type
);
712 /* Populating the fields of a formerly-opaque struct type.
713 This can only be called once on a given struct type. */
715 gcc_jit_struct_set_fields (gcc_jit_struct
*struct_type
,
716 gcc_jit_location
*loc
,
718 gcc_jit_field
**fields
);
720 /* Get a field by index. */
721 extern gcc_jit_field
*
722 gcc_jit_struct_get_field (gcc_jit_struct
*struct_type
,
725 /* Get the number of fields. */
727 gcc_jit_struct_get_field_count (gcc_jit_struct
*struct_type
);
729 /* Unions work similarly to structs. */
730 extern gcc_jit_type
*
731 gcc_jit_context_new_union_type (gcc_jit_context
*ctxt
,
732 gcc_jit_location
*loc
,
735 gcc_jit_field
**fields
);
737 /* Function pointers. */
739 extern gcc_jit_type
*
740 gcc_jit_context_new_function_ptr_type (gcc_jit_context
*ctxt
,
741 gcc_jit_location
*loc
,
742 gcc_jit_type
*return_type
,
744 gcc_jit_type
**param_types
,
747 /**********************************************************************
748 Constructing functions.
749 **********************************************************************/
750 /* Create a function param. */
751 extern gcc_jit_param
*
752 gcc_jit_context_new_param (gcc_jit_context
*ctxt
,
753 gcc_jit_location
*loc
,
757 /* Upcasting from param to object. */
758 extern gcc_jit_object
*
759 gcc_jit_param_as_object (gcc_jit_param
*param
);
761 /* Upcasting from param to lvalue. */
762 extern gcc_jit_lvalue
*
763 gcc_jit_param_as_lvalue (gcc_jit_param
*param
);
765 /* Upcasting from param to rvalue. */
766 extern gcc_jit_rvalue
*
767 gcc_jit_param_as_rvalue (gcc_jit_param
*param
);
769 /* Kinds of function. */
770 enum gcc_jit_function_kind
772 /* Function is defined by the client code and visible
773 by name outside of the JIT. */
774 GCC_JIT_FUNCTION_EXPORTED
,
776 /* Function is defined by the client code, but is invisible
777 outside of the JIT. Analogous to a "static" function. */
778 GCC_JIT_FUNCTION_INTERNAL
,
780 /* Function is not defined by the client code; we're merely
781 referring to it. Analogous to using an "extern" function from a
783 GCC_JIT_FUNCTION_IMPORTED
,
785 /* Function is only ever inlined into other functions, and is
786 invisible outside of the JIT.
788 Analogous to prefixing with "inline" and adding
789 __attribute__((always_inline)).
791 Inlining will only occur when the optimization level is
792 above 0; when optimization is off, this is essentially the
793 same as GCC_JIT_FUNCTION_INTERNAL. */
794 GCC_JIT_FUNCTION_ALWAYS_INLINE
797 /* Thread local storage model. */
798 enum gcc_jit_tls_model
800 GCC_JIT_TLS_MODEL_NONE
,
801 GCC_JIT_TLS_MODEL_GLOBAL_DYNAMIC
,
802 GCC_JIT_TLS_MODEL_LOCAL_DYNAMIC
,
803 GCC_JIT_TLS_MODEL_INITIAL_EXEC
,
804 GCC_JIT_TLS_MODEL_LOCAL_EXEC
,
807 /* Create a function. */
808 extern gcc_jit_function
*
809 gcc_jit_context_new_function (gcc_jit_context
*ctxt
,
810 gcc_jit_location
*loc
,
811 enum gcc_jit_function_kind kind
,
812 gcc_jit_type
*return_type
,
815 gcc_jit_param
**params
,
818 /* Create a reference to a builtin function (sometimes called
819 intrinsic functions). */
820 extern gcc_jit_function
*
821 gcc_jit_context_get_builtin_function (gcc_jit_context
*ctxt
,
824 /* Upcasting from function to object. */
825 extern gcc_jit_object
*
826 gcc_jit_function_as_object (gcc_jit_function
*func
);
828 /* Get a specific param of a function by index. */
829 extern gcc_jit_param
*
830 gcc_jit_function_get_param (gcc_jit_function
*func
, int index
);
832 /* Emit the function in graphviz format. */
834 gcc_jit_function_dump_to_dot (gcc_jit_function
*func
,
839 The name can be NULL, or you can give it a meaningful name, which
840 may show up in dumps of the internal representation, and in error
842 extern gcc_jit_block
*
843 gcc_jit_function_new_block (gcc_jit_function
*func
,
846 /* Upcasting from block to object. */
847 extern gcc_jit_object
*
848 gcc_jit_block_as_object (gcc_jit_block
*block
);
850 /* Which function is this block within? */
851 extern gcc_jit_function
*
852 gcc_jit_block_get_function (gcc_jit_block
*block
);
854 /**********************************************************************
855 lvalues, rvalues and expressions.
856 **********************************************************************/
857 enum gcc_jit_global_kind
859 /* Global is defined by the client code and visible
860 by name outside of this JIT context via gcc_jit_result_get_global. */
861 GCC_JIT_GLOBAL_EXPORTED
,
863 /* Global is defined by the client code, but is invisible
864 outside of this JIT context. Analogous to a "static" global. */
865 GCC_JIT_GLOBAL_INTERNAL
,
867 /* Global is not defined by the client code; we're merely
868 referring to it. Analogous to using an "extern" global from a
870 GCC_JIT_GLOBAL_IMPORTED
873 extern gcc_jit_lvalue
*
874 gcc_jit_context_new_global (gcc_jit_context
*ctxt
,
875 gcc_jit_location
*loc
,
876 enum gcc_jit_global_kind kind
,
880 #define LIBGCCJIT_HAVE_CTORS
882 /* Create a constructor for a struct as an rvalue.
884 Returns NULL on error. The two parameter arrays are copied and
885 do not have to outlive the context.
887 `type` specifies what the constructor will build and has to be
890 `num_values` specifies the number of elements in `values`.
892 `fields` need to have the same length as `values`, or be NULL.
894 If `fields` is null, the values are applied in definition order.
896 Otherwise, each field in `fields` specifies which field in the struct to
897 set to the corresponding value in `values`. `fields` and `values`
900 Each value has to have the same unqualified type as the field
903 A NULL value element in `values` is a shorthand for zero initialization
904 of the corresponding field.
906 The fields in `fields` have to be in definition order, but there
907 can be gaps. Any field in the struct that is not specified in
908 `fields` will be zeroed.
910 The fields in `fields` need to be the same objects that were used
911 to create the struct.
913 If `num_values` is 0, the array parameters will be
914 ignored and zero initialization will be used.
916 The constructor rvalue can be used for assignment to locals.
917 It can be used to initialize global variables with
918 gcc_jit_global_set_initializer_rvalue. It can also be used as a
919 temporary value for function calls and return values.
921 The constructor can contain nested constructors.
923 This entrypoint was added in LIBGCCJIT_ABI_19; you can test for its
925 #ifdef LIBGCCJIT_HAVE_CTORS
928 extern gcc_jit_rvalue
*
929 gcc_jit_context_new_struct_constructor (gcc_jit_context
*ctxt
,
930 gcc_jit_location
*loc
,
933 gcc_jit_field
**fields
,
934 gcc_jit_rvalue
**values
);
936 /* Create a constructor for a union as an rvalue.
938 Returns NULL on error.
940 `type` specifies what the constructor will build and has to be
943 `field` specifies which field to set. If it is NULL, the first
944 field in the union will be set. `field` need to be the same
945 object that were used to create the union.
947 `value` specifies what value to set the corresponding field to.
948 If `value` is NULL, zero initialization will be used.
950 Each value has to have the same unqualified type as the field
953 `field` need to be the same objects that were used
956 The constructor rvalue can be used for assignment to locals.
957 It can be used to initialize global variables with
958 gcc_jit_global_set_initializer_rvalue. It can also be used as a
959 temporary value for function calls and return values.
961 The constructor can contain nested constructors.
963 This entrypoint was added in LIBGCCJIT_ABI_19; you can test for its
965 #ifdef LIBGCCJIT_HAVE_CTORS
968 extern gcc_jit_rvalue
*
969 gcc_jit_context_new_union_constructor (gcc_jit_context
*ctxt
,
970 gcc_jit_location
*loc
,
972 gcc_jit_field
*field
,
973 gcc_jit_rvalue
*value
);
975 /* Create a constructor for an array as an rvalue.
977 Returns NULL on error. `values` are copied and
978 do not have to outlive the context.
980 `type` specifies what the constructor will build and has to be
983 `num_values` specifies the number of elements in `values` and
984 it can't have more elements than the array type.
986 Each value in `values` sets the corresponding value in the array.
987 If the array type itself has more elements than `values`, the
988 left-over elements will be zeroed.
990 Each value in `values` need to be the same unqualified type as the
991 array type's element type.
993 If `num_values` is 0, the `values` parameter will be
994 ignored and zero initialization will be used.
996 Note that a string literal rvalue can't be used to construct a char
997 array. It needs one rvalue for each char.
999 This entrypoint was added in LIBGCCJIT_ABI_19; you can test for its
1001 #ifdef LIBGCCJIT_HAVE_CTORS
1004 extern gcc_jit_rvalue
*
1005 gcc_jit_context_new_array_constructor (gcc_jit_context
*ctxt
,
1006 gcc_jit_location
*loc
,
1009 gcc_jit_rvalue
**values
);
1011 /* Set the initial value of a global of any type with an rvalue.
1013 The rvalue needs to be a constant expression, e.g. no function calls.
1015 The global can't have the 'kind' GCC_JIT_GLOBAL_IMPORTED.
1017 Use together with gcc_jit_context_new_constructor () to
1018 initialize structs, unions and arrays.
1020 On success, returns the 'global' parameter unchanged. Otherwise, NULL.
1022 'values' is copied and does not have to outlive the context.
1024 This entrypoint was added in LIBGCCJIT_ABI_19; you can test for its
1026 #ifdef LIBGCCJIT_HAVE_CTORS
1029 extern gcc_jit_lvalue
*
1030 gcc_jit_global_set_initializer_rvalue (gcc_jit_lvalue
*global
,
1031 gcc_jit_rvalue
*init_value
);
1033 #define LIBGCCJIT_HAVE_gcc_jit_global_set_initializer
1035 /* Set an initial value for a global, which must be an array of
1036 integral type. Return the global itself.
1038 This API entrypoint was added in LIBGCCJIT_ABI_14; you can test for its
1040 #ifdef LIBGCCJIT_HAVE_gcc_jit_global_set_initializer
1043 extern gcc_jit_lvalue
*
1044 gcc_jit_global_set_initializer (gcc_jit_lvalue
*global
,
1049 extern gcc_jit_object
*
1050 gcc_jit_lvalue_as_object (gcc_jit_lvalue
*lvalue
);
1052 extern gcc_jit_rvalue
*
1053 gcc_jit_lvalue_as_rvalue (gcc_jit_lvalue
*lvalue
);
1055 extern gcc_jit_object
*
1056 gcc_jit_rvalue_as_object (gcc_jit_rvalue
*rvalue
);
1058 extern gcc_jit_type
*
1059 gcc_jit_rvalue_get_type (gcc_jit_rvalue
*rvalue
);
1061 /* Integer constants. */
1062 extern gcc_jit_rvalue
*
1063 gcc_jit_context_new_rvalue_from_int (gcc_jit_context
*ctxt
,
1064 gcc_jit_type
*numeric_type
,
1067 extern gcc_jit_rvalue
*
1068 gcc_jit_context_new_rvalue_from_long (gcc_jit_context
*ctxt
,
1069 gcc_jit_type
*numeric_type
,
1072 extern gcc_jit_rvalue
*
1073 gcc_jit_context_zero (gcc_jit_context
*ctxt
,
1074 gcc_jit_type
*numeric_type
);
1076 extern gcc_jit_rvalue
*
1077 gcc_jit_context_one (gcc_jit_context
*ctxt
,
1078 gcc_jit_type
*numeric_type
);
1080 /* Floating-point constants. */
1081 extern gcc_jit_rvalue
*
1082 gcc_jit_context_new_rvalue_from_double (gcc_jit_context
*ctxt
,
1083 gcc_jit_type
*numeric_type
,
1087 extern gcc_jit_rvalue
*
1088 gcc_jit_context_new_rvalue_from_ptr (gcc_jit_context
*ctxt
,
1089 gcc_jit_type
*pointer_type
,
1092 extern gcc_jit_rvalue
*
1093 gcc_jit_context_null (gcc_jit_context
*ctxt
,
1094 gcc_jit_type
*pointer_type
);
1096 /* String literals. */
1097 extern gcc_jit_rvalue
*
1098 gcc_jit_context_new_string_literal (gcc_jit_context
*ctxt
,
1101 enum gcc_jit_unary_op
1103 /* Negate an arithmetic value; analogous to:
1106 GCC_JIT_UNARY_OP_MINUS
,
1108 /* Bitwise negation of an integer value (one's complement); analogous
1112 GCC_JIT_UNARY_OP_BITWISE_NEGATE
,
1114 /* Logical negation of an arithmetic or pointer value; analogous to:
1117 GCC_JIT_UNARY_OP_LOGICAL_NEGATE
,
1119 /* Absolute value of an arithmetic expression; analogous to:
1122 GCC_JIT_UNARY_OP_ABS
1126 extern gcc_jit_rvalue
*
1127 gcc_jit_context_new_unary_op (gcc_jit_context
*ctxt
,
1128 gcc_jit_location
*loc
,
1129 enum gcc_jit_unary_op op
,
1130 gcc_jit_type
*result_type
,
1131 gcc_jit_rvalue
*rvalue
);
1133 enum gcc_jit_binary_op
1135 /* Addition of arithmetic values; analogous to:
1138 For pointer addition, use gcc_jit_context_new_array_access. */
1139 GCC_JIT_BINARY_OP_PLUS
,
1141 /* Subtraction of arithmetic values; analogous to:
1144 GCC_JIT_BINARY_OP_MINUS
,
1146 /* Multiplication of a pair of arithmetic values; analogous to:
1149 GCC_JIT_BINARY_OP_MULT
,
1151 /* Quotient of division of arithmetic values; analogous to:
1154 The result type affects the kind of division: if the result type is
1155 integer-based, then the result is truncated towards zero, whereas
1156 a floating-point result type indicates floating-point division. */
1157 GCC_JIT_BINARY_OP_DIVIDE
,
1159 /* Remainder of division of arithmetic values; analogous to:
1162 GCC_JIT_BINARY_OP_MODULO
,
1164 /* Bitwise AND; analogous to:
1167 GCC_JIT_BINARY_OP_BITWISE_AND
,
1169 /* Bitwise exclusive OR; analogous to:
1172 GCC_JIT_BINARY_OP_BITWISE_XOR
,
1174 /* Bitwise inclusive OR; analogous to:
1177 GCC_JIT_BINARY_OP_BITWISE_OR
,
1179 /* Logical AND; analogous to:
1180 (EXPR_A) && (EXPR_B)
1182 GCC_JIT_BINARY_OP_LOGICAL_AND
,
1184 /* Logical OR; analogous to:
1185 (EXPR_A) || (EXPR_B)
1187 GCC_JIT_BINARY_OP_LOGICAL_OR
,
1189 /* Left shift; analogous to:
1190 (EXPR_A) << (EXPR_B)
1192 GCC_JIT_BINARY_OP_LSHIFT
,
1194 /* Right shift; analogous to:
1195 (EXPR_A) >> (EXPR_B)
1197 GCC_JIT_BINARY_OP_RSHIFT
1200 extern gcc_jit_rvalue
*
1201 gcc_jit_context_new_binary_op (gcc_jit_context
*ctxt
,
1202 gcc_jit_location
*loc
,
1203 enum gcc_jit_binary_op op
,
1204 gcc_jit_type
*result_type
,
1205 gcc_jit_rvalue
*a
, gcc_jit_rvalue
*b
);
1207 /* (Comparisons are treated as separate from "binary_op" to save
1208 you having to specify the result_type). */
1210 enum gcc_jit_comparison
1212 /* (EXPR_A) == (EXPR_B). */
1213 GCC_JIT_COMPARISON_EQ
,
1215 /* (EXPR_A) != (EXPR_B). */
1216 GCC_JIT_COMPARISON_NE
,
1218 /* (EXPR_A) < (EXPR_B). */
1219 GCC_JIT_COMPARISON_LT
,
1221 /* (EXPR_A) <=(EXPR_B). */
1222 GCC_JIT_COMPARISON_LE
,
1224 /* (EXPR_A) > (EXPR_B). */
1225 GCC_JIT_COMPARISON_GT
,
1227 /* (EXPR_A) >= (EXPR_B). */
1228 GCC_JIT_COMPARISON_GE
1231 extern gcc_jit_rvalue
*
1232 gcc_jit_context_new_comparison (gcc_jit_context
*ctxt
,
1233 gcc_jit_location
*loc
,
1234 enum gcc_jit_comparison op
,
1235 gcc_jit_rvalue
*a
, gcc_jit_rvalue
*b
);
1237 /* Function calls. */
1239 /* Call of a specific function. */
1240 extern gcc_jit_rvalue
*
1241 gcc_jit_context_new_call (gcc_jit_context
*ctxt
,
1242 gcc_jit_location
*loc
,
1243 gcc_jit_function
*func
,
1244 int numargs
, gcc_jit_rvalue
**args
);
1246 /* Call through a function pointer. */
1247 extern gcc_jit_rvalue
*
1248 gcc_jit_context_new_call_through_ptr (gcc_jit_context
*ctxt
,
1249 gcc_jit_location
*loc
,
1250 gcc_jit_rvalue
*fn_ptr
,
1251 int numargs
, gcc_jit_rvalue
**args
);
1255 Currently only a limited set of conversions are possible:
1258 extern gcc_jit_rvalue
*
1259 gcc_jit_context_new_cast (gcc_jit_context
*ctxt
,
1260 gcc_jit_location
*loc
,
1261 gcc_jit_rvalue
*rvalue
,
1262 gcc_jit_type
*type
);
1264 #define LIBGCCJIT_HAVE_gcc_jit_context_new_bitcast
1266 /* Reinterpret a value as another type.
1268 The types must be of the same size.
1270 This API entrypoint was added in LIBGCCJIT_ABI_21; you can test for its
1272 #ifdef LIBGCCJIT_HAVE_gcc_jit_context_new_bitcast */
1273 extern gcc_jit_rvalue
*
1274 gcc_jit_context_new_bitcast (gcc_jit_context
*ctxt
,
1275 gcc_jit_location
*loc
,
1276 gcc_jit_rvalue
*rvalue
,
1277 gcc_jit_type
*type
);
1279 #define LIBGCCJIT_HAVE_ALIGNMENT
1281 /* Set the alignment of a variable.
1283 This API entrypoint was added in LIBGCCJIT_ABI_24; you can test for its
1285 #ifdef LIBGCCJIT_HAVE_ALIGNMENT */
1287 gcc_jit_lvalue_set_alignment (gcc_jit_lvalue
*lvalue
,
1290 /* Get the alignment of a variable.
1292 This API entrypoint was added in LIBGCCJIT_ABI_24; you can test for its
1294 #ifdef LIBGCCJIT_HAVE_ALIGNMENT */
1296 gcc_jit_lvalue_get_alignment (gcc_jit_lvalue
*lvalue
);
1298 extern gcc_jit_lvalue
*
1299 gcc_jit_context_new_array_access (gcc_jit_context
*ctxt
,
1300 gcc_jit_location
*loc
,
1301 gcc_jit_rvalue
*ptr
,
1302 gcc_jit_rvalue
*index
);
1304 /* Field access is provided separately for both lvalues and rvalues. */
1306 /* Accessing a field of an lvalue of struct type, analogous to:
1309 extern gcc_jit_lvalue
*
1310 gcc_jit_lvalue_access_field (gcc_jit_lvalue
*struct_or_union
,
1311 gcc_jit_location
*loc
,
1312 gcc_jit_field
*field
);
1314 /* Accessing a field of an rvalue of struct type, analogous to:
1317 extern gcc_jit_rvalue
*
1318 gcc_jit_rvalue_access_field (gcc_jit_rvalue
*struct_or_union
,
1319 gcc_jit_location
*loc
,
1320 gcc_jit_field
*field
);
1322 /* Accessing a field of an rvalue of pointer type, analogous to:
1324 in C, itself equivalent to (*EXPR).FIELD */
1325 extern gcc_jit_lvalue
*
1326 gcc_jit_rvalue_dereference_field (gcc_jit_rvalue
*ptr
,
1327 gcc_jit_location
*loc
,
1328 gcc_jit_field
*field
);
1330 /* Dereferencing a pointer; analogous to:
1333 extern gcc_jit_lvalue
*
1334 gcc_jit_rvalue_dereference (gcc_jit_rvalue
*rvalue
,
1335 gcc_jit_location
*loc
);
1337 /* Taking the address of an lvalue; analogous to:
1340 extern gcc_jit_rvalue
*
1341 gcc_jit_lvalue_get_address (gcc_jit_lvalue
*lvalue
,
1342 gcc_jit_location
*loc
);
1344 #define LIBGCCJIT_HAVE_gcc_jit_lvalue_set_tls_model
1346 /* Set the thread-local storage model of a global variable
1348 This API entrypoint was added in LIBGCCJIT_ABI_17; you can test for its
1350 #ifdef LIBGCCJIT_HAVE_gcc_jit_lvalue_set_tls_model */
1352 gcc_jit_lvalue_set_tls_model (gcc_jit_lvalue
*lvalue
,
1353 enum gcc_jit_tls_model model
);
1355 #define LIBGCCJIT_HAVE_gcc_jit_lvalue_set_link_section
1357 /* Set the link section of a global variable; analogous to:
1358 __attribute__((section(".section_name")))
1361 This API entrypoint was added in LIBGCCJIT_ABI_18; you can test for its
1363 #ifdef LIBGCCJIT_HAVE_gcc_jit_lvalue_set_link_section
1366 gcc_jit_lvalue_set_link_section (gcc_jit_lvalue
*lvalue
,
1367 const char *section_name
);
1369 #define LIBGCCJIT_HAVE_gcc_jit_lvalue_set_register_name
1371 /* Make this variable a register variable and set its register name.
1373 This API entrypoint was added in LIBGCCJIT_ABI_22; you can test for its
1375 #ifdef LIBGCCJIT_HAVE_gcc_jit_lvalue_set_register_name
1378 gcc_jit_lvalue_set_register_name (gcc_jit_lvalue
*lvalue
,
1379 const char *reg_name
);
1381 extern gcc_jit_lvalue
*
1382 gcc_jit_function_new_local (gcc_jit_function
*func
,
1383 gcc_jit_location
*loc
,
1387 /**********************************************************************
1389 **********************************************************************/
1391 /* Add evaluation of an rvalue, discarding the result
1392 (e.g. a function call that "returns" void).
1394 This is equivalent to this C code:
1399 gcc_jit_block_add_eval (gcc_jit_block
*block
,
1400 gcc_jit_location
*loc
,
1401 gcc_jit_rvalue
*rvalue
);
1403 /* Add evaluation of an rvalue, assigning the result to the given
1406 This is roughly equivalent to this C code:
1411 gcc_jit_block_add_assignment (gcc_jit_block
*block
,
1412 gcc_jit_location
*loc
,
1413 gcc_jit_lvalue
*lvalue
,
1414 gcc_jit_rvalue
*rvalue
);
1416 /* Add evaluation of an rvalue, using the result to modify an
1419 This is analogous to "+=" and friends:
1426 gcc_jit_block_add_assignment_op (gcc_jit_block
*block
,
1427 gcc_jit_location
*loc
,
1428 gcc_jit_lvalue
*lvalue
,
1429 enum gcc_jit_binary_op op
,
1430 gcc_jit_rvalue
*rvalue
);
1432 /* Add a no-op textual comment to the internal representation of the
1433 code. It will be optimized away, but will be visible in the dumps
1435 GCC_JIT_BOOL_OPTION_DUMP_INITIAL_TREE
1437 GCC_JIT_BOOL_OPTION_DUMP_INITIAL_GIMPLE,
1438 and thus may be of use when debugging how your project's internal
1439 representation gets converted to the libgccjit IR. */
1441 gcc_jit_block_add_comment (gcc_jit_block
*block
,
1442 gcc_jit_location
*loc
,
1445 /* Terminate a block by adding evaluation of an rvalue, branching on the
1446 result to the appropriate successor block.
1448 This is roughly equivalent to this C code:
1455 block, boolval, on_true, and on_false must be non-NULL. */
1457 gcc_jit_block_end_with_conditional (gcc_jit_block
*block
,
1458 gcc_jit_location
*loc
,
1459 gcc_jit_rvalue
*boolval
,
1460 gcc_jit_block
*on_true
,
1461 gcc_jit_block
*on_false
);
1463 /* Terminate a block by adding a jump to the given target block.
1465 This is roughly equivalent to this C code:
1470 gcc_jit_block_end_with_jump (gcc_jit_block
*block
,
1471 gcc_jit_location
*loc
,
1472 gcc_jit_block
*target
);
1474 /* Terminate a block by adding evaluation of an rvalue, returning the value.
1476 This is roughly equivalent to this C code:
1481 gcc_jit_block_end_with_return (gcc_jit_block
*block
,
1482 gcc_jit_location
*loc
,
1483 gcc_jit_rvalue
*rvalue
);
1485 /* Terminate a block by adding a valueless return, for use within a function
1486 with "void" return type.
1488 This is equivalent to this C code:
1493 gcc_jit_block_end_with_void_return (gcc_jit_block
*block
,
1494 gcc_jit_location
*loc
);
1496 /* Create a new gcc_jit_case instance for use in a switch statement.
1497 min_value and max_value must be constants of integer type.
1499 This API entrypoint was added in LIBGCCJIT_ABI_3; you can test for its
1501 #ifdef LIBGCCJIT_HAVE_SWITCH_STATEMENTS
1503 extern gcc_jit_case
*
1504 gcc_jit_context_new_case (gcc_jit_context
*ctxt
,
1505 gcc_jit_rvalue
*min_value
,
1506 gcc_jit_rvalue
*max_value
,
1507 gcc_jit_block
*dest_block
);
1509 /* Upcasting from case to object.
1511 This API entrypoint was added in LIBGCCJIT_ABI_3; you can test for its
1513 #ifdef LIBGCCJIT_HAVE_SWITCH_STATEMENTS
1516 extern gcc_jit_object
*
1517 gcc_jit_case_as_object (gcc_jit_case
*case_
);
1519 /* Terminate a block by adding evalation of an rvalue, then performing
1522 This is roughly equivalent to this C code:
1529 case C0.min_value ... C0.max_value:
1532 case C1.min_value ... C1.max_value:
1537 case C[N - 1].min_value ... C[N - 1].max_value:
1538 goto C[N - 1].dest_block;
1541 block, expr, default_block and cases must all be non-NULL.
1543 expr must be of the same integer type as all of the min_value
1544 and max_value within the cases.
1546 num_cases must be >= 0.
1548 The ranges of the cases must not overlap (or have duplicate
1551 This API entrypoint was added in LIBGCCJIT_ABI_3; you can test for its
1553 #ifdef LIBGCCJIT_HAVE_SWITCH_STATEMENTS
1557 gcc_jit_block_end_with_switch (gcc_jit_block
*block
,
1558 gcc_jit_location
*loc
,
1559 gcc_jit_rvalue
*expr
,
1560 gcc_jit_block
*default_block
,
1562 gcc_jit_case
**cases
);
1564 /* Pre-canned feature macro to indicate the presence of
1565 gcc_jit_block_end_with_switch, gcc_jit_case_as_object, and
1566 gcc_jit_context_new_case.
1568 This can be tested for with #ifdef. */
1569 #define LIBGCCJIT_HAVE_SWITCH_STATEMENTS
1571 /**********************************************************************
1573 **********************************************************************/
1575 /* Given an existing JIT context, create a child context.
1577 The child inherits a copy of all option-settings from the parent.
1579 The child can reference objects created within the parent, but not
1582 The lifetime of the child context must be bounded by that of the
1583 parent: you should release a child context before releasing the parent
1586 If you use a function from a parent context within a child context,
1587 you have to compile the parent context before you can compile the
1588 child context, and the gcc_jit_result of the parent context must
1589 outlive the gcc_jit_result of the child context.
1591 This allows caching of shared initializations. For example, you could
1592 create types and declarations of global functions in a parent context
1593 once within a process, and then create child contexts whenever a
1594 function or loop becomes hot. Each such child context can be used for
1595 JIT-compiling just one function or loop, but can reference types
1596 and helper functions created within the parent context.
1598 Contexts can be arbitrarily nested, provided the above rules are
1599 followed, but it's probably not worth going above 2 or 3 levels, and
1600 there will likely be a performance hit for such nesting. */
1602 extern gcc_jit_context
*
1603 gcc_jit_context_new_child_context (gcc_jit_context
*parent_ctxt
);
1605 /**********************************************************************
1606 Implementation support.
1607 **********************************************************************/
1609 /* Write C source code into "path" that can be compiled into a
1610 self-contained executable (i.e. with libgccjit as the only dependency).
1611 The generated code will attempt to replay the API calls that have been
1612 made into the given context.
1614 This may be useful when debugging the library or client code, for
1615 reducing a complicated recipe for reproducing a bug into a simpler
1618 Typically you need to supply the option "-Wno-unused-variable" when
1619 compiling the generated file (since the result of each API call is
1620 assigned to a unique variable within the generated C source, and not
1621 all are necessarily then used). */
1624 gcc_jit_context_dump_reproducer_to_file (gcc_jit_context
*ctxt
,
1627 /* Enable the dumping of a specific set of internal state from the
1628 compilation, capturing the result in-memory as a buffer.
1630 Parameter "dumpname" corresponds to the equivalent gcc command-line
1631 option, without the "-fdump-" prefix.
1632 For example, to get the equivalent of "-fdump-tree-vrp1", supply
1634 The context directly stores the dumpname as a (const char *), so the
1635 passed string must outlive the context.
1637 gcc_jit_context_compile and gcc_jit_context_to_file
1638 will capture the dump as a dynamically-allocated buffer, writing
1641 The caller becomes responsible for calling
1643 each time that gcc_jit_context_compile or gcc_jit_context_to_file
1644 are called. *out_ptr will be written to, either with the address of a
1645 buffer, or with NULL if an error occurred.
1647 This API entrypoint is likely to be less stable than the others.
1648 In particular, both the precise dumpnames, and the format and content
1649 of the dumps are subject to change.
1651 It exists primarily for writing the library's own test suite. */
1654 gcc_jit_context_enable_dump (gcc_jit_context
*ctxt
,
1655 const char *dumpname
,
1658 /**********************************************************************
1660 **********************************************************************/
1662 /* The timing API was added in LIBGCCJIT_ABI_4; you can test for its
1664 #ifdef LIBGCCJIT_HAVE_TIMING_API
1666 #define LIBGCCJIT_HAVE_TIMING_API
1668 typedef struct gcc_jit_timer gcc_jit_timer
;
1670 /* Create a gcc_jit_timer instance, and start timing.
1672 This API entrypoint was added in LIBGCCJIT_ABI_4; you can test for its
1674 #ifdef LIBGCCJIT_HAVE_TIMING_API
1676 extern gcc_jit_timer
*
1677 gcc_jit_timer_new (void);
1679 /* Release a gcc_jit_timer instance.
1681 This API entrypoint was added in LIBGCCJIT_ABI_4; you can test for its
1683 #ifdef LIBGCCJIT_HAVE_TIMING_API
1686 gcc_jit_timer_release (gcc_jit_timer
*timer
);
1688 /* Associate a gcc_jit_timer instance with a context.
1690 This API entrypoint was added in LIBGCCJIT_ABI_4; you can test for its
1692 #ifdef LIBGCCJIT_HAVE_TIMING_API
1695 gcc_jit_context_set_timer (gcc_jit_context
*ctxt
,
1696 gcc_jit_timer
*timer
);
1698 /* Get the timer associated with a context (if any).
1700 This API entrypoint was added in LIBGCCJIT_ABI_4; you can test for its
1702 #ifdef LIBGCCJIT_HAVE_TIMING_API
1705 extern gcc_jit_timer
*
1706 gcc_jit_context_get_timer (gcc_jit_context
*ctxt
);
1708 /* Push the given item onto the timing stack.
1710 This API entrypoint was added in LIBGCCJIT_ABI_4; you can test for its
1712 #ifdef LIBGCCJIT_HAVE_TIMING_API
1716 gcc_jit_timer_push (gcc_jit_timer
*timer
,
1717 const char *item_name
);
1719 /* Pop the top item from the timing stack.
1721 This API entrypoint was added in LIBGCCJIT_ABI_4; you can test for its
1723 #ifdef LIBGCCJIT_HAVE_TIMING_API
1727 gcc_jit_timer_pop (gcc_jit_timer
*timer
,
1728 const char *item_name
);
1730 /* Print timing information to the given stream about activity since
1731 the timer was started.
1733 This API entrypoint was added in LIBGCCJIT_ABI_4; you can test for its
1735 #ifdef LIBGCCJIT_HAVE_TIMING_API
1739 gcc_jit_timer_print (gcc_jit_timer
*timer
,
1743 #define LIBGCCJIT_HAVE_gcc_jit_rvalue_set_bool_require_tail_call
1745 /* Mark/clear a call as needing tail-call optimization.
1747 This API entrypoint was added in LIBGCCJIT_ABI_6; you can test for its
1749 #ifdef LIBGCCJIT_HAVE_gcc_jit_rvalue_set_bool_require_tail_call
1752 gcc_jit_rvalue_set_bool_require_tail_call (gcc_jit_rvalue
*call
,
1753 int require_tail_call
);
1755 #define LIBGCCJIT_HAVE_gcc_jit_type_get_aligned
1757 /* Given type "T", get type:
1759 T __attribute__ ((aligned (ALIGNMENT_IN_BYTES)))
1761 The alignment must be a power of two.
1763 This API entrypoint was added in LIBGCCJIT_ABI_7; you can test for its
1765 #ifdef LIBGCCJIT_HAVE_gcc_jit_type_get_aligned
1767 extern gcc_jit_type
*
1768 gcc_jit_type_get_aligned (gcc_jit_type
*type
,
1769 size_t alignment_in_bytes
);
1771 #define LIBGCCJIT_HAVE_gcc_jit_type_get_vector
1773 /* Given type "T", get type:
1775 T __attribute__ ((vector_size (sizeof(T) * num_units))
1777 T must be integral/floating point; num_units must be a power of two.
1779 This API entrypoint was added in LIBGCCJIT_ABI_8; you can test for its
1781 #ifdef LIBGCCJIT_HAVE_gcc_jit_type_get_vector
1783 extern gcc_jit_type
*
1784 gcc_jit_type_get_vector (gcc_jit_type
*type
, size_t num_units
);
1787 #define LIBGCCJIT_HAVE_gcc_jit_function_get_address
1789 /* Get the address of a function as an rvalue, of function pointer
1792 This API entrypoint was added in LIBGCCJIT_ABI_9; you can test for its
1794 #ifdef LIBGCCJIT_HAVE_gcc_jit_function_get_address
1796 extern gcc_jit_rvalue
*
1797 gcc_jit_function_get_address (gcc_jit_function
*fn
,
1798 gcc_jit_location
*loc
);
1801 #define LIBGCCJIT_HAVE_gcc_jit_context_new_rvalue_from_vector
1803 /* Build a vector rvalue from an array of elements.
1805 "vec_type" should be a vector type, created using gcc_jit_type_get_vector.
1807 This API entrypoint was added in LIBGCCJIT_ABI_10; you can test for its
1809 #ifdef LIBGCCJIT_HAVE_gcc_jit_context_new_rvalue_from_vector
1811 extern gcc_jit_rvalue
*
1812 gcc_jit_context_new_rvalue_from_vector (gcc_jit_context
*ctxt
,
1813 gcc_jit_location
*loc
,
1814 gcc_jit_type
*vec_type
,
1815 size_t num_elements
,
1816 gcc_jit_rvalue
**elements
);
1818 #define LIBGCCJIT_HAVE_gcc_jit_version
1820 /* Functions to retrieve libgccjit version.
1821 Analogous to __GNUC__, __GNUC_MINOR__, __GNUC_PATCHLEVEL__ in C code.
1823 These API entrypoints were added in LIBGCCJIT_ABI_13; you can test for their
1825 #ifdef LIBGCCJIT_HAVE_gcc_jit_version
1828 gcc_jit_version_major (void);
1830 gcc_jit_version_minor (void);
1832 gcc_jit_version_patchlevel (void);
1834 /**********************************************************************
1836 **********************************************************************/
1838 /* Functions for adding inline assembler code, analogous to GCC's
1839 "extended asm" syntax.
1841 See https://gcc.gnu.org/onlinedocs/gcc/Using-Assembly-Language-with-C.html
1843 These API entrypoints were added in LIBGCCJIT_ABI_15; you can test for their
1845 #ifdef LIBGCCJIT_HAVE_ASM_STATEMENTS
1848 #define LIBGCCJIT_HAVE_ASM_STATEMENTS
1850 /* Create a gcc_jit_extended_asm for an extended asm statement
1851 with no control flow (i.e. without the goto qualifier).
1853 The asm_template parameter corresponds to the AssemblerTemplate
1854 within C's extended asm syntax. It must be non-NULL. */
1856 extern gcc_jit_extended_asm
*
1857 gcc_jit_block_add_extended_asm (gcc_jit_block
*block
,
1858 gcc_jit_location
*loc
,
1859 const char *asm_template
);
1861 /* Create a gcc_jit_extended_asm for an extended asm statement
1862 that may perform jumps, and use it to terminate the given block.
1863 This is equivalent to the "goto" qualifier in C's extended asm
1866 extern gcc_jit_extended_asm
*
1867 gcc_jit_block_end_with_extended_asm_goto (gcc_jit_block
*block
,
1868 gcc_jit_location
*loc
,
1869 const char *asm_template
,
1870 int num_goto_blocks
,
1871 gcc_jit_block
**goto_blocks
,
1872 gcc_jit_block
*fallthrough_block
);
1874 /* Upcasting from extended asm to object. */
1876 extern gcc_jit_object
*
1877 gcc_jit_extended_asm_as_object (gcc_jit_extended_asm
*ext_asm
);
1879 /* Set whether the gcc_jit_extended_asm has side-effects, equivalent to
1880 the "volatile" qualifier in C's extended asm syntax. */
1883 gcc_jit_extended_asm_set_volatile_flag (gcc_jit_extended_asm
*ext_asm
,
1886 /* Set the equivalent of the "inline" qualifier in C's extended asm
1890 gcc_jit_extended_asm_set_inline_flag (gcc_jit_extended_asm
*ext_asm
,
1893 /* Add an output operand to the extended asm statement.
1894 "asm_symbolic_name" can be NULL.
1895 "constraint" and "dest" must be non-NULL.
1896 This function can't be called on an "asm goto" as such instructions
1897 can't have outputs */
1900 gcc_jit_extended_asm_add_output_operand (gcc_jit_extended_asm
*ext_asm
,
1901 const char *asm_symbolic_name
,
1902 const char *constraint
,
1903 gcc_jit_lvalue
*dest
);
1905 /* Add an input operand to the extended asm statement.
1906 "asm_symbolic_name" can be NULL.
1907 "constraint" and "src" must be non-NULL. */
1910 gcc_jit_extended_asm_add_input_operand (gcc_jit_extended_asm
*ext_asm
,
1911 const char *asm_symbolic_name
,
1912 const char *constraint
,
1913 gcc_jit_rvalue
*src
);
1915 /* Add "victim" to the list of registers clobbered by the extended
1916 asm statement. It must be non-NULL. */
1919 gcc_jit_extended_asm_add_clobber (gcc_jit_extended_asm
*ext_asm
,
1920 const char *victim
);
1922 /* Add "asm_stmts", a set of top-level asm statements, analogous to
1923 those created by GCC's "basic" asm syntax in C at file scope. */
1926 gcc_jit_context_add_top_level_asm (gcc_jit_context
*ctxt
,
1927 gcc_jit_location
*loc
,
1928 const char *asm_stmts
);
1930 #define LIBGCCJIT_HAVE_REFLECTION
1932 /* Reflection functions to get the number of parameters, return type of
1933 a function and whether a type is a bool from the C API.
1935 This API entrypoint was added in LIBGCCJIT_ABI_16; you can test for its
1937 #ifdef LIBGCCJIT_HAVE_REFLECTION
1939 /* Get the return type of a function. */
1940 extern gcc_jit_type
*
1941 gcc_jit_function_get_return_type (gcc_jit_function
*func
);
1943 /* Get the number of params of a function. */
1945 gcc_jit_function_get_param_count (gcc_jit_function
*func
);
1947 /* Get the element type of an array type or NULL if it's not an array. */
1948 extern gcc_jit_type
*
1949 gcc_jit_type_dyncast_array (gcc_jit_type
*type
);
1951 /* Return non-zero if the type is a bool. */
1953 gcc_jit_type_is_bool (gcc_jit_type
*type
);
1955 /* Return the function type if it is one or NULL. */
1956 extern gcc_jit_function_type
*
1957 gcc_jit_type_dyncast_function_ptr_type (gcc_jit_type
*type
);
1959 /* Given a function type, return its return type. */
1960 extern gcc_jit_type
*
1961 gcc_jit_function_type_get_return_type (gcc_jit_function_type
*function_type
);
1963 /* Given a function type, return its number of parameters. */
1965 gcc_jit_function_type_get_param_count (gcc_jit_function_type
*function_type
);
1967 /* Given a function type, return the type of the specified parameter. */
1968 extern gcc_jit_type
*
1969 gcc_jit_function_type_get_param_type (gcc_jit_function_type
*function_type
,
1972 /* Return non-zero if the type is an integral. */
1974 gcc_jit_type_is_integral (gcc_jit_type
*type
);
1976 /* Return the type pointed by the pointer type or NULL if it's not a
1978 extern gcc_jit_type
*
1979 gcc_jit_type_is_pointer (gcc_jit_type
*type
);
1981 /* Given a type, return a dynamic cast to a vector type or NULL. */
1982 extern gcc_jit_vector_type
*
1983 gcc_jit_type_dyncast_vector (gcc_jit_type
*type
);
1985 /* Given a type, return a dynamic cast to a struct type or NULL. */
1986 extern gcc_jit_struct
*
1987 gcc_jit_type_is_struct (gcc_jit_type
*type
);
1989 /* Given a vector type, return the number of units it contains. */
1991 gcc_jit_vector_type_get_num_units (gcc_jit_vector_type
*vector_type
);
1993 /* Given a vector type, return the type of its elements. */
1994 extern gcc_jit_type
*
1995 gcc_jit_vector_type_get_element_type (gcc_jit_vector_type
*vector_type
);
1997 /* Given a type, return the unqualified type, removing "const", "volatile"
1998 * and alignment qualifiers. */
1999 extern gcc_jit_type
*
2000 gcc_jit_type_unqualified (gcc_jit_type
*type
);
2002 #define LIBGCCJIT_HAVE_ATTRIBUTES
2004 /* Function attributes. */
2005 enum gcc_jit_fn_attribute
2007 GCC_JIT_FN_ATTRIBUTE_ALIAS
,
2008 GCC_JIT_FN_ATTRIBUTE_ALWAYS_INLINE
,
2009 GCC_JIT_FN_ATTRIBUTE_INLINE
,
2010 GCC_JIT_FN_ATTRIBUTE_NOINLINE
,
2011 GCC_JIT_FN_ATTRIBUTE_TARGET
,
2012 GCC_JIT_FN_ATTRIBUTE_USED
,
2013 GCC_JIT_FN_ATTRIBUTE_VISIBILITY
,
2014 GCC_JIT_FN_ATTRIBUTE_COLD
,
2015 GCC_JIT_FN_ATTRIBUTE_RETURNS_TWICE
,
2016 GCC_JIT_FN_ATTRIBUTE_PURE
,
2017 GCC_JIT_FN_ATTRIBUTE_CONST
,
2018 GCC_JIT_FN_ATTRIBUTE_WEAK
,
2019 GCC_JIT_FN_ATTRIBUTE_NONNULL
,
2021 /* Maximum value of this enum, should always be last. */
2022 GCC_JIT_FN_ATTRIBUTE_MAX
,
2025 /* Add an attribute to a function. */
2027 gcc_jit_function_add_attribute (gcc_jit_function
*func
,
2028 enum gcc_jit_fn_attribute attribute
);
2031 gcc_jit_function_add_string_attribute (gcc_jit_function
*func
,
2032 enum gcc_jit_fn_attribute attribute
,
2036 gcc_jit_function_add_integer_array_attribute (
2037 gcc_jit_function
*func
,
2038 enum gcc_jit_fn_attribute attribute
,
2042 /* Variable attributes. */
2043 enum gcc_jit_variable_attribute
2045 GCC_JIT_VARIABLE_ATTRIBUTE_VISIBILITY
,
2047 /* Maximum value of this enum, should always be last. */
2048 GCC_JIT_VARIABLE_ATTRIBUTE_MAX
,
2051 /* Add a string attribute to a variable. */
2053 gcc_jit_lvalue_add_string_attribute (gcc_jit_lvalue
*variable
,
2054 enum gcc_jit_variable_attribute attribute
,
2059 #endif /* __cplusplus */
2061 #endif /* LIBGCCJIT_H */