#include "object_representation_constants.h"
#include "oid.h"
#include "storage_common.h"
#include "thread_compat.hpp"

Include dependency graph for locator.h:

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

Go to the source code of this file.

Classes
struct	lc_copyarea_oneobj

struct	lc_copyarea_manyobjs

struct	lc_copy_area

struct	lc_copyarea_desc

struct	lc_lockset_reqobj

struct	lc_lockset_classof

struct	lc_lock_set

struct	lc_lockhint_class

struct	lc_lock_hint

struct	lc_oidmap

struct	lc_class_oidset

struct	lc_oidset

Macros
#define	LC_AREA_ONEOBJ_PACKED_SIZE

#define	LC_MANYOBJS_PTR_IN_COPYAREA(copy_areaptr)

#define	LC_START_ONEOBJ_PTR_IN_COPYAREA(manyobjs_ptr) (&(manyobjs_ptr)->objs)

#define	LC_LAST_ONEOBJ_PTR_IN_COPYAREA(manyobjs_ptr) (&(manyobjs_ptr)->objs - ((manyobjs_ptr)->num_objs - 1))

#define	LC_NEXT_ONEOBJ_PTR_IN_COPYAREA(oneobj_ptr) ((oneobj_ptr) - 1)

#define	LC_PRIOR_ONEOBJ_PTR_IN_COPYAREA(oneobj_ptr) ((oneobj_ptr) + 1)

#define	LC_FIND_ONEOBJ_PTR_IN_COPYAREA(manyobjs_ptr, obj_num) (&(manyobjs_ptr)->objs - (obj_num))

#define	LC_RECDES_TO_GET_ONEOBJ(copy_area_ptr, oneobj_ptr, recdes_ptr)

#define	LC_REPL_RECDES_FOR_ONEOBJ(copy_area_ptr, oneobj_ptr, key_length, recdes_ptr)

#define	LC_RECDES_IN_COPYAREA(copy_area_ptr, recdes_ptr)

#define	LC_REQOBJ_PACKED_SIZE (OR_OID_SIZE + OR_INT_SIZE * 2)

#define	LC_CLASS_OF_REQOBJ_PACKED_SIZE (OR_OID_SIZE + OR_INT_SIZE)

#define	LC_LOCKSET_PACKED_SIZE(req)

#define	LC_LOCKHINT_CLASS_PACKED_SIZE (OR_OID_SIZE + OR_INT_SIZE * 3)

#define	LC_LOCKHINT_PACKED_SIZE(lockhint)

#define	LC_COPY_ONEOBJ(new_obj, old_obj)

#define	LC_IS_FLUSH_INSERT(operation)

#define	LC_IS_FLUSH_UPDATE(operation)

#define	LC_FETCH_IS_MVCC_VERSION_NEEDED(fetch_type) ((fetch_type) == LC_FETCH_MVCC_VERSION)

#define	LC_FETCH_IS_DIRTY_VERSION_NEEDED(fetch_type) ((fetch_type) == LC_FETCH_DIRTY_VERSION)

#define	LC_FETCH_IS_CURRENT_VERSION_NEEDED(fetch_type) ((fetch_type) == LC_FETCH_CURRENT_VERSION)

#define	LC_FLAG_HAS_INDEX_MASK 0x05

#define	LC_ONEOBJ_GET_INDEX_FLAG(obj) ((obj)->flag & LC_FLAG_HAS_INDEX_MASK)

#define	LC_FLAG_HAS_INDEX 0x01 /* Used for flushing, set if object has index */

#define	LC_FLAG_UPDATED_BY_ME 0x02 /* Used by MVCC to identify that an object was updated by current transaction. */

#define	LC_FLAG_HAS_UNIQUE_INDEX 0x04 /* Used for flushing, set if object has unique index */

#define	LC_ONEOBJ_SET_HAS_INDEX(obj) (obj)->flag \|= LC_FLAG_HAS_INDEX

#define	LC_ONEOBJ_SET_HAS_UNIQUE_INDEX(obj) (obj)->flag \|= LC_FLAG_HAS_UNIQUE_INDEX

#define	LC_ONEOBJ_IS_UPDATED_BY_ME(obj) (((obj)->flag & LC_FLAG_UPDATED_BY_ME) != 0)

#define	LC_ONEOBJ_SET_UPDATED_BY_ME(obj) (obj)->flag \|= LC_FLAG_UPDATED_BY_ME

Typedefs
typedef struct lc_copyarea_oneobj	LC_COPYAREA_ONEOBJ

typedef struct lc_copyarea_manyobjs	LC_COPYAREA_MANYOBJS

typedef struct lc_copy_area	LC_COPYAREA

typedef struct lc_copyarea_desc	LC_COPYAREA_DESC

typedef struct lc_lockset_reqobj	LC_LOCKSET_REQOBJ

typedef struct lc_lockset_classof	LC_LOCKSET_CLASSOF

typedef struct lc_lock_set	LC_LOCKSET

typedef struct lc_lockhint_class	LC_LOCKHINT_CLASS

typedef struct lc_lock_hint	LC_LOCKHINT

typedef enum lc_prefetch_flags	LC_PREFETCH_FLAGS

typedef struct lc_oidmap	LC_OIDMAP

typedef struct lc_class_oidset	LC_CLASS_OIDSET

typedef struct lc_oidset	LC_OIDSET

Enumerations
enum	LC_COPYAREA_OPERATION { LC_FETCH, LC_FETCH_DELETED, LC_FETCH_DECACHE_LOCK, LC_FLUSH_INSERT, LC_FLUSH_INSERT_PRUNE, LC_FLUSH_INSERT_PRUNE_VERIFY, LC_FLUSH_DELETE, LC_FLUSH_UPDATE, LC_FLUSH_UPDATE_PRUNE, LC_FLUSH_UPDATE_PRUNE_VERIFY, LC_FETCH_VERIFY_CHN }

enum	LC_FETCH_VERSION_TYPE { LC_FETCH_CURRENT_VERSION = 0x01, LC_FETCH_MVCC_VERSION = 0x02, LC_FETCH_DIRTY_VERSION = 0x03, LC_FETCH_CURRENT_VERSION_NO_CHECK = 0x04 }

enum	MULTI_UPDATE_FLAG { IS_MULTI_UPDATE = 0x01, START_MULTI_UPDATE = 0x02, END_MULTI_UPDATE = 0x04 }

enum	lc_prefetch_flags { LC_PREF_FLAG_LOCK = 0x00000001, LC_PREF_FLAG_COUNT_OPTIM = 0x00000002 }

Functions
LC_COPYAREA *	locator_allocate_copy_area_by_length (int length)

LC_COPYAREA *	locator_reallocate_copy_area_by_length (LC_COPYAREA *old_area, int new_length)

void	locator_free_copy_area (LC_COPYAREA *copyarea)

char *	locator_pack_copy_area_descriptor (int num_objs, LC_COPYAREA copyarea, char desc, int desc_len)

char *	locator_unpack_copy_area_descriptor (int num_objs, LC_COPYAREA copyarea, char desc)

int	locator_send_copy_area (LC_COPYAREA copyarea, char contents_ptr, int contents_length, char *desc_ptr, int desc_length)

LC_COPYAREA *	locator_recv_allocate_copyarea (int num_objs, char packed_desc, int packed_desc_length, char contents_ptr, int contents_length)

LC_LOCKSET *	locator_allocate_lockset (int max_reqobjs, LOCK reqobj_inst_lock, LOCK reqobj_class_lock, int quit_on_errors)

LC_LOCKSET *	locator_reallocate_lockset (LC_LOCKSET *lockset, int max_reqobjs)

void	locator_free_lockset (LC_LOCKSET *lockset)

LC_LOCKSET *	locator_allocate_and_unpack_lockset (char *unpacked, int unpacked_size, bool unpack_classes, bool unpack_objects, bool reg_unpacked)

int	locator_pack_lockset (LC_LOCKSET *lockset, bool pack_classes, bool pack_objects)

int	locator_unpack_lockset (LC_LOCKSET *lockset, bool unpack_classes, bool unpack_objects)

LC_LOCKHINT *	locator_allocate_lockhint (int max_classes, bool quit_on_errors)

LC_LOCKHINT *	locator_reallocate_lockhint (LC_LOCKHINT *lockhint, int max_classes)

void	locator_free_lockhint (LC_LOCKHINT *lockhint)

int	locator_pack_lockhint (LC_LOCKHINT *lockhint, bool pack_classes)

int	locator_unpack_lockhint (LC_LOCKHINT *lockhint, bool unpack_classes)

LC_LOCKHINT *	locator_allocate_and_unpack_lockhint (char *unpacked, int unpacked_size, bool unpack_classes, bool reg_unpacked)

void	locator_initialize_areas (void)

void	locator_free_areas (void)

LC_OIDSET *	locator_make_oid_set (void)

void	locator_clear_oid_set (THREAD_ENTRY thrd, LC_OIDSET oidset)

void	locator_free_oid_set (THREAD_ENTRY thread_p, LC_OIDSET oidset)

LC_OIDMAP *	locator_add_oid_set (THREAD_ENTRY thrd, LC_OIDSET set, HFID heap, OID class_oid, OID *obj_oid)

int	locator_get_packed_oid_set_size (LC_OIDSET *oidset)

char *	locator_pack_oid_set (char buffer, LC_OIDSET oidset)

LC_OIDSET *	locator_unpack_oid_set_to_new (THREAD_ENTRY thread_p, char buffer)

bool	locator_unpack_oid_set_to_exist (char buffer, LC_OIDSET use)

bool	locator_manyobj_flag_is_set (LC_COPYAREA_MANYOBJS *copyarea, enum MULTI_UPDATE_FLAG muf)

void	locator_manyobj_flag_remove (LC_COPYAREA_MANYOBJS *copyarea, enum MULTI_UPDATE_FLAG muf)

void	locator_manyobj_flag_set (LC_COPYAREA_MANYOBJS *copyarea, enum MULTI_UPDATE_FLAG muf)

Macro Definition Documentation

#define LC_AREA_ONEOBJ_PACKED_SIZE

Value:

(OR_INT_SIZE * 4 + \
                                    OR_HFID_SIZE + \
                                    OR_OID_SIZE * 2)

Definition at line 35 of file locator.h.

Referenced by locator_send_copy_area().

#define LC_CLASS_OF_REQOBJ_PACKED_SIZE (OR_OID_SIZE + OR_INT_SIZE)

Definition at line 82 of file locator.h.

#define LC_COPY_ONEOBJ	(	new_obj,
		old_obj
	)

Value:

do {                                                              \
      (new_obj)->operation = (old_obj)->operation;                  \
      (new_obj)->flag = (old_obj)->flag;                            \
      HFID_COPY(&((new_obj)->hfid), &((old_obj)->hfid));            \
      COPY_OID(&((new_obj)->class_oid), &((old_obj)->class_oid));   \
      COPY_OID(&((new_obj)->oid), &((old_obj)->oid));               \
      (new_obj)->length = (old_obj)->length;                        \
      (new_obj)->offset = (old_obj)->offset;                        \
  } while(0)

Definition at line 95 of file locator.h.

Referenced by locator_reallocate_copy_area_by_length().

#define LC_FETCH_IS_CURRENT_VERSION_NEEDED ( fetch_type ) ((fetch_type) == LC_FETCH_CURRENT_VERSION)

Definition at line 192 of file locator.h.

#define LC_FETCH_IS_DIRTY_VERSION_NEEDED ( fetch_type ) ((fetch_type) == LC_FETCH_DIRTY_VERSION)

Definition at line 189 of file locator.h.

Referenced by locator_cache_lock().

#define LC_FETCH_IS_MVCC_VERSION_NEEDED ( fetch_type ) ((fetch_type) == LC_FETCH_MVCC_VERSION)

Definition at line 186 of file locator.h.

Referenced by xlocator_fetch().

#define LC_FIND_ONEOBJ_PTR_IN_COPYAREA	(	manyobjs_ptr,
		obj_num
	)	(&(manyobjs_ptr)->objs - (obj_num))

Definition at line 51 of file locator.h.

Referenced by locator_mflush_force(), locator_reallocate_copy_area_by_length(), locator_repl_add_error_to_copyarea(), and locator_repl_mflush_check_error().

#define LC_FLAG_HAS_INDEX 0x01 /* Used for flushing, set if object has index */

Definition at line 199 of file locator.h.

Referenced by locator_attribute_info_force().

#define LC_FLAG_HAS_INDEX_MASK 0x05

Definition at line 195 of file locator.h.

#define LC_FLAG_HAS_UNIQUE_INDEX 0x04 /* Used for flushing, set if object has unique index */

Definition at line 201 of file locator.h.

Referenced by locator_attribute_info_force(), and locator_update_force().

#define LC_FLAG_UPDATED_BY_ME 0x02 /* Used by MVCC to identify that an object was updated by current transaction. */

Definition at line 200 of file locator.h.

#define LC_IS_FLUSH_INSERT ( operation )

Value:

(operation == LC_FLUSH_INSERT || operation == LC_FLUSH_INSERT_PRUNE \

|| operation == LC_FLUSH_INSERT_PRUNE_VERIFY)

LC_FLUSH_INSERT

Definition: locator.h:111

LC_FLUSH_INSERT_PRUNE

Definition: locator.h:112

LC_FLUSH_INSERT_PRUNE_VERIFY

Definition: locator.h:113

Definition at line 121 of file locator.h.

Referenced by la_flush_repl_items(), locator_attribute_info_force(), locator_mflush(), and locator_repl_prepare_force().

#define LC_IS_FLUSH_UPDATE ( operation )

Value:

(operation == LC_FLUSH_UPDATE || operation == LC_FLUSH_UPDATE_PRUNE \

|| operation == LC_FLUSH_UPDATE_PRUNE_VERIFY)

LC_FLUSH_UPDATE_PRUNE

Definition: locator.h:116

LC_FLUSH_UPDATE

Definition: locator.h:115

LC_FLUSH_UPDATE_PRUNE_VERIFY

Definition: locator.h:117

Definition at line 125 of file locator.h.

Referenced by la_flush_repl_items(), locator_attribute_info_force(), locator_force_for_multi_update(), locator_repl_prepare_force(), and xlocator_force().

#define LC_LAST_ONEOBJ_PTR_IN_COPYAREA ( manyobjs_ptr ) (&(manyobjs_ptr)->objs - ((manyobjs_ptr)->num_objs - 1))

Definition at line 45 of file locator.h.

#define LC_LOCKHINT_CLASS_PACKED_SIZE (OR_OID_SIZE + OR_INT_SIZE * 3)

Definition at line 89 of file locator.h.

#define LC_LOCKHINT_PACKED_SIZE ( lockhint )

Value:

(OR_INT_SIZE * 4 + \

LC_LOCKHINT_CLASS_PACKED_SIZE * lockhint->max_classes)

OR_INT_SIZE

#define OR_INT_SIZE

Definition: object_representation_constants.h:43

LC_LOCKHINT_CLASS_PACKED_SIZE

#define LC_LOCKHINT_CLASS_PACKED_SIZE

Definition: locator.h:89

Definition at line 91 of file locator.h.

Referenced by locator_pack_lockhint().

#define LC_LOCKSET_PACKED_SIZE ( req )

Value:

(OR_INT_SIZE * 9 + \
   LC_CLASS_OF_REQOBJ_PACKED_SIZE * req->max_reqobjs + \
   LC_REQOBJ_PACKED_SIZE * req->max_reqobjs)

Definition at line 84 of file locator.h.

Referenced by locator_pack_lockset().

#define LC_MANYOBJS_PTR_IN_COPYAREA ( copy_areaptr )

Value:

((LC_COPYAREA_MANYOBJS *) ((char *)(copy_areaptr)->mem + \
                                    (copy_areaptr)->length - \
                                    DB_SIZEOF(LC_COPYAREA_MANYOBJS)))

Definition at line 39 of file locator.h.

Referenced by locator_cache(), locator_force(), locator_force_for_multi_update(), locator_mflush_reallocate_copy_area(), locator_pack_copy_area_descriptor(), locator_reallocate_copy_area_by_length(), locator_recv_allocate_copyarea(), locator_repl_add_error_to_copyarea(), locator_repl_mflush_check_error(), locator_send_copy_area(), locator_unpack_copy_area_descriptor(), process_class(), slocator_force(), slocator_repl_force(), xlocator_fetch(), xlocator_fetch_all(), xlocator_fetch_lockhint_classes(), xlocator_fetch_lockset(), xlocator_force(), xlocator_lock_and_fetch_all(), xlocator_notify_isolation_incons(), xlocator_repl_force(), and xlocator_upgrade_instances_domain().

#define LC_NEXT_ONEOBJ_PTR_IN_COPYAREA ( oneobj_ptr ) ((oneobj_ptr) - 1)

Definition at line 48 of file locator.h.

Referenced by heap_prefetch(), locator_cache(), locator_force_for_multi_update(), locator_mflush(), locator_notify_decache(), locator_pack_copy_area_descriptor(), locator_repl_mflush(), locator_return_object_assign(), locator_unpack_copy_area_descriptor(), process_class(), xlocator_fetch(), xlocator_fetch_all(), xlocator_force(), xlocator_lock_and_fetch_all(), xlocator_repl_force(), and xlocator_upgrade_instances_domain().

#define LC_ONEOBJ_GET_INDEX_FLAG ( obj ) ((obj)->flag & LC_FLAG_HAS_INDEX_MASK)

Definition at line 196 of file locator.h.

Referenced by locator_force_for_multi_update(), xlocator_force(), and xlocator_repl_force().

#define LC_ONEOBJ_IS_UPDATED_BY_ME ( obj ) (((obj)->flag & LC_FLAG_UPDATED_BY_ME) != 0)

Definition at line 209 of file locator.h.

#define LC_ONEOBJ_SET_HAS_INDEX ( obj ) (obj)->flag |= LC_FLAG_HAS_INDEX

Definition at line 203 of file locator.h.

Referenced by locator_mflush(), and locator_repl_mflush().

#define LC_ONEOBJ_SET_HAS_UNIQUE_INDEX ( obj ) (obj)->flag |= LC_FLAG_HAS_UNIQUE_INDEX

Definition at line 206 of file locator.h.

Referenced by locator_mflush().

#define LC_ONEOBJ_SET_UPDATED_BY_ME ( obj ) (obj)->flag |= LC_FLAG_UPDATED_BY_ME

Definition at line 212 of file locator.h.

#define LC_PRIOR_ONEOBJ_PTR_IN_COPYAREA ( oneobj_ptr ) ((oneobj_ptr) + 1)

Definition at line 49 of file locator.h.

Referenced by locator_cache(), locator_force_for_multi_update(), locator_notify_decache(), xlocator_fetch_all(), xlocator_force(), xlocator_lock_and_fetch_all(), and xlocator_repl_force().

#define LC_RECDES_IN_COPYAREA	(	copy_area_ptr,
		recdes_ptr
	)

Value:

do { \
    (recdes_ptr)->data = (copy_area_ptr)->mem; \
    (recdes_ptr)->area_size = \
      (copy_area_ptr)->length - DB_SIZEOF(LC_COPYAREA_MANYOBJS); \
  } while (0)

Definition at line 74 of file locator.h.

Referenced by locator_force_for_multi_update(), locator_mflush_reallocate_copy_area(), locator_mflush_reset(), xlocator_fetch(), xlocator_fetch_all(), xlocator_fetch_lockhint_classes(), xlocator_fetch_lockset(), xlocator_force(), xlocator_lock_and_fetch_all(), xlocator_notify_isolation_incons(), and xlocator_repl_force().

#define LC_RECDES_TO_GET_ONEOBJ	(	copy_area_ptr,
		oneobj_ptr,
		recdes_ptr
	)

Value:

do { \
    (recdes_ptr)->data = (char *) ((copy_area_ptr)->mem + \
                                   (oneobj_ptr)->offset); \
    (recdes_ptr)->length = (recdes_ptr)->area_size = (oneobj_ptr)->length; \
    if (!OID_IS_ROOTOID (&((oneobj_ptr)->class_oid))) \
      { \
    (recdes_ptr)->area_size += \
    (OR_MVCC_MAX_HEADER_SIZE - OR_MVCC_INSERT_HEADER_SIZE); \
      } \
  } while (0)

Definition at line 54 of file locator.h.

Referenced by locator_cache(), locator_force_for_multi_update(), process_class(), xlocator_force(), and xlocator_upgrade_instances_domain().

#define LC_REPL_RECDES_FOR_ONEOBJ	(	copy_area_ptr,
		oneobj_ptr,
		key_length,
		recdes_ptr
	)

Value:

do {                                                                                  \
      (recdes_ptr)->data = (char *)((copy_area_ptr)->mem                                \
                                    + (oneobj_ptr)->offset + (key_length));             \
      (recdes_ptr)->length = (recdes_ptr)->area_size = (oneobj_ptr)->length             \
                                    - (key_length);                                     \
  } while (0)

Definition at line 66 of file locator.h.

Referenced by xlocator_repl_force().

#define LC_REQOBJ_PACKED_SIZE (OR_OID_SIZE + OR_INT_SIZE * 2)

Definition at line 81 of file locator.h.

#define LC_START_ONEOBJ_PTR_IN_COPYAREA ( manyobjs_ptr ) (&(manyobjs_ptr)->objs)

Definition at line 44 of file locator.h.

Referenced by locator_cache(), locator_force_for_multi_update(), locator_mflush_reallocate_copy_area(), locator_mflush_reset(), locator_notify_decache(), locator_pack_copy_area_descriptor(), locator_unpack_copy_area_descriptor(), process_class(), xlocator_fetch(), xlocator_fetch_all(), xlocator_fetch_lockhint_classes(), xlocator_fetch_lockset(), xlocator_force(), xlocator_lock_and_fetch_all(), xlocator_notify_isolation_incons(), xlocator_repl_force(), and xlocator_upgrade_instances_domain().

Typedef Documentation

typedef struct lc_class_oidset LC_CLASS_OIDSET

Definition at line 362 of file locator.h.

typedef struct lc_copy_area LC_COPYAREA

Definition at line 244 of file locator.h.

typedef struct lc_copyarea_desc LC_COPYAREA_DESC

Definition at line 251 of file locator.h.

typedef struct lc_copyarea_manyobjs LC_COPYAREA_MANYOBJS

Definition at line 235 of file locator.h.

typedef struct lc_copyarea_oneobj LC_COPYAREA_ONEOBJ

Definition at line 216 of file locator.h.

typedef struct lc_lock_hint LC_LOCKHINT

Definition at line 318 of file locator.h.

typedef struct lc_lockhint_class LC_LOCKHINT_CLASS

Definition at line 309 of file locator.h.

typedef struct lc_lock_set LC_LOCKSET

Definition at line 278 of file locator.h.

typedef struct lc_lockset_classof LC_LOCKSET_CLASSOF

Definition at line 271 of file locator.h.

typedef struct lc_lockset_reqobj LC_LOCKSET_REQOBJ

Definition at line 263 of file locator.h.

typedef struct lc_oidmap LC_OIDMAP

Definition at line 343 of file locator.h.

typedef struct lc_oidset LC_OIDSET

Definition at line 381 of file locator.h.

typedef enum lc_prefetch_flags LC_PREFETCH_FLAGS

Definition at line 339 of file locator.h.

Enumeration Type Documentation

enum LC_COPYAREA_OPERATION

Enumerator
LC_FETCH
LC_FETCH_DELETED
LC_FETCH_DECACHE_LOCK
LC_FLUSH_INSERT
LC_FLUSH_INSERT_PRUNE
LC_FLUSH_INSERT_PRUNE_VERIFY
LC_FLUSH_DELETE
LC_FLUSH_UPDATE
LC_FLUSH_UPDATE_PRUNE
LC_FLUSH_UPDATE_PRUNE_VERIFY
LC_FETCH_VERIFY_CHN