test_slru.c File Reference

#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:

Go to the source code of this file.

Macros
#define	NUM_TEST_BUFFERS   16
#define	TestSlruCtl   (&TestSlruDesc)

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 void	test_slru_shmem_request (void *arg)
static bool	test_slru_page_precedes_logically (int64 page1, int64 page2)
static int	test_slru_errdetail_for_io_error (const void *opaque_data)
static bool	test_slru_scan_cb (SlruDesc *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)
void	_PG_init (void)

Variables
	PG_MODULE_MAGIC
static const char *	TestSlruDir = "pg_test_slru"
static SlruDesc	TestSlruDesc
static const ShmemCallbacks	test_slru_shmem_callbacks

Macro Definition Documentation

NUM_TEST_BUFFERS

#define NUM_TEST_BUFFERS   16

Definition at line 41 of file test_slru.c.

TestSlruCtl

#define TestSlruCtl   (&TestSlruDesc)

Definition at line 55 of file test_slru.c.

Function Documentation

_PG_init()

void _PG_init

(

void

)

Definition at line 216 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")));
 
    /*
     * Create the SLRU directory if it does not exist yet, from the root of
     * the data directory.
     */
    (void) MakePGDirectory(TestSlruDir);
 
    RegisterShmemCallbacks(&test_slru_shmem_callbacks);
}

References ereport, errdetail(), errmsg, ERROR, fb(), MakePGDirectory(), process_shared_preload_libraries_in_progress, RegisterShmemCallbacks(), test_slru_shmem_callbacks, and TestSlruDir.

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 193 of file test_slru.c.

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

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

test_slru_errdetail_for_io_error()

static int test_slru_errdetail_for_io_error ( const void *  opaque_data )

static

Definition at line 208 of file test_slru.c.

{
    TransactionId xid = *(const TransactionId *) opaque_data;
 
    return errdetail("Could not access test_slru entry %u.", xid);
}

References errdetail(), and fb().

Referenced by test_slru_shmem_request().

test_slru_page_delete()

Datum test_slru_page_delete

(

PG_FUNCTION_ARGS

)

Definition at line 169 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, fb(), 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 138 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 202 of file test_slru.c.

{
    return page1 < page2;
}

References fb().

Referenced by test_slru_shmem_request().

test_slru_page_read()

Datum test_slru_page_read

(

PG_FUNCTION_ARGS

)

Definition at line 100 of file test_slru.c.

{
    int64       pageno = PG_GETARG_INT64(0);
    bool        write_ok = PG_GETARG_BOOL(1);
    TransactionId xid = PG_GETARG_TRANSACTIONID(2);
    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, &xid);
    data = (char *) TestSlruCtl->shared->page_buffer[slotno];
    LWLockRelease(lock);
 
    PG_RETURN_TEXT_P(cstring_to_text(data));
}

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

test_slru_page_readonly()

Datum test_slru_page_readonly

(

PG_FUNCTION_ARGS

)

Definition at line 119 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,
                                        NULL);
    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, fb(), 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 152 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, fb(), 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 184 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 65 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, fb(), 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 93 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 ( SlruDesc *  ctl, char *  filename, int64  segpage, void *  data  )

static

Definition at line 58 of file test_slru.c.

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

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

Referenced by test_slru_delete_all().

test_slru_shmem_request()

static void test_slru_shmem_request ( void *  arg )

static

Definition at line 234 of file test_slru.c.

{
    SimpleLruRequest(.desc = &TestSlruDesc,
                     .name = "TestSLRU",
                     .Dir = TestSlruDir,
 
    /*
     * Short segments names are well tested elsewhere so in this test we are
     * focusing on long names.
     */
                     .long_segment_names = true,
 
                     .nslots = NUM_TEST_BUFFERS,
                     .nlsns = 0,
 
                     .sync_handler = SYNC_HANDLER_NONE,
                     .PagePrecedes = test_slru_page_precedes_logically,
                     .errdetail_for_io_error = test_slru_errdetail_for_io_error,
 
    /* let slru.c assign these */
                     .buffer_tranche_id = 0,
                     .bank_tranche_id = 0,
        );
}

References name, NUM_TEST_BUFFERS, SimpleLruRequest, SYNC_HANDLER_NONE, test_slru_errdetail_for_io_error(), test_slru_page_precedes_logically(), TestSlruDesc, and TestSlruDir.

Variable Documentation

PG_MODULE_MAGIC

PG_MODULE_MAGIC

Definition at line 25 of file test_slru.c.

test_slru_shmem_callbacks

const ShmemCallbacks test_slru_shmem_callbacks

static

Initial value:

= {
    .request_fn = test_slru_shmem_request
}

Definition at line 51 of file test_slru.c.

                                                        {
    .request_fn = test_slru_shmem_request
};

Referenced by _PG_init().

TestSlruDesc

SlruDesc TestSlruDesc

static

Definition at line 49 of file test_slru.c.

Referenced by test_slru_shmem_request().

TestSlruDir

const char* TestSlruDir = "pg_test_slru"

static

Definition at line 47 of file test_slru.c.

Referenced by _PG_init(), and test_slru_shmem_request().