PostgreSQL Source Code git master
injection_point.h
Go to the documentation of this file.
1/*-------------------------------------------------------------------------
2 * injection_point.h
3 * Definitions related to injection points.
4 *
5 * Copyright (c) 2001-2025, PostgreSQL Global Development Group
6 *
7 * src/include/utils/injection_point.h
8 *-------------------------------------------------------------------------
9 */
10
11#ifndef INJECTION_POINT_H
12#define INJECTION_POINT_H
13
14/*
15 * Injection points require --enable-injection-points.
16 */
17#ifdef USE_INJECTION_POINTS
18#define INJECTION_POINT_LOAD(name) InjectionPointLoad(name)
19#define INJECTION_POINT(name, arg) InjectionPointRun(name, arg)
20#define INJECTION_POINT_CACHED(name, arg) InjectionPointCached(name, arg)
21#define IS_INJECTION_POINT_ATTACHED(name) IsInjectionPointAttached(name)
22#else
23#define INJECTION_POINT_LOAD(name) ((void) name)
24#define INJECTION_POINT(name, arg) ((void) name)
25#define INJECTION_POINT_CACHED(name, arg) ((void) name)
26#define IS_INJECTION_POINT_ATTACHED(name) (false)
27#endif
28
29/*
30 * Typedef for callback function launched by an injection point.
31 */
32typedef void (*InjectionPointCallback) (const char *name,
33 const void *private_data,
34 void *arg);
35
36extern Size InjectionPointShmemSize(void);
37extern void InjectionPointShmemInit(void);
38
39extern void InjectionPointAttach(const char *name,
40 const char *library,
41 const char *function,
42 const void *private_data,
43 int private_data_size);
44extern void InjectionPointLoad(const char *name);
45extern void InjectionPointRun(const char *name, void *arg);
46extern void InjectionPointCached(const char *name, void *arg);
47extern bool IsInjectionPointAttached(const char *name);
48extern bool InjectionPointDetach(const char *name);
49
50#ifdef EXEC_BACKEND
51extern PGDLLIMPORT struct InjectionPointsCtl *ActiveInjectionPoints;
52#endif
53
54#endif /* INJECTION_POINT_H */
PGDLLIMPORT
#define PGDLLIMPORT
Definition: c.h:1291
Size
size_t Size
Definition: c.h:576
InjectionPointShmemInit
void InjectionPointShmemInit(void)
Definition: injection_point.c:249
InjectionPointShmemSize
Size InjectionPointShmemSize(void)
Definition: injection_point.c:233
InjectionPointLoad
void InjectionPointLoad(const char *name)
Definition: injection_point.c:531
InjectionPointDetach
bool InjectionPointDetach(const char *name)
Definition: injection_point.c:361
InjectionPointRun
void InjectionPointRun(const char *name, void *arg)
Definition: injection_point.c:544
IsInjectionPointAttached
bool IsInjectionPointAttached(const char *name)
Definition: injection_point.c:578
InjectionPointAttach
void InjectionPointAttach(const char *name, const char *library, const char *function, const void *private_data, int private_data_size)
Definition: injection_point.c:273
InjectionPointCallback
void(* InjectionPointCallback)(const char *name, const void *private_data, void *arg)
Definition: injection_point.h:32
InjectionPointCached
void InjectionPointCached(const char *name, void *arg)
Definition: injection_point.c:561
function
on_exit_nicely_callback function
Definition: pg_backup_utils.c:28
arg
void * arg
Definition: pg_backup_utils.c:29
name
const char * name
Definition: wait_event_funcs.c:28