#include "postgres.h"
#include "access/slru.h"
#include "access/transam.h"
#include "miscadmin.h"
#include "storage/fd.h"
#include "storage/ipc.h"
#include "storage/shmem.h"
#include "utils/builtins.h"

Include dependency graph for test_slru.c:

Macros
#define	NUM_TEST_BUFFERS 16

#define	TestSlruCtl (&TestSlruCtlData)

Functions
	PG_FUNCTION_INFO_V1 (test_slru_page_write)

	PG_FUNCTION_INFO_V1 (test_slru_page_writeall)

	PG_FUNCTION_INFO_V1 (test_slru_page_read)

	PG_FUNCTION_INFO_V1 (test_slru_page_readonly)

	PG_FUNCTION_INFO_V1 (test_slru_page_exists)

	PG_FUNCTION_INFO_V1 (test_slru_page_sync)

	PG_FUNCTION_INFO_V1 (test_slru_page_delete)

	PG_FUNCTION_INFO_V1 (test_slru_page_truncate)

	PG_FUNCTION_INFO_V1 (test_slru_delete_all)

static bool	test_slru_scan_cb (SlruCtl ctl, char filename, int64 segpage, void data)

Datum	test_slru_page_write (PG_FUNCTION_ARGS)

Datum	test_slru_page_writeall (PG_FUNCTION_ARGS)

Datum	test_slru_page_read (PG_FUNCTION_ARGS)

Datum	test_slru_page_readonly (PG_FUNCTION_ARGS)

Datum	test_slru_page_exists (PG_FUNCTION_ARGS)

Datum	test_slru_page_sync (PG_FUNCTION_ARGS)

Datum	test_slru_page_delete (PG_FUNCTION_ARGS)

Datum	test_slru_page_truncate (PG_FUNCTION_ARGS)

Datum	test_slru_delete_all (PG_FUNCTION_ARGS)

static void	test_slru_shmem_request (void)

static bool	test_slru_page_precedes_logically (int64 page1, int64 page2)

static void	test_slru_shmem_startup (void)

void	_PG_init (void)

Variables
	PG_MODULE_MAGIC

static SlruCtlData	TestSlruCtlData

static shmem_request_hook_type	prev_shmem_request_hook = NULL

static shmem_startup_hook_type	prev_shmem_startup_hook = NULL

Macro Definition Documentation

◆ NUM_TEST_BUFFERS

#define NUM_TEST_BUFFERS 16

Definition at line 41 of file test_slru.c.

◆ TestSlruCtl

#define TestSlruCtl (&TestSlruCtlData)

Definition at line 44 of file test_slru.c.

Function Documentation

◆ _PG_init()

void _PG_init ( void )

Definition at line 249 of file test_slru.c.

{
    if (!process_shared_preload_libraries_in_progress)
        ereport(ERROR,
                (errmsg("cannot load \"%s\" after startup", "test_slru"),
                 errdetail("\"%s\" must be loaded with \"shared_preload_libraries\".",
                           "test_slru")));
 
    prev_shmem_request_hook = shmem_request_hook;
    shmem_request_hook = test_slru_shmem_request;
 
    prev_shmem_startup_hook = shmem_startup_hook;
    shmem_startup_hook = test_slru_shmem_startup;
}

References ereport, errdetail(), errmsg(), ERROR, prev_shmem_request_hook, prev_shmem_startup_hook, process_shared_preload_libraries_in_progress, shmem_request_hook, shmem_startup_hook, test_slru_shmem_request(), and test_slru_shmem_startup().

◆ PG_FUNCTION_INFO_V1() [1/9]

PG_FUNCTION_INFO_V1 ( test_slru_delete_all )

◆ PG_FUNCTION_INFO_V1() [2/9]

PG_FUNCTION_INFO_V1 ( test_slru_page_delete )

◆ PG_FUNCTION_INFO_V1() [3/9]

PG_FUNCTION_INFO_V1 ( test_slru_page_exists )

◆ PG_FUNCTION_INFO_V1() [4/9]

PG_FUNCTION_INFO_V1 ( test_slru_page_read )

◆ PG_FUNCTION_INFO_V1() [5/9]

PG_FUNCTION_INFO_V1 ( test_slru_page_readonly )

◆ PG_FUNCTION_INFO_V1() [6/9]

PG_FUNCTION_INFO_V1 ( test_slru_page_sync )

◆ PG_FUNCTION_INFO_V1() [7/9]

PG_FUNCTION_INFO_V1 ( test_slru_page_truncate )

◆ PG_FUNCTION_INFO_V1() [8/9]

PG_FUNCTION_INFO_V1 ( test_slru_page_write )

◆ PG_FUNCTION_INFO_V1() [9/9]

PG_FUNCTION_INFO_V1 ( test_slru_page_writeall )

◆ test_slru_delete_all()

Datum test_slru_delete_all ( PG_FUNCTION_ARGS )

Definition at line 185 of file test_slru.c.

{
    /* this calls SlruScanDirCbDeleteAll() internally, ensuring deletion */
    SlruScanDirectory(TestSlruCtl, test_slru_scan_cb, NULL);
 
    PG_RETURN_VOID();
}

References PG_RETURN_VOID, SlruScanDirectory(), test_slru_scan_cb(), and TestSlruCtl.

◆ test_slru_page_delete()

Datum test_slru_page_delete ( PG_FUNCTION_ARGS )

Definition at line 161 of file test_slru.c.

{
    int64       pageno = PG_GETARG_INT64(0);
    FileTag     ftag;
 
    ftag.segno = pageno / SLRU_PAGES_PER_SEGMENT;
    SlruDeleteSegment(TestSlruCtl, ftag.segno);
 
    elog(NOTICE, "Called SlruDeleteSegment() for segment %" PRIu64,
         ftag.segno);
 
    PG_RETURN_VOID();
}

References elog, NOTICE, PG_GETARG_INT64, PG_RETURN_VOID, FileTag::segno, SLRU_PAGES_PER_SEGMENT, SlruDeleteSegment(), and TestSlruCtl.

◆ test_slru_page_exists()

Datum test_slru_page_exists ( PG_FUNCTION_ARGS )

Definition at line 130 of file test_slru.c.

{
    int64       pageno = PG_GETARG_INT64(0);
    bool        found;
    LWLock     *lock = SimpleLruGetBankLock(TestSlruCtl, pageno);
 
    LWLockAcquire(lock, LW_EXCLUSIVE);
    found = SimpleLruDoesPhysicalPageExist(TestSlruCtl, pageno);
    LWLockRelease(lock);
 
    PG_RETURN_BOOL(found);
}

References LW_EXCLUSIVE, LWLockAcquire(), LWLockRelease(), PG_GETARG_INT64, PG_RETURN_BOOL, SimpleLruDoesPhysicalPageExist(), SimpleLruGetBankLock(), and TestSlruCtl.

◆ test_slru_page_precedes_logically()

static bool test_slru_page_precedes_logically	(	int64	page1,
		int64	page2
	)

static

Definition at line 208 of file test_slru.c.

{
    return page1 < page2;
}

Referenced by test_slru_shmem_startup().

◆ test_slru_page_read()

Datum test_slru_page_read ( PG_FUNCTION_ARGS )

Definition at line 92 of file test_slru.c.

{
    int64       pageno = PG_GETARG_INT64(0);
    bool        write_ok = PG_GETARG_BOOL(1);
    char       *data = NULL;
    int         slotno;
    LWLock     *lock = SimpleLruGetBankLock(TestSlruCtl, pageno);
 
    /* find page in buffers, reading it if necessary */
    LWLockAcquire(lock, LW_EXCLUSIVE);
    slotno = SimpleLruReadPage(TestSlruCtl, pageno,
                               write_ok, InvalidTransactionId);
    data = (char *) TestSlruCtl->shared->page_buffer[slotno];
    LWLockRelease(lock);
 
    PG_RETURN_TEXT_P(cstring_to_text(data));
}

References cstring_to_text(), data, InvalidTransactionId, LW_EXCLUSIVE, LWLockAcquire(), LWLockRelease(), PG_GETARG_BOOL, PG_GETARG_INT64, PG_RETURN_TEXT_P, SimpleLruGetBankLock(), SimpleLruReadPage(), and TestSlruCtl.

◆ test_slru_page_readonly()

Datum test_slru_page_readonly ( PG_FUNCTION_ARGS )

Definition at line 111 of file test_slru.c.

{
    int64       pageno = PG_GETARG_INT64(0);
    char       *data = NULL;
    int         slotno;
    LWLock     *lock = SimpleLruGetBankLock(TestSlruCtl, pageno);
 
    /* find page in buffers, reading it if necessary */
    slotno = SimpleLruReadPage_ReadOnly(TestSlruCtl,
                                        pageno,
                                        InvalidTransactionId);
    Assert(LWLockHeldByMe(lock));
    data = (char *) TestSlruCtl->shared->page_buffer[slotno];
    LWLockRelease(lock);
 
    PG_RETURN_TEXT_P(cstring_to_text(data));
}

References Assert(), cstring_to_text(), data, InvalidTransactionId, LWLockHeldByMe(), LWLockRelease(), PG_GETARG_INT64, PG_RETURN_TEXT_P, SimpleLruGetBankLock(), SimpleLruReadPage_ReadOnly(), and TestSlruCtl.

◆ test_slru_page_sync()

Datum test_slru_page_sync ( PG_FUNCTION_ARGS )

Definition at line 144 of file test_slru.c.

{
    int64       pageno = PG_GETARG_INT64(0);
    FileTag     ftag;
    char        path[MAXPGPATH];
 
    /* note that this flushes the full file a segment is located in */
    ftag.segno = pageno / SLRU_PAGES_PER_SEGMENT;
    SlruSyncFileTag(TestSlruCtl, &ftag, path);
 
    elog(NOTICE, "Called SlruSyncFileTag() for segment %" PRIu64 " on path %s",
         ftag.segno, path);
 
    PG_RETURN_VOID();
}

References elog, MAXPGPATH, NOTICE, PG_GETARG_INT64, PG_RETURN_VOID, FileTag::segno, SLRU_PAGES_PER_SEGMENT, SlruSyncFileTag(), and TestSlruCtl.

◆ test_slru_page_truncate()

Datum test_slru_page_truncate ( PG_FUNCTION_ARGS )

Definition at line 176 of file test_slru.c.

{
    int64       pageno = PG_GETARG_INT64(0);
 
    SimpleLruTruncate(TestSlruCtl, pageno);
    PG_RETURN_VOID();
}

References PG_GETARG_INT64, PG_RETURN_VOID, SimpleLruTruncate(), and TestSlruCtl.

◆ test_slru_page_write()

Datum test_slru_page_write ( PG_FUNCTION_ARGS )

Definition at line 57 of file test_slru.c.

{
    int64       pageno = PG_GETARG_INT64(0);
    char       *data = text_to_cstring(PG_GETARG_TEXT_PP(1));
    int         slotno;
    LWLock     *lock = SimpleLruGetBankLock(TestSlruCtl, pageno);
 
    LWLockAcquire(lock, LW_EXCLUSIVE);
    slotno = SimpleLruZeroPage(TestSlruCtl, pageno);
 
    /* these should match */
    Assert(TestSlruCtl->shared->page_number[slotno] == pageno);
 
    /* mark the page as dirty so as it would get written */
    TestSlruCtl->shared->page_dirty[slotno] = true;
    TestSlruCtl->shared->page_status[slotno] = SLRU_PAGE_VALID;
 
    /* write given data to the page, up to the limit of the page */
    strncpy(TestSlruCtl->shared->page_buffer[slotno], data,
            BLCKSZ - 1);
 
    SimpleLruWritePage(TestSlruCtl, slotno);
    LWLockRelease(lock);
 
    PG_RETURN_VOID();
}

References Assert(), data, LW_EXCLUSIVE, LWLockAcquire(), LWLockRelease(), PG_GETARG_INT64, PG_GETARG_TEXT_PP, PG_RETURN_VOID, SimpleLruGetBankLock(), SimpleLruWritePage(), SimpleLruZeroPage(), SLRU_PAGE_VALID, TestSlruCtl, and text_to_cstring().

◆ test_slru_page_writeall()

Datum test_slru_page_writeall ( PG_FUNCTION_ARGS )

Definition at line 85 of file test_slru.c.

{
    SimpleLruWriteAll(TestSlruCtl, true);
    PG_RETURN_VOID();
}

References PG_RETURN_VOID, SimpleLruWriteAll(), and TestSlruCtl.

◆ test_slru_scan_cb()

static bool test_slru_scan_cb	(	SlruCtl	ctl,
		char *	filename,
		int64	segpage,
		void *	data
	)

static

Definition at line 50 of file test_slru.c.

{
    elog(NOTICE, "Calling test_slru_scan_cb()");
    return SlruScanDirCbDeleteAll(ctl, filename, segpage, data);
}

References ctl, data, elog, filename, NOTICE, and SlruScanDirCbDeleteAll().

Referenced by test_slru_delete_all().

◆ test_slru_shmem_request()

static void test_slru_shmem_request ( void )

static

Definition at line 198 of file test_slru.c.

{
    if (prev_shmem_request_hook)
        prev_shmem_request_hook();
 
    /* reserve shared memory for the test SLRU */
    RequestAddinShmemSpace(SimpleLruShmemSize(NUM_TEST_BUFFERS, 0));
}

References NUM_TEST_BUFFERS, prev_shmem_request_hook, RequestAddinShmemSpace(), and SimpleLruShmemSize().

Referenced by _PG_init().

◆ test_slru_shmem_startup()

static void test_slru_shmem_startup ( void )

static

Definition at line 214 of file test_slru.c.

{
    /*
     * Short segments names are well tested elsewhere so in this test we are
     * focusing on long names.
     */
    const bool  long_segment_names = true;
    const char  slru_dir_name[] = "pg_test_slru";
    int         test_tranche_id;
    int         test_buffer_tranche_id;
 
    if (prev_shmem_startup_hook)
        prev_shmem_startup_hook();
 
    /*
     * Create the SLRU directory if it does not exist yet, from the root of
     * the data directory.
     */
    (void) MakePGDirectory(slru_dir_name);
 
    /* initialize the SLRU facility */
    test_tranche_id = LWLockNewTrancheId();
    LWLockRegisterTranche(test_tranche_id, "test_slru_tranche");
 
    test_buffer_tranche_id = LWLockNewTrancheId();
    LWLockRegisterTranche(test_tranche_id, "test_buffer_tranche");
 
    TestSlruCtl->PagePrecedes = test_slru_page_precedes_logically;
    SimpleLruInit(TestSlruCtl, "TestSLRU",
                  NUM_TEST_BUFFERS, 0, slru_dir_name,
                  test_buffer_tranche_id, test_tranche_id, SYNC_HANDLER_NONE,
                  long_segment_names);
}

References LWLockNewTrancheId(), LWLockRegisterTranche(), MakePGDirectory(), NUM_TEST_BUFFERS, prev_shmem_startup_hook, SimpleLruInit(), SYNC_HANDLER_NONE, test_slru_page_precedes_logically(), and TestSlruCtl.

Referenced by _PG_init().

Variable Documentation

◆ PG_MODULE_MAGIC

PG_MODULE_MAGIC

Definition at line 25 of file test_slru.c.

◆ prev_shmem_request_hook

shmem_request_hook_type prev_shmem_request_hook = NULL

static

Definition at line 46 of file test_slru.c.

Referenced by _PG_init(), and test_slru_shmem_request().

◆ prev_shmem_startup_hook

shmem_startup_hook_type prev_shmem_startup_hook = NULL

static

Definition at line 47 of file test_slru.c.

Referenced by _PG_init(), and test_slru_shmem_startup().

◆ TestSlruCtlData

SlruCtlData TestSlruCtlData

static

Definition at line 43 of file test_slru.c.

Macros

Functions

Variables

Macro Definition Documentation

◆ NUM_TEST_BUFFERS

◆ TestSlruCtl

Function Documentation

◆ _PG_init()

◆ PG_FUNCTION_INFO_V1() [1/9]

◆ PG_FUNCTION_INFO_V1() [2/9]

◆ PG_FUNCTION_INFO_V1() [3/9]

◆ PG_FUNCTION_INFO_V1() [4/9]

◆ PG_FUNCTION_INFO_V1() [5/9]

◆ PG_FUNCTION_INFO_V1() [6/9]

◆ PG_FUNCTION_INFO_V1() [7/9]

◆ PG_FUNCTION_INFO_V1() [8/9]

◆ PG_FUNCTION_INFO_V1() [9/9]

◆ test_slru_delete_all()

◆ test_slru_page_delete()

◆ test_slru_page_exists()

◆ test_slru_page_precedes_logically()

◆ test_slru_page_read()

◆ test_slru_page_readonly()

◆ test_slru_page_sync()

◆ test_slru_page_truncate()

◆ test_slru_page_write()

◆ test_slru_page_writeall()

◆ test_slru_scan_cb()

◆ test_slru_shmem_request()

◆ test_slru_shmem_startup()

Variable Documentation

◆ PG_MODULE_MAGIC

◆ prev_shmem_request_hook

◆ prev_shmem_startup_hook

◆ TestSlruCtlData