jit.h File Reference

#include "executor/instrument.h"
#include "utils/resowner.h"

Include dependency graph for jit.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	JitInstrumentation
struct	SharedJitInstrumentation
struct	JitContext
struct	JitProviderCallbacks

Macros
#define	PGJIT_NONE   0
#define	PGJIT_PERFORM   (1 << 0)
#define	PGJIT_OPT3   (1 << 1)
#define	PGJIT_INLINE   (1 << 2)
#define	PGJIT_EXPR   (1 << 3)
#define	PGJIT_DEFORM   (1 << 4)

Typedefs
typedef struct JitInstrumentation	JitInstrumentation
typedef struct SharedJitInstrumentation	SharedJitInstrumentation
typedef struct JitContext	JitContext
typedef struct JitProviderCallbacks	JitProviderCallbacks
typedef void(*	JitProviderInit) (JitProviderCallbacks *cb)
typedef void(*	JitProviderResetAfterErrorCB) (void)
typedef void(*	JitProviderReleaseContextCB) (JitContext *context)
typedef bool(*	JitProviderCompileExprCB) (struct ExprState *state)

Functions
void	_PG_jit_provider_init (JitProviderCallbacks *cb)
void	jit_reset_after_error (void)
void	jit_release_context (JitContext *context)
bool	jit_compile_expr (struct ExprState *state)
void	InstrJitAgg (JitInstrumentation *dst, JitInstrumentation *add)

Variables
bool	jit_enabled
char *	jit_provider
bool	jit_debugging_support
bool	jit_dump_bitcode
bool	jit_expressions
bool	jit_profiling_support
bool	jit_tuple_deforming
double	jit_above_cost
double	jit_inline_above_cost
double	jit_optimize_above_cost

Macro Definition Documentation

PGJIT_DEFORM

#define PGJIT_DEFORM   (1 << 4)

Definition at line 24 of file jit.h.

Referenced by ExplainPrintJIT(), llvm_compile_expr(), and standard_planner().

PGJIT_EXPR

#define PGJIT_EXPR   (1 << 3)

Definition at line 23 of file jit.h.

Referenced by ExplainPrintJIT(), jit_compile_expr(), and standard_planner().

PGJIT_INLINE

#define PGJIT_INLINE   (1 << 2)

Definition at line 22 of file jit.h.

Referenced by ExplainPrintJIT(), llvm_compile_module(), llvm_optimize_module(), and standard_planner().

PGJIT_NONE

#define PGJIT_NONE   0

Definition at line 19 of file jit.h.

Referenced by ExecInitParallelPlan(), ExecInitValuesScan(), and standard_planner().

PGJIT_OPT3

#define PGJIT_OPT3   (1 << 1)

Definition at line 21 of file jit.h.

Referenced by ExplainPrintJIT(), llvm_compile_module(), llvm_optimize_module(), and standard_planner().

PGJIT_PERFORM

#define PGJIT_PERFORM   (1 << 0)

Definition at line 20 of file jit.h.

Referenced by ExplainPrintJITSummary(), jit_compile_expr(), and standard_planner().

Typedef Documentation

JitContext

typedef struct JitContext JitContext

JitInstrumentation

typedef struct JitInstrumentation JitInstrumentation

JitProviderCallbacks

typedef struct JitProviderCallbacks JitProviderCallbacks

Definition at line 64 of file jit.h.

JitProviderCompileExprCB

typedef bool(* JitProviderCompileExprCB) (struct ExprState *state)

Definition at line 71 of file jit.h.

JitProviderInit

typedef void(* JitProviderInit) (JitProviderCallbacks *cb)

Definition at line 67 of file jit.h.

JitProviderReleaseContextCB

typedef void(* JitProviderReleaseContextCB) (JitContext *context)

Definition at line 69 of file jit.h.

JitProviderResetAfterErrorCB

typedef void(* JitProviderResetAfterErrorCB) (void)

Definition at line 68 of file jit.h.

SharedJitInstrumentation

typedef struct SharedJitInstrumentation SharedJitInstrumentation

Function Documentation

_PG_jit_provider_init()

void _PG_jit_provider_init

(

JitProviderCallbacks *

cb

)

Definition at line 131 of file llvmjit.c.

References JitProviderCallbacks::compile_expr, llvm_compile_expr(), llvm_release_context(), llvm_reset_after_error(), JitProviderCallbacks::release_context, and JitProviderCallbacks::reset_after_error.

{
    cb->reset_after_error = llvm_reset_after_error;
    cb->release_context = llvm_release_context;
    cb->compile_expr = llvm_compile_expr;
}

InstrJitAgg()

void InstrJitAgg	(	JitInstrumentation *	dst,
		JitInstrumentation *	add
	)

Definition at line 184 of file jit.c.

References JitInstrumentation::created_functions, JitInstrumentation::emission_counter, JitInstrumentation::generation_counter, JitInstrumentation::inlining_counter, INSTR_TIME_ADD, and JitInstrumentation::optimization_counter.

Referenced by ExecParallelRetrieveJitInstrumentation(), and ExplainPrintJITSummary().

{
    dst->created_functions += add->created_functions;
    INSTR_TIME_ADD(dst->generation_counter, add->generation_counter);
    INSTR_TIME_ADD(dst->inlining_counter, add->inlining_counter);
    INSTR_TIME_ADD(dst->optimization_counter, add->optimization_counter);
    INSTR_TIME_ADD(dst->emission_counter, add->emission_counter);
}

jit_compile_expr()

bool jit_compile_expr

(

struct ExprState *

state

)

Definition at line 153 of file jit.c.

References JitProviderCallbacks::compile_expr, EState::es_jit_flags, ExprState::parent, PGJIT_EXPR, PGJIT_PERFORM, provider_init(), and PlanState::state.

Referenced by ExecReadyExpr().

{
    /*
     * We can easily create a one-off context for functions without an
     * associated PlanState (and thus EState). But because there's no executor
     * shutdown callback that could deallocate the created function, they'd
     * live to the end of the transactions, where they'd be cleaned up by the
     * resowner machinery. That can lead to a noticeable amount of memory
     * usage, and worse, trigger some quadratic behaviour in gdb. Therefore,
     * at least for now, don't create a JITed function in those circumstances.
     */
    if (!state->parent)
        return false;

    /* if no jitting should be performed at all */
    if (!(state->parent->state->es_jit_flags & PGJIT_PERFORM))
        return false;

    /* or if expressions aren't JITed */
    if (!(state->parent->state->es_jit_flags & PGJIT_EXPR))
        return false;

    /* this also takes !jit_enabled into account */
    if (provider_init())
        return provider.compile_expr(state);

    return false;
}

jit_release_context()

void jit_release_context

(

JitContext *

context

)

Definition at line 138 of file jit.c.

References pfree(), PointerGetDatum, provider_successfully_loaded, JitProviderCallbacks::release_context, ResourceOwnerForgetJIT(), and JitContext::resowner.

Referenced by FreeExecutorState(), and ResourceOwnerReleaseInternal().

{
    if (provider_successfully_loaded)
        provider.release_context(context);

    ResourceOwnerForgetJIT(context->resowner, PointerGetDatum(context));
    pfree(context);
}

jit_reset_after_error()

void jit_reset_after_error

(

void

)

Definition at line 128 of file jit.c.

References provider_successfully_loaded, and JitProviderCallbacks::reset_after_error.

Referenced by PostgresMain().

{
    if (provider_successfully_loaded)
        provider.reset_after_error();
}

Variable Documentation

jit_above_cost

double jit_above_cost

Definition at line 39 of file jit.c.

Referenced by standard_planner().

jit_debugging_support

bool jit_debugging_support

Definition at line 34 of file jit.c.

Referenced by llvm_resolve_symbol(), and llvm_session_initialize().

jit_dump_bitcode

bool jit_dump_bitcode

Definition at line 35 of file jit.c.

Referenced by llvm_compile_module().

jit_enabled

bool jit_enabled

Definition at line 32 of file jit.c.

Referenced by provider_init(), and standard_planner().

jit_expressions

bool jit_expressions

Definition at line 36 of file jit.c.

Referenced by standard_planner().

jit_inline_above_cost

double jit_inline_above_cost

Definition at line 40 of file jit.c.

Referenced by standard_planner().

jit_optimize_above_cost

double jit_optimize_above_cost

Definition at line 41 of file jit.c.

Referenced by standard_planner().

jit_profiling_support

bool jit_profiling_support

Definition at line 37 of file jit.c.

Referenced by llvm_resolve_symbol(), llvm_session_initialize(), and llvm_shutdown().

jit_provider

char* jit_provider

Definition at line 33 of file jit.c.

Referenced by provider_init().

jit_tuple_deforming

bool jit_tuple_deforming

Definition at line 38 of file jit.c.

Referenced by standard_planner().