itemid.h File Reference

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

Go to the source code of this file.

Data Structures
struct	ItemIdData

Macros
#define	LP_UNUSED   0 /* unused (should always have lp_len=0) */
#define	LP_NORMAL   1 /* used (should always have lp_len>0) */
#define	LP_REDIRECT   2 /* HOT redirect (should have lp_len=0) */
#define	LP_DEAD   3 /* dead, may or may not have storage */
#define	ItemIdGetLength(itemId)   ((itemId)->lp_len)
#define	ItemIdGetOffset(itemId)   ((itemId)->lp_off)
#define	ItemIdGetFlags(itemId)   ((itemId)->lp_flags)
#define	ItemIdGetRedirect(itemId)   ((itemId)->lp_off)
#define	ItemIdIsValid(itemId)   PointerIsValid(itemId)
#define	ItemIdIsUsed(itemId)   ((itemId)->lp_flags != LP_UNUSED)
#define	ItemIdIsNormal(itemId)   ((itemId)->lp_flags == LP_NORMAL)
#define	ItemIdIsRedirected(itemId)   ((itemId)->lp_flags == LP_REDIRECT)
#define	ItemIdIsDead(itemId)   ((itemId)->lp_flags == LP_DEAD)
#define	ItemIdHasStorage(itemId)   ((itemId)->lp_len != 0)
#define	ItemIdSetUnused(itemId)
#define	ItemIdSetNormal(itemId, off, len)
#define	ItemIdSetRedirect(itemId, link)
#define	ItemIdSetDead(itemId)
#define	ItemIdMarkDead(itemId)

Typedefs
typedef struct ItemIdData	ItemIdData
typedef ItemIdData *	ItemId
typedef uint16	ItemOffset
typedef uint16	ItemLength

Macro Definition Documentation

#define ItemIdGetFlags

(

itemId

)

((itemId)->lp_flags)

Definition at line 70 of file itemid.h.

Referenced by heap_page_items().

#define ItemIdGetLength

(

itemId

)

((itemId)->lp_len)

Definition at line 58 of file itemid.h.

Referenced by _bt_buildadd(), _bt_findsplitloc(), _bt_newroot(), _bt_split(), acquire_sample_rows(), bitgetpage(), BitmapHeapNext(), brin_doupdate(), brin_evacuate_page(), brinGetTupleForHeapBlock(), brininsert(), btree_xlog_split(), collect_corrupt_items(), GetTupleForTrigger(), heap_abort_speculative(), heap_delete(), heap_fetch(), heap_get_latest_tid(), heap_hot_search_buffer(), heap_inplace_update(), heap_lock_tuple(), heap_mask(), heap_page_is_all_visible(), heap_page_items(), heap_prune_chain(), heap_update(), heap_xlog_inplace(), heap_xlog_update(), heapgetpage(), heapgettup(), heapgettup_pagemode(), lazy_scan_heap(), PageIndexMultiDelete(), PageIndexTupleDelete(), PageIndexTupleDeleteNoCompact(), PageIndexTupleOverwrite(), PageRepairFragmentation(), pgstat_index_page(), read_seq_tuple(), statapprox_heap(), and tablesample_getnext().

#define ItemIdGetOffset

(

itemId

)

((itemId)->lp_off)

Definition at line 64 of file itemid.h.

Referenced by heap_mask(), heap_page_items(), PageIndexMultiDelete(), PageIndexTupleDelete(), PageIndexTupleDeleteNoCompact(), PageIndexTupleOverwrite(), and PageRepairFragmentation().

#define ItemIdGetRedirect

(

itemId

)

((itemId)->lp_off)

Definition at line 77 of file itemid.h.

Referenced by btree_xlog_delete_get_latestRemovedXid(), hash_xlog_vacuum_get_latestRemovedXid(), heap_get_root_tuples(), heap_hot_search_buffer(), and heap_prune_chain().

#define ItemIdHasStorage

(

itemId

)

((itemId)->lp_len != 0)

Definition at line 119 of file itemid.h.

Referenced by btree_xlog_delete_get_latestRemovedXid(), hash_xlog_vacuum_get_latestRemovedXid(), heap_mask(), heap_page_items(), PageAddItemExtended(), PageIndexMultiDelete(), PageIndexTupleDelete(), PageIndexTupleDeleteNoCompact(), PageIndexTupleOverwrite(), and PageRepairFragmentation().

#define ItemIdIsDead

(

itemId

)

((itemId)->lp_flags == LP_DEAD)

Definition at line 112 of file itemid.h.

Referenced by _bt_check_unique(), _bt_checkkeys(), _bt_vacuum_one_page(), _hash_splitbucket(), _hash_squeezebucket(), _hash_vacuum_one_page(), acquire_sample_rows(), btree_xlog_delete_get_latestRemovedXid(), collect_corrupt_items(), GetBTPageStatistics(), GetHashPageStatistics(), GetHashPageStats(), gistScanPage(), gistvacuumpage(), hash_xlog_vacuum_get_latestRemovedXid(), hashgetbitmap(), hashgettuple(), heap_get_root_tuples(), heap_page_is_all_visible(), heap_page_prune(), heap_prune_chain(), lazy_scan_heap(), pgstat_index_page(), and statapprox_heap().

#define ItemIdIsNormal

(

itemId

)

((itemId)->lp_flags == LP_NORMAL)

Definition at line 98 of file itemid.h.

Referenced by acquire_sample_rows(), bitgetpage(), BitmapHeapNext(), brin_doupdate(), GetTupleForTrigger(), heap_abort_speculative(), heap_delete(), heap_fetch(), heap_finish_speculative(), heap_get_latest_tid(), heap_get_root_tuples(), heap_hot_search_buffer(), heap_inplace_update(), heap_lock_tuple(), heap_mask(), heap_page_is_all_visible(), heap_prune_chain(), heap_update(), heap_xlog_confirm(), heap_xlog_delete(), heap_xlog_inplace(), heap_xlog_lock(), heap_xlog_lock_updated(), heap_xlog_update(), heapgetpage(), heapgettup(), heapgettup_pagemode(), lazy_check_needs_freeze(), lazy_scan_heap(), read_seq_tuple(), statapprox_heap(), and tablesample_getnext().

#define ItemIdIsRedirected

(

itemId

)

((itemId)->lp_flags == LP_REDIRECT)

Definition at line 105 of file itemid.h.

Referenced by btree_xlog_delete_get_latestRemovedXid(), collect_corrupt_items(), hash_xlog_vacuum_get_latestRemovedXid(), heap_get_root_tuples(), heap_hot_search_buffer(), heap_page_is_all_visible(), heap_prune_chain(), lazy_scan_heap(), and statapprox_heap().

#define ItemIdIsUsed

(

itemId

)

((itemId)->lp_flags != LP_UNUSED)

Definition at line 91 of file itemid.h.

Referenced by brin_evacuate_page(), brin_page_items(), brin_start_evacuating_page(), brinGetTupleForHeapBlock(), brinRevmapDesummarizeRange(), btree_xlog_delete_get_latestRemovedXid(), collect_corrupt_items(), count_nondeletable_pages(), hash_xlog_vacuum_get_latestRemovedXid(), heap_get_root_tuples(), heap_page_is_all_visible(), heap_page_prune(), heap_prune_chain(), lazy_check_needs_freeze(), lazy_scan_heap(), mask_lp_flags(), PageAddItemExtended(), PageGetHeapFreeSpace(), PageRepairFragmentation(), and statapprox_heap().

#define ItemIdIsValid

(

itemId

)

PointerIsValid(itemId)

Definition at line 85 of file itemid.h.

Referenced by bt_page_print_tuples(), and hash_page_items().

#define ItemIdMarkDead

(

itemId

)

Value:

( \
    (itemId)->lp_flags = LP_DEAD \
)

Definition at line 178 of file itemid.h.

Referenced by _bt_check_unique(), _bt_killitems(), _hash_kill_items(), and gistkillitems().

#define ItemIdSetDead

(

itemId

)

Value:

( \
    (itemId)->lp_flags = LP_DEAD, \
    (itemId)->lp_off = 0, \
    (itemId)->lp_len = 0 \
)

Definition at line 163 of file itemid.h.

Referenced by heap_page_prune_execute().

#define ItemIdSetNormal	(		itemId,
			off,
			len
	)

Value:

( \
    (itemId)->lp_flags = LP_NORMAL, \
    (itemId)->lp_off = (off), \
    (itemId)->lp_len = (len) \
)

Definition at line 139 of file itemid.h.

Referenced by PageAddItemExtended(), and PageIndexTupleOverwrite().

#define ItemIdSetRedirect	(		itemId,
			link
	)

Value:

( \
    (itemId)->lp_flags = LP_REDIRECT, \
    (itemId)->lp_off = (link), \
    (itemId)->lp_len = 0 \
)

Definition at line 151 of file itemid.h.

Referenced by heap_page_prune_execute().

#define ItemIdSetUnused

(

itemId

)

Value:

( \
    (itemId)->lp_flags = LP_UNUSED, \
    (itemId)->lp_off = 0, \
    (itemId)->lp_len = 0 \
)

Definition at line 127 of file itemid.h.

Referenced by _bt_buildadd(), heap_page_prune_execute(), lazy_vacuum_page(), PageIndexTupleDeleteNoCompact(), and PageRepairFragmentation().

#define LP_DEAD   3 /* dead, may or may not have storage */

Definition at line 40 of file itemid.h.

#define LP_NORMAL   1 /* used (should always have lp_len>0) */

Definition at line 38 of file itemid.h.

#define LP_REDIRECT   2 /* HOT redirect (should have lp_len=0) */

Definition at line 39 of file itemid.h.

#define LP_UNUSED   0 /* unused (should always have lp_len=0) */

Definition at line 37 of file itemid.h.

Referenced by mask_lp_flags().

Typedef Documentation

typedef ItemIdData* ItemId

Definition at line 31 of file itemid.h.

typedef struct ItemIdData ItemIdData

typedef uint16 ItemLength

Definition at line 47 of file itemid.h.

typedef uint16 ItemOffset

Definition at line 46 of file itemid.h.