alice.h

/*
 *	PROGRAM:	Alice
 *	MODULE:		alice.h
 *	DESCRIPTION:	Block definitions
 *
 * The contents of this file are subject to the Interbase Public
 * License Version 1.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.Inprise.com/IPL.html
 *
 * Software distributed under the License is distributed on an
 * "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express
 * or implied. See the License for the specific language governing
 * rights and limitations under the License.
 *
 * The Original Code was created by Inprise Corporation
 * and its predecessors. Portions created by Inprise Corporation are
 * Copyright (C) Inprise Corporation.
 *
 * All Rights Reserved.
 * Contributor(s): ______________________________________.
 */

#ifndef ALICE_ALICE_H
#define ALICE_ALICE_H

#include <stdio.h>

#include "ibase.h"
#include "../common/ThreadData.h"
#include "../include/fb_blk.h"
#include "../common/classes/alloc.h"
#include "../common/classes/array.h"
#include "../common/UtilSvc.h"

namespace Firebird::Alice {

enum val_errors {
	VAL_INVALID_DB_VERSION	= 0,

	VAL_RECORD_ERRORS		= 1,
	VAL_BLOB_PAGE_ERRORS	= 2,
	VAL_DATA_PAGE_ERRORS	= 3,
	VAL_INDEX_PAGE_ERRORS	= 4,
	VAL_POINTER_PAGE_ERRORS	= 5,
	VAL_TIP_PAGE_ERRORS		= 6,
	VAL_PAGE_ERRORS			= 7,
	VAL_PIP_PAGE_ERRORS		= 8,

	VAL_RECORD_WARNS		= 9,
	VAL_BLOB_PAGE_WARNS		= 10,
	VAL_DATA_PAGE_WARNS		= 11,
	VAL_INDEX_PAGE_WARNS	= 12,
	VAL_POINTER_PAGE_WARNS	= 13,
	VAL_TIP_PAGE_WARNS		= 14,
	VAL_PAGE_WARNS			= 15,
	VAL_PIP_PAGE_WARNS		= 16,

	MAX_VAL_ERRORS			= 17
};

enum alice_shut_mode {
	SHUT_DEFAULT = 0,
	SHUT_NORMAL = 1,
	SHUT_MULTI = 2,
	SHUT_SINGLE = 3,
	SHUT_FULL = 4
};

enum alice_repl_mode {
	REPL_NONE = 0,
	REPL_READ_ONLY = 1,
	REPL_READ_WRITE = 2
};

struct user_action
{
	const char* ua_user;
	const char* ua_role;
	const char* ua_password;
#ifdef TRUSTED_AUTH
	bool ua_trusted;
#endif
	bool ua_no_reserve;
	bool ua_force;
	bool ua_read_only;
	SLONG ua_shutdown_delay;
	SLONG ua_sweep_interval;
	TraNumber ua_transaction;
	SLONG ua_page_buffers;
	USHORT ua_debug;
	ULONG ua_val_errors[MAX_VAL_ERRORS];
	//TEXT ua_log_file[MAXPATHLEN];
	USHORT ua_db_SQL_dialect;
	alice_shut_mode ua_shutdown_mode;
	alice_repl_mode ua_replica_mode;
	SSHORT ua_parallel_workers;
};




// Transaction block: used to store info about a multi-database transaction.
// Transaction Description Record

struct tdr : public pool_alloc<alice_type_tdr>
{
	tdr* tdr_next;						// next sub-transaction
	TraNumber tdr_id;					// database-specific transaction id
	string tdr_fullpath;		// full (possibly) remote pathname
	string tdr_filename;		// filename
	string tdr_host_site;		// host for transaction
	string tdr_remote_site;	// site for remote transaction
	FB_API_HANDLE tdr_handle;			// reconnected transaction handle
	FB_API_HANDLE tdr_db_handle;		// re-attached database handle
	USHORT tdr_db_caps;					// capabilities of database
	USHORT tdr_state;					// see flags below

	tdr(MemoryPool& p)
		: tdr_fullpath(p), tdr_filename(p), tdr_host_site(p), tdr_remote_site(p)
	{ }
};

// CVC: This information should match Transaction Description Record constants in acl.h
inline constexpr int TDR_VERSION = 1;
enum tdr_vals {
	TDR_HOST_SITE		= 1,
	TDR_DATABASE_PATH	= 2,
	TDR_TRANSACTION_ID	= 3,
	TDR_REMOTE_SITE		= 4
	//TDR_PROTOCOL		= 5 // CVC: Unused
};

// flags for tdr_db_caps

enum tdr_db_caps_vals {
	CAP_none			= 0,
	CAP_transactions	= 1
};
// db has a RDB$TRANSACTIONS relation

// flags for tdr_state
enum tdr_state_vals {
	TRA_none		= 0,		// transaction description record is missing
	TRA_limbo		= 1,		// has been prepared
	TRA_commit		= 2,		// has committed
	TRA_rollback	= 3,		// has rolled back
	TRA_unknown		= 4 		// database couldn't be reattached, state is unknown
};


// Global data

class AliceGlobals : public ThreadData
{
private:
	MemoryPool* ALICE_default_pool;
	friend class SubsystemContextPoolHolder <AliceGlobals, MemoryPool>;

	void setDefaultPool(MemoryPool* p)
	{
		ALICE_default_pool = p;
	}

public:
	AliceGlobals(UtilSvc* us)
		: ThreadData(ThreadData::tddALICE),
		ALICE_default_pool(0),
		exit_code(FINI_ERROR),	// prevent FINI_OK in case of unknown error thrown
								// would be set to FINI_OK (==0) in ALICE_exit
		uSvc(us),
		output_file(NULL),
		db_handle(0),
		tr_handle(0),
		status(status_vector)
	{
		memset(&ALICE_data, 0, sizeof(user_action));
		memset(status_vector, 0, sizeof(status_vector));
	}

	MemoryPool* getDefaultPool()
	{
		return ALICE_default_pool;
	}

	user_action		ALICE_data;
	ISC_STATUS_ARRAY	status_vector;
	int				exit_code;
	UtilSvc*	uSvc;
	FILE*		output_file;
	isc_db_handle	db_handle;
	isc_tr_handle	tr_handle;
	ISC_STATUS*		status;

	static inline AliceGlobals* getSpecific()
	{
		ThreadData* tData = ThreadData::getSpecific();
		fb_assert(tData->getType() == ThreadData::tddALICE);
		return (AliceGlobals*) tData;
	}
	static inline void putSpecific(AliceGlobals* tdgbl)
	{
		tdgbl->ThreadData::putSpecific();
	}
	static inline void restoreSpecific()
	{
		ThreadData::restoreSpecific();
	}
};

typedef SubsystemContextPoolHolder <AliceGlobals, MemoryPool> AliceContextPoolHolder;

} // namespace Firebird::Alice

#endif	// ALICE_ALICE_H