/* * Copyright (C) 2008 Search Solution Corporation. All rights reserved by Search Solution. * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; version 2 of the License. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA * */ /* * Query manager (Server Side) */ #ifndef _QUERY_MANAGER_H_ #define _QUERY_MANAGER_H_ #ident "$Id$" #include "storage_common.h" #include "list_file.h" #include "dbtype.h" #include "thread_impl.h" #define NULL_PAGEID_ASYNC -2 #define QMGR_VPID_ARRAY_SIZE 20 #define QMGR_QUERY_ENTRY_ARRAY_SIZE 100 typedef enum { QMGR_TRAN_NULL, /* Null transaction: a transaction not issued a query */ QMGR_TRAN_RUNNING, /* Running transaction */ QMGR_TRAN_DELAYED_START, /* Suspended transaction: waiting for all the waiting transactions to be served */ QMGR_TRAN_WAITING, /* Suspended transaction: waiting for a query file page to be freed. */ QMGR_TRAN_RESUME_TO_DEALLOCATE, /* Transaction has been resumed to deallocate all query pages. Transaction will have to restart the query */ QMGR_TRAN_RESUME_DUE_DEADLOCK, /* Transaction has been resumed to deallocate all query pages. The transaction was involved in a deadlock. Transaction will have to restart the query. Note that the transaction is not aborted. */ QMGR_TRAN_TERMINATED /* Terminated transaction */ } QMGR_TRAN_STATUS; typedef struct qmgr_temp_file QMGR_TEMP_FILE; struct qmgr_temp_file { QMGR_TEMP_FILE *next; QMGR_TEMP_FILE *prev; FILE_TYPE temp_file_type; VFID temp_vfid; int curr_free_page_index; /* current free page index */ int last_free_page_index; /* last free page index */ int vpid_index; /* index into vpid_array */ int vpid_count; /* index into vpid_array */ VPID vpid_array[QMGR_VPID_ARRAY_SIZE]; /* an arrary of vpids */ int total_count; /* total number of file pages alloc'd */ int membuf_last; PAGE_PTR *membuf; #ifdef SERVER_MODE MUTEX_T membuf_mutex; THREAD_ENTRY *membuf_thread_p; #if 0 /* async wakeup */ PAGE_PTR wait_page_ptr; #endif #endif }; /* * Arguments to pass to the routine used to wait for the next available page * for streaming queries. */ typedef struct qmgr_wait_args QMGR_WAIT_ARGS; struct qmgr_wait_args { int query_id; VPID vpid; QMGR_TEMP_FILE *tfile_vfidp; }; typedef enum { OTHERS, M_QUERY, UNION_QUERY, VALUE_QUERY, GROUPBY_QUERY, ORDERBY_QUERY, DISTINCT_QUERY } QMGR_QUERY_TYPE; typedef enum { SYNC_MODE, ASYNC_MODE, QUERY_COMPLETED } QMGR_QUERY_MODE; typedef struct qmgr_query_entry QMGR_QUERY_ENTRY; struct qmgr_query_entry { #ifdef SERVER_MODE MUTEX_T lock; /* mutex for error message */ COND_T cond; unsigned int nwaits; /* the number of waiters who wait for cond */ #endif int query_id; /* unique query identifier */ XASL_ID xasl_id; /* XASL tree storage identifier */ XASL_CACHE_ENTRY *xasl_ent; /* XASL cache entry for this query */ XASL_NODE *xasl; /* XASL tree root pointer */ char *xasl_data; /* XASL tree memory data area */ int xasl_size; /* XASL tree memory data area size */ void *xasl_buf_info; /* XASL tree buffer info */ int repeat; /* repetative query ? */ QFILE_LIST_ID *list_id; /* result list file identifier */ QFILE_LIST_CACHE_ENTRY *list_ent; /* list cache entry for this query */ QMGR_QUERY_ENTRY *next; QMGR_QUERY_ENTRY *next_free; /* next query entry in the free list */ QMGR_TEMP_FILE *temp_vfid; /* head of per query temp file VFID */ int num_tmp; /* number of tmpfiles allocated */ int total_count; /* total number of file pages alloc'd * for the entire query */ int errid; /* errid for last error of query */ char *er_msg; /* pointer to error message string * of last error */ volatile QMGR_QUERY_MODE query_mode; volatile QUERY_FLAG query_flag; volatile int interrupt; /* Set to one when the query execution * must be stopped. */ volatile int propagate_interrupt; #ifdef SERVER_MODE THREAD_T tid; /* used in qm_clear_tans_wakeup() */ #endif VPID save_vpid; /* Save VPID for certain async queries */ }; #if defined(SERVER_MODE) /* in xserver_interface.h */ extern XASL_ID *xqmgr_prepare_query (THREAD_ENTRY * thrd, const char *query_str, const OID * user_oid, const char *xasl_stream, int xasl_size, XASL_ID * xasl_id); extern QFILE_LIST_ID *xqmgr_execute_query (THREAD_ENTRY * thrd, const XASL_ID * xasl_id, int *query_idp, int dbval_cnt, const DB_VALUE * dbvals, QUERY_FLAG * flagp, CACHE_TIME * clt_cache_time, CACHE_TIME * srv_cache_time); extern QFILE_LIST_ID *xqmgr_prepare_and_execute_query (THREAD_ENTRY * thrd, char *xasl, int xasl_size, int *query_id, int dbval_cnt, DB_VALUE * dbval_ptr, QUERY_FLAG * flag); extern int xqmgr_end_query (THREAD_ENTRY * thrd, int query_id); extern int xqmgr_drop_query_plan (THREAD_ENTRY * thread_p, const char *query_str, const OID * user_oid, const XASL_ID * xasl_id, bool drop); extern int xqmgr_drop_all_query_plans (THREAD_ENTRY * thread_p); extern void xqmgr_dump_query_plans (THREAD_ENTRY * thread_p, FILE * outfp); extern void xqmgr_dump_query_cache (THREAD_ENTRY * thread_p, FILE * outfp); extern int xqmgr_get_query_info (THREAD_ENTRY * thread_p, int query_id); #endif /* SERVER_MODE */ extern QMGR_QUERY_ENTRY *qmgr_get_query_entry (THREAD_ENTRY * thread_p, int query_id, int trans_ind); extern int qmgr_allocate_tran_entries (THREAD_ENTRY * thread_p, int trans_cnt); extern void qmgr_dump (void); extern int qmgr_initialize (THREAD_ENTRY * thread_p); extern void qmgr_finalize (THREAD_ENTRY * thread_p); extern void qmgr_clear_trans_wakeup (THREAD_ENTRY * thread_p, int tran_index, bool tran_died, bool is_abort); extern QMGR_TRAN_STATUS qmgr_get_tran_status (THREAD_ENTRY * thread_p, int tran_index); extern void qmgr_set_tran_status (THREAD_ENTRY * thread_p, int tran_index, QMGR_TRAN_STATUS trans_status); extern void qmgr_add_modified_class (THREAD_ENTRY * thread_p, const OID * class_oid); extern PAGE_PTR qmgr_get_old_page (THREAD_ENTRY * thread_p, VPID * vpidp, QMGR_TEMP_FILE * tfile_vfidp); extern void qmgr_free_old_page (THREAD_ENTRY * thread_p, PAGE_PTR page_ptr, QMGR_TEMP_FILE * tfile_vfidp); extern void qmgr_set_dirty_page (THREAD_ENTRY * thread_p, PAGE_PTR page_ptr, int free_page, LOG_DATA_ADDR * addrp, QMGR_TEMP_FILE * tfile_vfidp); extern PAGE_PTR qmgr_get_new_page (THREAD_ENTRY * thread_p, VPID * vpidp, QMGR_TEMP_FILE * tfile_vfidp); extern QMGR_TEMP_FILE *qmgr_create_new_temp_file (THREAD_ENTRY * thread_p, int query_id); extern QMGR_TEMP_FILE *qmgr_create_result_file (THREAD_ENTRY * thread_p, int query_id); extern int qmgr_free_query_temp_file (THREAD_ENTRY * thread_p, int query_id); extern int qmgr_free_list_temp_file (THREAD_ENTRY * thread_p, int query_id, QMGR_TEMP_FILE * tfile_vfidp); #if defined(SERVER_MODE) extern bool qmgr_is_thread_executing_async_query (THREAD_ENTRY * thrd_entry); #endif extern void *qmgr_get_area_error_async (THREAD_ENTRY * thread_p, int *length, int count, int query_id); extern bool qmgr_interrupt_query (THREAD_ENTRY * thread_p, int query_id); #if defined(SERVER_MODE) extern int xqmgr_sync_query (THREAD_ENTRY * thread_p, int query_id, int wait, QFILE_LIST_ID * new_list_id, int call_from_server); extern bool qmgr_is_async_query_interrupted (THREAD_ENTRY * thread_p, int query_id); extern int qmgr_get_query_error_with_id (THREAD_ENTRY * thread_p, int query_id); #endif extern int qmgr_get_query_error_with_entry (QMGR_QUERY_ENTRY * query_entryp); extern void qmgr_set_query_error (THREAD_ENTRY * thread_p, int query_id); extern void qmgr_setup_empty_list_file (char *page_buf); #endif /* _QUERY_MANAGER_H_ */