PostgreSQL Source Code  git master
llvmjit.h
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  * llvmjit.h
3  * LLVM JIT provider.
4  *
5  * Copyright (c) 2016-2024, PostgreSQL Global Development Group
6  *
7  * src/include/jit/llvmjit.h
8  *
9  *-------------------------------------------------------------------------
10  */
11 #ifndef LLVMJIT_H
12 #define LLVMJIT_H
13 
14 /*
15  * To avoid breaking cpluspluscheck, allow including the file even when LLVM
16  * is not available.
17  */
18 #ifdef USE_LLVM
19 
20 #include <llvm-c/Types.h>
21 
22 
23 /*
24  * File needs to be includable by both C and C++ code, and include other
25  * headers doing the same. Therefore wrap C portion in our own extern "C" if
26  * in C++ mode.
27  */
28 #ifdef __cplusplus
29 extern "C"
30 {
31 #endif
32 
33 #include "access/tupdesc.h"
34 #include "fmgr.h"
35 #include "jit/jit.h"
36 #include "nodes/pg_list.h"
37 
38 typedef struct LLVMJitContext
39 {
40  JitContext base;
41 
42  /* number of modules created */
43  size_t module_generation;
44 
45  /*
46  * The LLVM Context used by this JIT context. An LLVM context is reused
47  * across many compilations, but occasionally reset to prevent it using
48  * too much memory due to more and more types accumulating.
49  */
50  LLVMContextRef llvm_context;
51 
52  /* current, "open for write", module */
53  LLVMModuleRef module;
54 
55  /* is there any pending code that needs to be emitted */
56  bool compiled;
57 
58  /* # of objects emitted, used to generate non-conflicting names */
59  int counter;
60 
61  /* list of handles for code emitted via Orc */
62  List *handles;
63 } LLVMJitContext;
64 
65 /* type and struct definitions */
66 extern PGDLLIMPORT LLVMTypeRef TypeParamBool;
67 extern PGDLLIMPORT LLVMTypeRef TypePGFunction;
68 extern PGDLLIMPORT LLVMTypeRef TypeSizeT;
69 extern PGDLLIMPORT LLVMTypeRef TypeStorageBool;
70 
71 extern PGDLLIMPORT LLVMTypeRef StructNullableDatum;
72 extern PGDLLIMPORT LLVMTypeRef StructTupleDescData;
73 extern PGDLLIMPORT LLVMTypeRef StructHeapTupleData;
74 extern PGDLLIMPORT LLVMTypeRef StructHeapTupleHeaderData;
75 extern PGDLLIMPORT LLVMTypeRef StructMinimalTupleData;
76 extern PGDLLIMPORT LLVMTypeRef StructTupleTableSlot;
77 extern PGDLLIMPORT LLVMTypeRef StructHeapTupleTableSlot;
78 extern PGDLLIMPORT LLVMTypeRef StructMinimalTupleTableSlot;
79 extern PGDLLIMPORT LLVMTypeRef StructMemoryContextData;
80 extern PGDLLIMPORT LLVMTypeRef StructFunctionCallInfoData;
81 extern PGDLLIMPORT LLVMTypeRef StructExprContext;
82 extern PGDLLIMPORT LLVMTypeRef StructExprEvalStep;
83 extern PGDLLIMPORT LLVMTypeRef StructExprState;
84 extern PGDLLIMPORT LLVMTypeRef StructAggState;
85 extern PGDLLIMPORT LLVMTypeRef StructAggStatePerTransData;
86 extern PGDLLIMPORT LLVMTypeRef StructAggStatePerGroupData;
87 extern PGDLLIMPORT LLVMTypeRef StructPlanState;
88 
89 extern PGDLLIMPORT LLVMValueRef AttributeTemplate;
91 extern PGDLLIMPORT LLVMValueRef ExecEvalSubroutineTemplate;
92 
93 
94 extern void llvm_enter_fatal_on_oom(void);
95 extern void llvm_leave_fatal_on_oom(void);
96 extern bool llvm_in_fatal_on_oom(void);
97 extern void llvm_reset_after_error(void);
98 extern void llvm_assert_in_fatal_section(void);
99 
100 extern LLVMJitContext *llvm_create_context(int jitFlags);
101 extern LLVMModuleRef llvm_mutable_module(LLVMJitContext *context);
102 extern char *llvm_expand_funcname(LLVMJitContext *context, const char *basename);
103 extern void *llvm_get_function(LLVMJitContext *context, const char *funcname);
104 extern void llvm_split_symbol_name(const char *name, char **modname, char **funcname);
105 extern LLVMTypeRef llvm_pg_var_type(const char *varname);
106 extern LLVMTypeRef llvm_pg_var_func_type(const char *varname);
107 extern LLVMValueRef llvm_pg_func(LLVMModuleRef mod, const char *funcname);
108 extern void llvm_copy_attributes(LLVMValueRef from, LLVMValueRef to);
109 extern LLVMValueRef llvm_function_reference(LLVMJitContext *context,
110  LLVMBuilderRef builder,
111  LLVMModuleRef mod,
112  FunctionCallInfo fcinfo);
113 
114 extern void llvm_inline_reset_caches(void);
115 extern void llvm_inline(LLVMModuleRef mod);
116 
117 /*
118  ****************************************************************************
119  * Code generation functions.
120  ****************************************************************************
121  */
122 extern bool llvm_compile_expr(struct ExprState *state);
123 struct TupleTableSlotOps;
124 extern LLVMValueRef slot_compile_deform(struct LLVMJitContext *context, TupleDesc desc,
125  const struct TupleTableSlotOps *ops, int natts);
126 
127 /*
128  ****************************************************************************
129  * Extensions / Backward compatibility section of the LLVM C API
130  * Error handling related functions.
131  ****************************************************************************
132  */
133 extern LLVMTypeRef LLVMGetFunctionReturnType(LLVMValueRef r);
134 extern LLVMTypeRef LLVMGetFunctionType(LLVMValueRef r);
135 
136 #ifdef __cplusplus
137 } /* extern "C" */
138 #endif
139 
140 #endif /* USE_LLVM */
141 #endif /* LLVMJIT_H */
#define PGDLLIMPORT
Definition: c.h:1303
#define funcname
Definition: indent_codes.h:69
LLVMTypeRef StructFunctionCallInfoData
Definition: llvmjit.c:77
LLVMTypeRef StructMinimalTupleData
Definition: llvmjit.c:70
LLVMTypeRef StructMinimalTupleTableSlot
Definition: llvmjit.c:75
LLVMTypeRef StructPlanState
Definition: llvmjit.c:84
static LLVMContextRef llvm_context
Definition: llvmjit.c:102
LLVMTypeRef StructExprState
Definition: llvmjit.c:80
LLVMTypeRef StructExprEvalStep
Definition: llvmjit.c:79
LLVMValueRef llvm_pg_func(LLVMModuleRef mod, const char *funcname)
Definition: llvmjit.c:496
LLVMTypeRef TypeParamBool
Definition: llvmjit.c:65
LLVMTypeRef StructMemoryContextData
Definition: llvmjit.c:76
LLVMTypeRef StructAggStatePerGroupData
Definition: llvmjit.c:82
LLVMTypeRef llvm_pg_var_type(const char *varname)
Definition: llvmjit.c:454
LLVMTypeRef TypeSizeT
Definition: llvmjit.c:64
LLVMValueRef llvm_function_reference(LLVMJitContext *context, LLVMBuilderRef builder, LLVMModuleRef mod, FunctionCallInfo fcinfo)
Definition: llvmjit.c:569
char * llvm_expand_funcname(struct LLVMJitContext *context, const char *basename)
Definition: llvmjit.c:359
void llvm_split_symbol_name(const char *name, char **modname, char **funcname)
Definition: llvmjit.c:1149
LLVMTypeRef llvm_pg_var_func_type(const char *varname)
Definition: llvmjit.c:474
LLVMTypeRef StructTupleTableSlot
Definition: llvmjit.c:72
LLVMTypeRef TypeStorageBool
Definition: llvmjit.c:66
LLVMTypeRef StructHeapTupleTableSlot
Definition: llvmjit.c:74
LLVMJitContext * llvm_create_context(int jitFlags)
Definition: llvmjit.c:235
LLVMModuleRef llvm_mutable_module(LLVMJitContext *context)
Definition: llvmjit.c:334
LLVMTypeRef StructAggState
Definition: llvmjit.c:81
LLVMTypeRef TypePGFunction
Definition: llvmjit.c:67
LLVMTypeRef StructTupleDescData
Definition: llvmjit.c:71
LLVMValueRef AttributeTemplate
Definition: llvmjit.c:86
LLVMTypeRef StructExprContext
Definition: llvmjit.c:78
LLVMTypeRef StructHeapTupleHeaderData
Definition: llvmjit.c:73
LLVMTypeRef StructHeapTupleData
Definition: llvmjit.c:69
LLVMTypeRef StructNullableDatum
Definition: llvmjit.c:68
LLVMValueRef ExecEvalSubroutineTemplate
Definition: llvmjit.c:87
LLVMValueRef ExecEvalBoolSubroutineTemplate
Definition: llvmjit.c:88
void * llvm_get_function(LLVMJitContext *context, const char *funcname)
Definition: llvmjit.c:380
LLVMTypeRef StructAggStatePerTransData
Definition: llvmjit.c:83
void llvm_copy_attributes(LLVMValueRef v_from, LLVMValueRef v_to)
Definition: llvmjit.c:548
LLVMValueRef slot_compile_deform(LLVMJitContext *context, TupleDesc desc, const TupleTableSlotOps *ops, int natts)
void llvm_enter_fatal_on_oom(void)
bool llvm_in_fatal_on_oom(void)
void llvm_assert_in_fatal_section(void)
void llvm_reset_after_error(void)
void llvm_leave_fatal_on_oom(void)
bool llvm_compile_expr(ExprState *state)
Definition: llvmjit_expr.c:78
void llvm_inline(LLVMModuleRef M)
void llvm_inline_reset_caches(void)
LLVMTypeRef LLVMGetFunctionReturnType(LLVMValueRef r)
LLVMTypeRef LLVMGetFunctionType(LLVMValueRef r)
tree context
Definition: radixtree.h:1797
Definition: jit.h:58
Definition: pg_list.h:54
Definition: regguts.h:323
const char * name