#include "postgres.h"
#include "fmgr.h"
#include "miscadmin.h"
#include "nodes/pg_list.h"
#include "nodes/value.h"
#include "storage/condition_variable.h"
#include "storage/dsm_registry.h"
#include "storage/ipc.h"
#include "storage/lwlock.h"
#include "storage/shmem.h"
#include "utils/builtins.h"
#include "utils/injection_point.h"
#include "utils/memutils.h"
#include "utils/wait_event.h"

Include dependency graph for injection_points.c:

Data Structures
struct	InjectionPointCondition

struct	InjectionPointSharedState

Macros
#define	INJ_MAX_WAIT 8

#define	INJ_NAME_MAXLEN 64

Typedefs
typedef enum InjectionPointConditionType	InjectionPointConditionType

typedef struct InjectionPointCondition	InjectionPointCondition

typedef struct InjectionPointSharedState	InjectionPointSharedState

Enumerations
enum	InjectionPointConditionType { INJ_CONDITION_ALWAYS = 0 , INJ_CONDITION_PID }

Functions
PGDLLEXPORT void	injection_error (const char name, const void private_data)

PGDLLEXPORT void	injection_notice (const char name, const void private_data)

PGDLLEXPORT void	injection_wait (const char name, const void private_data)

static void	injection_point_init_state (void *ptr)

static void	injection_init_shmem (void)

static bool	injection_point_allowed (InjectionPointCondition *condition)

static void	injection_points_cleanup (int code, Datum arg)

	PG_FUNCTION_INFO_V1 (injection_points_attach)

Datum	injection_points_attach (PG_FUNCTION_ARGS)

	PG_FUNCTION_INFO_V1 (injection_points_load)

Datum	injection_points_load (PG_FUNCTION_ARGS)

	PG_FUNCTION_INFO_V1 (injection_points_run)

Datum	injection_points_run (PG_FUNCTION_ARGS)

	PG_FUNCTION_INFO_V1 (injection_points_cached)

Datum	injection_points_cached (PG_FUNCTION_ARGS)

	PG_FUNCTION_INFO_V1 (injection_points_wakeup)

Datum	injection_points_wakeup (PG_FUNCTION_ARGS)

	PG_FUNCTION_INFO_V1 (injection_points_set_local)

Datum	injection_points_set_local (PG_FUNCTION_ARGS)

	PG_FUNCTION_INFO_V1 (injection_points_detach)

Datum	injection_points_detach (PG_FUNCTION_ARGS)

Variables
	PG_MODULE_MAGIC

static List *	inj_list_local = NIL

static InjectionPointSharedState *	inj_state = NULL

static bool	injection_point_local = false

Macro Definition Documentation

◆ INJ_MAX_WAIT

#define INJ_MAX_WAIT 8

Definition at line 37 of file injection_points.c.

◆ INJ_NAME_MAXLEN

#define INJ_NAME_MAXLEN 64

Definition at line 38 of file injection_points.c.

Typedef Documentation

◆ InjectionPointCondition

typedef struct InjectionPointCondition InjectionPointCondition

◆ InjectionPointConditionType

typedef enum InjectionPointConditionType InjectionPointConditionType

◆ InjectionPointSharedState

typedef struct InjectionPointSharedState InjectionPointSharedState

Enumeration Type Documentation

◆ InjectionPointConditionType

enum InjectionPointConditionType

Enumerator
INJ_CONDITION_ALWAYS
INJ_CONDITION_PID

Definition at line 49 of file injection_points.c.

 {
     INJ_CONDITION_ALWAYS = 0,   /* always run */
     INJ_CONDITION_PID,          /* PID restriction */
 } InjectionPointConditionType;

Function Documentation

◆ injection_error()

void injection_error	(	const char *	name,
		const void *	private_data
	)

Definition at line 178 of file injection_points.c.

 {
     InjectionPointCondition *condition = (InjectionPointCondition *) private_data;
  
     if (!injection_point_allowed(condition))
         return;
  
     elog(ERROR, "error triggered for injection point %s", name);
 }

References elog, ERROR, injection_point_allowed(), and name.

◆ injection_init_shmem()

static void injection_init_shmem ( void )

static

Definition at line 117 of file injection_points.c.

 {
     bool        found;
  
     if (inj_state != NULL)
         return;
  
     inj_state = GetNamedDSMSegment("injection_points",
                                    sizeof(InjectionPointSharedState),
                                    injection_point_init_state,
                                    &found);
 }

References GetNamedDSMSegment(), inj_state, and injection_point_init_state().

Referenced by injection_points_load(), injection_points_set_local(), injection_points_wakeup(), and injection_wait().

◆ injection_notice()

void injection_notice	(	const char *	name,
		const void *	private_data
	)

Definition at line 189 of file injection_points.c.

 {
     InjectionPointCondition *condition = (InjectionPointCondition *) private_data;
  
     if (!injection_point_allowed(condition))
         return;
  
     elog(NOTICE, "notice triggered for injection point %s", name);
 }

References elog, injection_point_allowed(), name, and NOTICE.

◆ injection_point_allowed()

static bool injection_point_allowed ( InjectionPointCondition * condition )

static

Definition at line 137 of file injection_points.c.

 {
     bool        result = true;
  
     switch (condition->type)
     {
         case INJ_CONDITION_PID:
             if (MyProcPid != condition->pid)
                 result = false;
             break;
         case INJ_CONDITION_ALWAYS:
             break;
     }
  
     return result;
 }

References INJ_CONDITION_ALWAYS, INJ_CONDITION_PID, MyProcPid, InjectionPointCondition::pid, and InjectionPointCondition::type.

Referenced by injection_error(), injection_notice(), and injection_wait().

◆ injection_point_init_state()

static void injection_point_init_state ( void * ptr )

static

Definition at line 103 of file injection_points.c.

 {
     InjectionPointSharedState *state = (InjectionPointSharedState *) ptr;
  
     SpinLockInit(&state->lock);
     memset(state->wait_counts, 0, sizeof(state->wait_counts));
     memset(state->name, 0, sizeof(state->name));
     ConditionVariableInit(&state->wait_point);
 }

References ConditionVariableInit(), and SpinLockInit.

Referenced by injection_init_shmem().

◆ injection_points_attach()

Datum injection_points_attach ( PG_FUNCTION_ARGS )

Definition at line 268 of file injection_points.c.

 {
     char       *name = text_to_cstring(PG_GETARG_TEXT_PP(0));
     char       *action = text_to_cstring(PG_GETARG_TEXT_PP(1));
     char       *function;
     InjectionPointCondition condition = {0};
  
     if (strcmp(action, "error") == 0)
         function = "injection_error";
     else if (strcmp(action, "notice") == 0)
         function = "injection_notice";
     else if (strcmp(action, "wait") == 0)
         function = "injection_wait";
     else
         elog(ERROR, "incorrect action \"%s\" for injection point creation", action);
  
     if (injection_point_local)
     {
         condition.type = INJ_CONDITION_PID;
         condition.pid = MyProcPid;
     }
  
     InjectionPointAttach(name, "injection_points", function, &condition,
                          sizeof(InjectionPointCondition));
  
     if (injection_point_local)
     {
         MemoryContext oldctx;
  
         /* Local injection point, so track it for automated cleanup */
         oldctx = MemoryContextSwitchTo(TopMemoryContext);
         inj_list_local = lappend(inj_list_local, makeString(pstrdup(name)));
         MemoryContextSwitchTo(oldctx);
     }
     PG_RETURN_VOID();
 }

References generate_unaccent_rules::action, elog, ERROR, INJ_CONDITION_PID, inj_list_local, injection_point_local, InjectionPointAttach(), lappend(), makeString(), MemoryContextSwitchTo(), MyProcPid, name, PG_GETARG_TEXT_PP, PG_RETURN_VOID, InjectionPointCondition::pid, pstrdup(), text_to_cstring(), TopMemoryContext, and InjectionPointCondition::type.

◆ injection_points_cached()

Datum injection_points_cached ( PG_FUNCTION_ARGS )

Definition at line 341 of file injection_points.c.

 {
     char       *name = text_to_cstring(PG_GETARG_TEXT_PP(0));
  
     INJECTION_POINT_CACHED(name);
  
     PG_RETURN_VOID();
 }

References INJECTION_POINT_CACHED, name, PG_GETARG_TEXT_PP, PG_RETURN_VOID, and text_to_cstring().

◆ injection_points_cleanup()

static void injection_points_cleanup	(	int	code,
		Datum	arg
	)

static

Definition at line 159 of file injection_points.c.

 {
     ListCell   *lc;
  
     /* Leave if nothing is tracked locally */
     if (!injection_point_local)
         return;
  
     /* Detach all the local points */
     foreach(lc, inj_list_local)
     {
         char       *name = strVal(lfirst(lc));
  
         (void) InjectionPointDetach(name);
     }
 }

References inj_list_local, injection_point_local, InjectionPointDetach(), lfirst, name, and strVal.

Referenced by injection_points_set_local().

◆ injection_points_detach()

Datum injection_points_detach ( PG_FUNCTION_ARGS )

Definition at line 417 of file injection_points.c.

 {
     char       *name = text_to_cstring(PG_GETARG_TEXT_PP(0));
  
     if (!InjectionPointDetach(name))
         elog(ERROR, "could not detach injection point \"%s\"", name);
  
     /* Remove point from local list, if required */
     if (inj_list_local != NIL)
     {
         MemoryContext oldctx;
  
         oldctx = MemoryContextSwitchTo(TopMemoryContext);
         inj_list_local = list_delete(inj_list_local, makeString(name));
         MemoryContextSwitchTo(oldctx);
     }
  
     PG_RETURN_VOID();
 }

References elog, ERROR, inj_list_local, InjectionPointDetach(), list_delete(), makeString(), MemoryContextSwitchTo(), name, NIL, PG_GETARG_TEXT_PP, PG_RETURN_VOID, text_to_cstring(), and TopMemoryContext.

◆ injection_points_load()

Datum injection_points_load ( PG_FUNCTION_ARGS )

Definition at line 310 of file injection_points.c.

 {
     char       *name = text_to_cstring(PG_GETARG_TEXT_PP(0));
  
     if (inj_state == NULL)
         injection_init_shmem();
  
     INJECTION_POINT_LOAD(name);
  
     PG_RETURN_VOID();
 }

References inj_state, injection_init_shmem(), INJECTION_POINT_LOAD, name, PG_GETARG_TEXT_PP, PG_RETURN_VOID, and text_to_cstring().

◆ injection_points_run()

Datum injection_points_run ( PG_FUNCTION_ARGS )

Definition at line 327 of file injection_points.c.

 {
     char       *name = text_to_cstring(PG_GETARG_TEXT_PP(0));
  
     INJECTION_POINT(name);
  
     PG_RETURN_VOID();
 }

References INJECTION_POINT, name, PG_GETARG_TEXT_PP, PG_RETURN_VOID, and text_to_cstring().

◆ injection_points_set_local()

Datum injection_points_set_local ( PG_FUNCTION_ARGS )

Definition at line 395 of file injection_points.c.

 {
     /* Enable flag to add a runtime condition based on this process ID */
     injection_point_local = true;
  
     if (inj_state == NULL)
         injection_init_shmem();
  
     /*
      * Register a before_shmem_exit callback to remove any injection points
      * linked to this process.
      */
     before_shmem_exit(injection_points_cleanup, (Datum) 0);
  
     PG_RETURN_VOID();
 }

References before_shmem_exit(), inj_state, injection_init_shmem(), injection_point_local, injection_points_cleanup(), and PG_RETURN_VOID.

◆ injection_points_wakeup()

Datum injection_points_wakeup ( PG_FUNCTION_ARGS )

Definition at line 355 of file injection_points.c.

 {
     char       *name = text_to_cstring(PG_GETARG_TEXT_PP(0));
     int         index = -1;
  
     if (inj_state == NULL)
         injection_init_shmem();
  
     /* First bump the wait counter for the injection point to wake up */
     SpinLockAcquire(&inj_state->lock);
     for (int i = 0; i < INJ_MAX_WAIT; i++)
     {
         if (strcmp(name, inj_state->name[i]) == 0)
         {
             index = i;
             break;
         }
     }
     if (index < 0)
     {
         SpinLockRelease(&inj_state->lock);
         elog(ERROR, "could not find injection point %s to wake up", name);
     }
     inj_state->wait_counts[index]++;
     SpinLockRelease(&inj_state->lock);
  
     /* And broadcast the change to the waiters */
     ConditionVariableBroadcast(&inj_state->wait_point);
     PG_RETURN_VOID();
 }

References ConditionVariableBroadcast(), elog, ERROR, i, INJ_MAX_WAIT, inj_state, injection_init_shmem(), InjectionPointSharedState::lock, name, InjectionPointSharedState::name, PG_GETARG_TEXT_PP, PG_RETURN_VOID, SpinLockAcquire, SpinLockRelease, text_to_cstring(), InjectionPointSharedState::wait_counts, and InjectionPointSharedState::wait_point.

◆ injection_wait()

void injection_wait	(	const char *	name,
		const void *	private_data
	)

Definition at line 201 of file injection_points.c.

 {
     uint32      old_wait_counts = 0;
     int         index = -1;
     uint32      injection_wait_event = 0;
     InjectionPointCondition *condition = (InjectionPointCondition *) private_data;
  
     if (inj_state == NULL)
         injection_init_shmem();
  
     if (!injection_point_allowed(condition))
         return;
  
     /*
      * Use the injection point name for this custom wait event.  Note that
      * this custom wait event name is not released, but we don't care much for
      * testing as this should be short-lived.
      */
     injection_wait_event = WaitEventInjectionPointNew(name);
  
     /*
      * Find a free slot to wait for, and register this injection point's name.
      */
     SpinLockAcquire(&inj_state->lock);
     for (int i = 0; i < INJ_MAX_WAIT; i++)
     {
         if (inj_state->name[i][0] == '\0')
         {
             index = i;
             strlcpy(inj_state->name[i], name, INJ_NAME_MAXLEN);
             old_wait_counts = inj_state->wait_counts[i];
             break;
         }
     }
     SpinLockRelease(&inj_state->lock);
  
     if (index < 0)
         elog(ERROR, "could not find free slot for wait of injection point %s ",
              name);
  
     /* And sleep.. */
     ConditionVariablePrepareToSleep(&inj_state->wait_point);
     for (;;)
     {
         uint32      new_wait_counts;
  
         SpinLockAcquire(&inj_state->lock);
         new_wait_counts = inj_state->wait_counts[index];
         SpinLockRelease(&inj_state->lock);
  
         if (old_wait_counts != new_wait_counts)
             break;
         ConditionVariableSleep(&inj_state->wait_point, injection_wait_event);
     }
     ConditionVariableCancelSleep();
  
     /* Remove this injection point from the waiters. */
     SpinLockAcquire(&inj_state->lock);
     inj_state->name[index][0] = '\0';
     SpinLockRelease(&inj_state->lock);
 }

References ConditionVariableCancelSleep(), ConditionVariablePrepareToSleep(), ConditionVariableSleep(), elog, ERROR, i, INJ_MAX_WAIT, INJ_NAME_MAXLEN, inj_state, injection_init_shmem(), injection_point_allowed(), InjectionPointSharedState::lock, name, InjectionPointSharedState::name, SpinLockAcquire, SpinLockRelease, strlcpy(), InjectionPointSharedState::wait_counts, InjectionPointSharedState::wait_point, and WaitEventInjectionPointNew().

◆ PG_FUNCTION_INFO_V1() [1/7]

PG_FUNCTION_INFO_V1 ( injection_points_attach )

◆ PG_FUNCTION_INFO_V1() [2/7]

PG_FUNCTION_INFO_V1 ( injection_points_cached )

◆ PG_FUNCTION_INFO_V1() [3/7]

PG_FUNCTION_INFO_V1 ( injection_points_detach )

◆ PG_FUNCTION_INFO_V1() [4/7]

PG_FUNCTION_INFO_V1 ( injection_points_load )

◆ PG_FUNCTION_INFO_V1() [5/7]

PG_FUNCTION_INFO_V1 ( injection_points_run )

◆ PG_FUNCTION_INFO_V1() [6/7]

PG_FUNCTION_INFO_V1 ( injection_points_set_local )

◆ PG_FUNCTION_INFO_V1() [7/7]

PG_FUNCTION_INFO_V1 ( injection_points_wakeup )

Variable Documentation

◆ inj_list_local

List* inj_list_local = NIL

static

Definition at line 68 of file injection_points.c.

Referenced by injection_points_attach(), injection_points_cleanup(), and injection_points_detach().

◆ inj_state

InjectionPointSharedState* inj_state = NULL

static

Definition at line 87 of file injection_points.c.

Referenced by injection_init_shmem(), injection_points_load(), injection_points_set_local(), injection_points_wakeup(), and injection_wait().

◆ injection_point_local

bool injection_point_local = false

static

Definition at line 97 of file injection_points.c.

Referenced by injection_points_attach(), injection_points_cleanup(), and injection_points_set_local().

◆ PG_MODULE_MAGIC

PG_MODULE_MAGIC

Definition at line 34 of file injection_points.c.

Data Structures

Macros

Typedefs

Enumerations

Functions

Variables

Macro Definition Documentation

◆ INJ_MAX_WAIT

◆ INJ_NAME_MAXLEN

Typedef Documentation

◆ InjectionPointCondition

◆ InjectionPointConditionType

◆ InjectionPointSharedState

Enumeration Type Documentation

◆ InjectionPointConditionType

Function Documentation

◆ injection_error()

◆ injection_init_shmem()

◆ injection_notice()

◆ injection_point_allowed()

◆ injection_point_init_state()

◆ injection_points_attach()

◆ injection_points_cached()

◆ injection_points_cleanup()

◆ injection_points_detach()

◆ injection_points_load()

◆ injection_points_run()

◆ injection_points_set_local()

◆ injection_points_wakeup()

◆ injection_wait()

◆ PG_FUNCTION_INFO_V1() [1/7]

◆ PG_FUNCTION_INFO_V1() [2/7]

◆ PG_FUNCTION_INFO_V1() [3/7]

◆ PG_FUNCTION_INFO_V1() [4/7]

◆ PG_FUNCTION_INFO_V1() [5/7]

◆ PG_FUNCTION_INFO_V1() [6/7]

◆ PG_FUNCTION_INFO_V1() [7/7]

Variable Documentation

◆ inj_list_local

◆ inj_state

◆ injection_point_local

◆ PG_MODULE_MAGIC