File network_interface_cl.h¶
File List > communication > network_interface_cl.h
Go to the documentation of this file
/*
* Copyright 2008 Search Solution Corporation
* Copyright 2016 CUBRID Corporation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
/*
* network_interface_cl.h - Definitions for client network support
*/
#ifndef _NETWORK_INTERFACE_CL_H_
#define _NETWORK_INTERFACE_CL_H_
#ident "$Id$"
#if defined (SERVER_MODE)
#error Does not belong to server module
#endif /* SERVER_MODE */
#include <stdio.h>
#include <vector>
#include "dbtype_def.h"
#include "lob_locator.hpp"
#include "replication.h"
#include "server_interface.h"
#include "perf_monitor.h"
#include "storage_common.h"
#include "object_domain.h"
#include "query_list.h"
#include "query_monitoring.hpp"
#include "statistics.h"
#include "connection_defs.h"
#include "log_writer.h"
#include "language_support.h"
#include "log_common_impl.h"
#include "parse_tree.h"
#include "load_common.hpp"
#include "timezone_lib_common.h"
#include "dynamic_array.h"
#include "flashback_cl.h"
#include "pl_struct_compile.hpp"
#include "pl_signature.hpp"
#include "memory_monitor_common.hpp"
#if defined (CS_MODE)
#include "network_cl.h"
#endif
// forward declarations
#if defined (SA_MODE)
struct bo_restart_arg;
#endif
struct compile_context;
struct xasl_node_header;
struct xasl_stream;
/* killtran supporting structures and functions */
typedef struct one_tran_info ONE_TRAN_INFO;
struct one_tran_info
{
int tran_index;
TRAN_STATE state;
int process_id;
char *db_user;
char *program_name;
char *login_name;
char *host_name;
TRAN_QUERY_EXEC_INFO query_exec_info;
};
typedef struct trans_info TRANS_INFO;
struct trans_info
{
int num_trans;
bool include_query_exec_info;
ONE_TRAN_INFO tran[1]; /* really [num_trans] */
};
extern int locator_fetch (OID * oidp, int chn, LOCK lock, LC_FETCH_VERSION_TYPE fetch_type, OID * class_oid,
int class_chn, int prefetch, LC_COPYAREA ** fetch_copyarea);
extern int locator_get_class (OID * class_oid, int class_chn, const OID * oid, LOCK lock, int prefetching,
LC_COPYAREA ** fetch_copyarea);
extern int locator_fetch_all (const HFID * hfid, LOCK * lock, LC_FETCH_VERSION_TYPE fetch_version_type,
OID * class_oidp, int *nobjects, int *nfetched, OID * last_oidp,
LC_COPYAREA ** fetch_copyarea, int request_pages, int nsplit_process, int nselection_key);
extern int locator_does_exist (OID * oidp, int chn, LOCK lock, OID * class_oid, int class_chn, int need_fetching,
int prefetch, LC_COPYAREA ** fetch_copyarea, LC_FETCH_VERSION_TYPE fetch_version_type);
extern int locator_notify_isolation_incons (LC_COPYAREA ** synch_copyarea);
extern int locator_force (LC_COPYAREA * copy_area, int num_ignore_error_list, int *ignore_error_list, int content_size);
extern int locator_repl_force (LC_COPYAREA * copy_area, LC_COPYAREA ** reply_copy_area);
extern int locator_fetch_lockset (LC_LOCKSET * lockset, LC_COPYAREA ** fetch_copyarea);
extern int locator_fetch_all_reference_lockset (OID * oid, int chn, OID * class_oid, int class_chn, LOCK lock,
int quit_on_errors, int prune_level, LC_LOCKSET ** lockset,
LC_COPYAREA ** fetch_copyarea);
extern LC_FIND_CLASSNAME locator_find_class_oid (const char *class_name, OID * class_oid, LOCK lock);
extern LC_FIND_CLASSNAME locator_reserve_class_names (const int num_classes, const char **class_names,
OID * class_oids);
extern int locator_get_reserved_class_name_oid (const char *classname, OID * class_oid);
extern LC_FIND_CLASSNAME locator_delete_class_name (const char *class_name);
extern LC_FIND_CLASSNAME locator_rename_class_name (const char *old_name, const char *new_name, OID * class_oid);
extern int locator_assign_oid (const HFID * hfid, OID * perm_oid, int expected_length, OID * class_oid,
const char *class_name);
extern int locator_assign_oid_batch (LC_OIDSET * oidset);
extern LC_FIND_CLASSNAME locator_find_lockhint_class_oids (int num_classes, const char **many_classnames,
LOCK * many_locks, int *many_need_subclasses,
LC_PREFETCH_FLAGS * many_flags, OID * guessed_class_oids,
int *guessed_class_chns, int quit_on_errors,
LOCK lock_rr_tran, LC_LOCKHINT ** lockhint,
LC_COPYAREA ** fetch_copyarea);
extern int locator_fetch_lockhint_classes (LC_LOCKHINT * lockhint, LC_COPYAREA ** fetch_area);
extern int locator_check_fk_validity (OID * cls_oid, HFID * hfid, TP_DOMAIN * key_type, int n_attrs, int *attr_ids,
OID * pk_cls_oid, BTID * pk_btid, char *fk_name);
extern int locator_prefetch_repl_insert (OID * class_oid, RECDES * recdes);
extern int heap_create (HFID * hfid, const OID * class_oid, bool reuse_oid);
#if defined(ENABLE_UNUSED_FUNCTION)
extern int heap_destroy (const HFID * hfid);
#endif
extern int heap_destroy_newly_created (const HFID * hfid, const OID * class_oid, const bool force = false);
extern int heap_get_class_num_objects_pages (HFID * hfid, int approximation, int *nobjs, int *npages);
extern int heap_has_instance (HFID * hfid, OID * class_oid, int has_visible_instance);
extern int heap_reclaim_addresses (const HFID * hfid);
extern int heap_get_maxslotted_reclength (int &maxslotted_reclength);
extern int file_apply_tde_to_class_files (const OID * class_oid);
#ifdef UNSTABLE_TDE_FOR_REPLICATION_LOG
extern int tde_get_data_keys ();
#endif /* UNSTABLE_TDE_FOR_REPLICATION_LOG */
extern int tde_is_loaded (int *is_loaded);
extern int tde_get_mk_file_path (char *mk_path);
extern int tde_get_mk_info (int *mk_index, time_t * created_time, time_t * set_time);
extern int tde_change_mk_on_server (int mk_index);
extern DKNPAGES disk_get_total_numpages (VOLID volid);
extern DKNPAGES disk_get_free_numpages (VOLID volid);
extern char *disk_get_remarks (VOLID volid);
extern char *disk_get_fullname (VOLID volid, char *vol_fullname);
extern int log_reset_wait_msecs (int wait_msecs);
extern int log_reset_isolation (TRAN_ISOLATION isolation);
extern void log_set_interrupt (int set);
extern int log_checkpoint (void);
extern void log_dump_stat (FILE * outfp);
extern int log_set_suppress_repl_on_transaction (int set);
#if defined (CS_MODE)
extern LOB_LOCATOR_STATE log_find_lob_locator (const char *locator, char *real_locator);
extern int log_add_lob_locator (const char *locator, LOB_LOCATOR_STATE state);
extern int log_change_state_of_locator (const char *locator, const char *real_locator, LOB_LOCATOR_STATE state);
extern int log_drop_lob_locator (const char *locator);
#endif // CS_MODE
extern TRAN_STATE tran_server_commit (bool retain_lock);
extern TRAN_STATE tran_server_abort (void);
#ifdef __cplusplus
extern "C"
{
#endif
extern bool tran_is_blocked (int tran_index);
#ifdef __cplusplus
}
#endif
extern int tran_server_has_updated (void);
extern int tran_server_is_active_and_has_updated (void);
extern int tran_wait_server_active_trans (void);
extern int tran_server_set_global_tran_info (int gtrid, void *info, int size);
extern int tran_server_get_global_tran_info (int gtrid, void *buffer, int size);
extern int tran_server_2pc_start (void);
extern TRAN_STATE tran_server_2pc_prepare (void);
extern int tran_server_2pc_recovery_prepared (int gtrids[], int size);
extern int tran_server_2pc_attach_global_tran (int gtrid);
extern TRAN_STATE tran_server_2pc_prepare_global_tran (int gtrid);
#if defined (ENABLE_UNUSED_FUNCTION)
extern int tran_server_start_topop (LOG_LSA * topop_lsa);
extern TRAN_STATE tran_server_end_topop (LOG_RESULT_TOPOP result, LOG_LSA * topop_lsa);
#endif
extern int tran_server_savepoint (const char *savept_name, LOG_LSA * savept_lsa);
extern TRAN_STATE tran_server_partial_abort (const char *savept_name, LOG_LSA * savept_lsa);
extern const char *tran_get_tranlist_state_name (TRAN_STATE state);
#ifdef __cplusplus
extern "C"
{
#endif
extern void lock_dump (FILE * outfp, int is_contention);
extern void vacuum_dump (FILE * outfp);
#ifdef __cplusplus
}
#endif
extern int acl_reload (void);
extern void acl_dump (FILE * outfp);
int boot_initialize_server (const BOOT_CLIENT_CREDENTIAL * client_credential, BOOT_DB_PATH_INFO * db_path_info,
bool db_overwrite, const char *file_addmore_vols, DKNPAGES db_npages,
PGLENGTH db_desired_pagesize, DKNPAGES log_npages, PGLENGTH db_desired_log_page_size,
OID * rootclass_oid, HFID * rootclass_hfid, int client_lock_wait,
TRAN_ISOLATION client_isolation);
int boot_register_client (BOOT_CLIENT_CREDENTIAL * client_credential, int client_lock_wait,
TRAN_ISOLATION client_isolation, TRAN_STATE * tran_state,
BOOT_SERVER_CREDENTIAL * server_credential);
extern int boot_unregister_client (int tran_index);
extern int boot_backup (const char *backup_path, FILEIO_BACKUP_LEVEL backup_level, bool delete_unneeded_logarchives,
const char *backup_verbose_file, int num_threads, FILEIO_ZIP_METHOD zip_method,
FILEIO_ZIP_LEVEL zip_level, int skip_activelog, int sleep_msecs, bool separate_keys);
extern VOLID boot_add_volume_extension (DBDEF_VOL_EXT_INFO * ext_info);
extern int boot_check_db_consistency (int check_flag, OID * oids, int num_oids, BTID * idx_btid);
extern int boot_find_number_permanent_volumes (void);
extern int boot_find_number_temp_volumes (void);
extern VOLID boot_find_last_permanent (void);
extern int boot_find_last_temp (void);
extern int boot_delete (const char *db_name, bool force_delete);
#if defined (SA_MODE)
extern int boot_restart_from_backup (int print_restart, const char *db_name, bo_restart_arg * r_args);
#endif // SA_MODE
extern bool boot_shutdown_server (ER_FINAL_CODE iserfinal);
extern int boot_soft_rename (const char *old_db_name, const char *new_db_name, const char *new_db_path,
const char *new_log_path, const char *new_db_server_host, const char *new_volext_path,
const char *fileof_vols_and_renamepaths, bool newdb_overwrite, bool extern_rename,
bool force_delete);
extern int boot_copy (const char *from_dbname, const char *new_db_name, const char *new_db_path,
const char *new_log_path, const char *new_lob_path,
const char *new_db_server_host, const char *new_volext_path,
const char *fileof_vols_and_copypaths, bool newdb_overwrite);
extern int boot_emergency_patch (const char *db_name, bool recreate_log, DKNPAGES log_npages, const char *db_locale,
FILE * out_fp);
extern HA_SERVER_STATE boot_change_ha_mode (HA_SERVER_STATE state, bool force, int timeout);
extern int boot_notify_ha_log_applier_state (HA_LOG_APPLIER_STATE state);
extern int stats_get_statistics_from_server (OID * classoid, unsigned int timestamp, int *length_ptr,
char **stats_buffer);
extern int stats_update_statistics (MOP classop, int with_fullscan);
extern int stats_update_all_statistics (int with_fullscan);
extern int btree_add_index (BTID * btid, TP_DOMAIN * key_type, OID * class_oid, int attr_id, int unique_pk,
int deduplicate_key_pos);
extern int btree_load_index (BTID * btid, const char *bt_name, TP_DOMAIN * key_type, OID * class_oids, int n_classes,
int n_attrs, int *attr_ids, int *attrs_prefix_length, HFID * hfids, int unique_pk,
int not_null_flag, OID * fk_refcls_oid, BTID * fk_refcls_pk_btid, const char *fk_name,
char *pred_stream, int pred_stream_size, char *expr_stream, int expr_stream_size,
int func_col_id, int func_attr_index_start, SM_INDEX_STATUS index_status);
extern int btree_delete_index (BTID * btid);
extern int locator_log_force_nologging (void);
extern int locator_remove_class_from_index (OID * oid, BTID * btid, HFID * hfid);
extern BTREE_SEARCH btree_find_unique (BTID * btid, DB_VALUE * key, OID * class_oid, OID * oid);
extern BTREE_SEARCH repl_btree_find_unique (BTID * btid, DB_VALUE * key, OID * class_oid, OID * oid);
extern BTREE_SEARCH btree_find_multi_uniques (OID * class_oid, int pruning_type, BTID * btids, DB_VALUE * keys,
int count, SCAN_OPERATION_TYPE op_type, OID ** oids, int *oids_count);
extern int btree_class_test_unique (char *buf, int buf_size);
extern int qfile_get_list_file_page (QUERY_ID query_id, VOLID volid, PAGEID pageid, char *buffer, int *buffer_size);
extern int qmgr_prepare_query (struct compile_context *context, xasl_stream * stream);
extern QFILE_LIST_ID *qmgr_execute_query (const XASL_ID * xasl_id, QUERY_ID * query_idp, int dbval_cnt,
const DB_VALUE * dbvals, QUERY_FLAG flag, CACHE_TIME * clt_cache_time,
CACHE_TIME * srv_cache_time, int query_timeout);
extern QFILE_LIST_ID *qmgr_prepare_and_execute_query (char *xasl_stream, int xasl_stream_size, QUERY_ID * query_id,
int dbval_cnt, DB_VALUE * dbval_ptr, QUERY_FLAG flag,
int query_timeout);
extern int qmgr_end_query (QUERY_ID query_id);
extern int qmgr_drop_all_query_plans (void);
extern int qmgr_drop_query_plans_by_sha1 (char *sha1);
extern void qmgr_dump_query_plans (FILE * outfp);
extern void qmgr_dump_query_cache (FILE * outfp);
#if defined(ENABLE_UNUSED_FUNCTION)
extern int qp_get_sys_timestamp (DB_VALUE * value);
#endif
extern int serial_get_next_value (DB_VALUE * value, OID * oid_p, int cached_num, int num_alloc, int is_auto_increment);
extern int serial_get_current_value (DB_VALUE * value, OID * oid_p, int cached_num);
extern int serial_decache (OID * oid);
extern int synonym_remove_xasl_by_oid (OID * oid);
extern int perfmon_server_start_stats (void);
extern int perfmon_server_stop_stats (void);
extern int perfmon_server_copy_stats (UINT64 * to_stats);
extern int perfmon_server_copy_global_stats (UINT64 * to_stats);
extern int catalog_check_rep_dir (OID * class_id, OID * rep_dir_p);
extern int thread_kill_tran_index (int kill_tran_index, char *kill_user, char *kill_host, int kill_pid);
extern int thread_kill_or_interrupt_tran (int *tran_index_list, int num_tran_index, bool is_dba_group_member,
bool interrupt_only, int *num_killed);
extern void thread_dump_cs_stat (FILE * outfp);
extern int logtb_get_pack_tran_table (char **buffer_p, int *size_p, bool include_query_exec_info);
extern void logtb_free_trans_info (TRANS_INFO * info);
extern TRANS_INFO *logtb_get_trans_info (bool include_query_exec_info);
extern void logtb_dump_trantable (FILE * outfp);
extern int btree_get_statistics (BTID * btid, BTREE_STATS * stat_info);
extern int btree_get_index_key_type (BTID btid, TP_DOMAIN ** key_type_p);
extern int db_local_transaction_id (DB_VALUE * trid);
extern int qp_get_server_info (PARSER_CONTEXT * parser, int server_info_bits);
extern int locator_redistribute_partition_data (OID * class_oid, int no_oids, OID * oid_list);
extern int pl_get_server_port (void);
extern int repl_log_get_append_lsa (LOG_LSA * lsa);
extern int repl_set_info (REPL_INFO * repl_info);
extern int logwr_get_log_pages (LOGWR_CONTEXT * ctx_ptr);
extern int log_supplement_statement (int ddl_type, int objtype, OID * classoid, OID * objoid, const char *stmt_text);
extern int boot_compact_classes (OID ** class_oids, int num_classes, int space_to_process, int instance_lock_timeout,
int class_lock_timeout, bool delete_old_repr, OID * last_processed_class_oid,
OID * last_processed_oid, int *total_objects, int *failed_objects,
int *modified_objects, int *big_objects, int *ids_repr);
extern int boot_heap_compact (OID * class_oid);
extern int compact_db_start (void);
extern int compact_db_stop (void);
/* external storage supports */
extern int es_posix_create_file (char *new_path);
extern ssize_t es_posix_write_file (const char *path, const void *buf, size_t count, off_t offset);
extern ssize_t es_posix_read_file (const char *path, void *buf, size_t count, off_t offset);
extern int es_posix_delete_file (const char *path);
extern int es_posix_copy_file (const char *src_path, const char *metaname, char *new_path);
extern int es_posix_rename_file (const char *src_path, const char *metaname, char *new_path);
extern off_t es_posix_get_file_size (const char *path);
extern int locator_upgrade_instances_domain (OID * class_oid, int attribute_id);
extern int boot_get_server_locales (LANG_COLL_COMPAT ** server_collations, LANG_LOCALE_COMPAT ** server_locales,
int *server_coll_cnt, int *server_locales_cnt);
extern int boot_get_server_timezone_checksum (char *timezone_checksum);
/* session state API */
extern int csession_find_or_create_session (SESSION_ID * session_id, int *row_count, char *server_session_key,
const char *db_user, const char *host, const char *program_name);
extern int csession_end_session (SESSION_ID session_id, bool is_keep_session);
extern int csession_set_row_count (int rows);
extern int csession_get_row_count (int *rows);
extern int csession_get_last_insert_id (DB_VALUE * value, bool update_last_insert_id);
extern int csession_reset_cur_insert_id (void);
extern int csession_create_prepared_statement (const char *name, const char *alias_print, char *stmt_info,
int info_length);
extern int csession_get_prepared_statement (const char *name, XASL_ID * xasl_id, char **stmt_info,
xasl_node_header * xasl_header_p);
extern int csession_delete_prepared_statement (const char *name);
extern int clogin_user (const char *username);
extern int csession_set_session_variables (DB_VALUE * variables, const int count);
extern int csession_get_variable (DB_VALUE * name, DB_VALUE * value);
extern int csession_drop_session_variables (DB_VALUE * variables, const int count);
extern int cvacuum (void);
extern int log_get_mvcc_snapshot (void);
extern int tran_lock_rep_read (LOCK lock_rr_tran);
extern int chksum_insert_repl_log_and_demote_table_lock (REPL_INFO * repl_info, const OID * class_oidp);
extern int log_does_active_user_exist (const char *user_name, bool * existed);
extern int netcl_spacedb (SPACEDB_ALL * spaceall, SPACEDB_ONEVOL ** spacevols, SPACEDB_FILES * spacefiles);
extern int locator_demote_class_lock (const OID * class_oid, LOCK lock, LOCK * ex_lock);
extern int loaddb_init (cubload::load_args & args);
extern int loaddb_install_class (const cubload::batch & batch, bool & class_is_ignored, std::string & class_name);
/* *INDENT-OFF* */
extern int loaddb_load_batch (const cubload::batch &batch, bool use_temp_batch, bool &is_batch_accepted,
load_status &status);
/* *INDENT-ON* */
extern int loaddb_fetch_status (load_status & status);
extern int loaddb_destroy ();
extern int loaddb_interrupt ();
extern int loaddb_update_stats (bool verbose);
extern int flashback_get_and_show_summary (dynamic_array * class_list, const char *user, time_t start_time,
time_t end_time, FLASHBACK_SUMMARY_INFO_MAP * summary, OID ** oid_list,
char **invalid_class, time_t * invalid_time);
extern int flashback_get_loginfo (int trid, char *user, OID * classlist, int num_class, LOG_LSA * start_lsa,
LOG_LSA * end_lsa, int *num_item, bool forward, char **info_list,
int *invalid_class_idx);
/* PL/CSQL */
EXPORT_IMPORT extern int plcsql_transfer_file (const PLCSQL_COMPILE_REQUEST & compile_request,
PLCSQL_COMPILE_RESPONSE & compile_response);
EXPORT_IMPORT extern int pl_call (const cubpl::pl_signature & sig,
const std::vector < std::reference_wrapper < DB_VALUE >> &args,
std::vector < DB_VALUE > &out_args, DB_VALUE & result);
/* memmon */
extern int mmon_get_server_info (MMON_SERVER_INFO & server_info);
extern int mmon_disable_force ();
/* tdes */
extern void tdes_set_query_start_info (char *sql_user_text);
extern void tdes_reset_query_start_info (PT_NODE * node);
/* lob dir */
extern int lob_create_dir (HFID * hfid, int *attrid_arr, int attrid_arr_length);
extern int lob_remove_dir (HFID * hfid, int attrid);
extern int file_dump_file_list (FILE * outfp, bool invalid_only);
extern int file_clean_invalid_file (int *heap, int *heap_ovf, int *btree, int *btree_ovf);
#if !defined(NDEBUG)
extern int file_delete_target_file (const char *target_vfid_str);
#endif
#endif /* _NETWORK_INTERFACE_CL_H_ */