firebird/firebird-mirror
firebird/firebird-mirror
8
0
Fork 1
mirror of https://github.com/FirebirdSQL/firebird.git synced 2025-01-23 22:03:03 +01:00
Code Issues
4c9fffd9b9
firebird-mirror/src/jrd/jrd.cpp
Adriano dos Santos Fernandes 4c9fffd9b9 Compiled statement cache.
2022-03-18 08:17:35 -03:00

9574 lines
221 KiB
C++
Raw Blame History

/*
* PROGRAM: JRD Access Method
* MODULE: jrd.cpp
* DESCRIPTION: User visible entrypoints
*
* 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): ______________________________________.
*
* 2001.07.06 Sean Leyne - Code Cleanup, removed "#ifdef READONLY_DATABASE"
* conditionals, as the engine now fully supports
* readonly databases.
* 2001.07.09 Sean Leyne - Restore default setting to Force Write = "On", for
* Windows NT platform, for new database files. This was changed
* with IB 6.0 to OFF and has introduced many reported database
* corruptions.
*
* 2002.10.29 Sean Leyne - Removed obsolete "Netware" port
* Claudio Valderrama C.
* Adriano dos Santos Fernandes
*
*/
#include "firebird.h"
#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include "../common/ThreadStart.h"
#include <stdarg.h>
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
#ifdef HAVE_PWD_H
#include <pwd.h>
#endif
#include <errno.h>
#include "../jrd/EngineInterface.h"
#include "../jrd/jrd.h"
#include "../jrd/irq.h"
#include "../jrd/drq.h"
#include "../jrd/req.h"
#include "../jrd/tra.h"
#include "../jrd/blb.h"
#include "../jrd/lck.h"
#include "../jrd/nbak.h"
#include "../jrd/scl.h"
#include "../jrd/os/pio.h"
#include "../jrd/ods.h"
#include "../jrd/exe.h"
#include "../jrd/extds/ExtDS.h"
#include "../jrd/val.h"
#include "../jrd/intl.h"
#include "../jrd/sbm.h"
#include "../jrd/svc.h"
#include "../jrd/sdw.h"
#include "../jrd/lls.h"
#include "../jrd/cch.h"
#include "../intl/charsets.h"
#include "../jrd/sort.h"
#include "../jrd/PreparedStatement.h"
#include "../jrd/ResultSet.h"
#include "../dsql/StmtNodes.h"
#include "../jrd/blb_proto.h"
#include "../jrd/cch_proto.h"
#include "../jrd/cmp_proto.h"
#include "../jrd/err_proto.h"
#include "../jrd/exe_proto.h"
#include "../jrd/ext_proto.h"
#include "../jrd/fun_proto.h"
#include "../yvalve/gds_proto.h"
#include "../jrd/inf_proto.h"
#include "../jrd/ini_proto.h"
#include "../jrd/intl_proto.h"
#include "../common/isc_f_proto.h"
#include "../common/isc_proto.h"
#include "../jrd/jrd_proto.h"
#include "../jrd/lck_proto.h"
#include "../jrd/met_proto.h"
#include "../jrd/mov_proto.h"
#include "../jrd/pag_proto.h"
#include "../jrd/par_proto.h"
#include "../jrd/os/pio_proto.h"
#include "../jrd/scl_proto.h"
#include "../jrd/sdw_proto.h"
#include "../jrd/shut_proto.h"
#include "../jrd/tpc_proto.h"
#include "../jrd/tra_proto.h"
#include "../jrd/val_proto.h"
#include "../jrd/validation.h"
#include "../jrd/vio_proto.h"
#include "../jrd/dfw_proto.h"
#include "../common/file_params.h"
#include "../jrd/event_proto.h"
#include "../yvalve/why_proto.h"
#include "../jrd/flags.h"
#include "../jrd/Mapping.h"
#include "../jrd/Database.h"
#include "../common/config/config.h"
#include "../common/config/dir_list.h"
#include "../common/db_alias.h"
#include "../jrd/replication/Publisher.h"
#include "../jrd/replication/Applier.h"
#include "../jrd/trace/TraceManager.h"
#include "../jrd/trace/TraceObjects.h"
#include "../jrd/trace/TraceJrdHelpers.h"
#include "../jrd/IntlManager.h"
#include "../common/classes/fb_tls.h"
#include "../common/classes/ClumpletWriter.h"
#include "../common/classes/RefMutex.h"
#include "../common/classes/ParsedList.h"
#include "../common/utils_proto.h"
#include "../jrd/DebugInterface.h"
#include "../jrd/CryptoManager.h"
#include "../jrd/DbCreators.h"
#include "../dsql/dsql.h"
#include "../dsql/dsql_proto.h"
#include "../dsql/DsqlBatch.h"
#include "../dsql/DsqlStatementCache.h"
#ifdef WIN_NT
#include <process.h>
#define getpid _getpid
#include "../common/dllinst.h"
#endif
using namespace Jrd;
using namespace Firebird;
const SSHORT WAIT_PERIOD = -1;
#ifdef SUPPORT_RAW_DEVICES
#define unlink PIO_unlink
#endif
namespace Jrd
{
int JBlob::release()
{
int rc = --refCounter;
if (rc != 0)
return rc;
if (blob)
{
LocalStatus status;
CheckStatusWrapper statusWrapper(&status);
freeEngineData(&statusWrapper);
}
if (blob)
{
// normal cleanup failed, take minimum precautions before deleting JBlob
blob->blb_interface = NULL;
blob = NULL;
}
delete this;
return 0;
}
int JTransaction::release()
{
int rc = --refCounter;
if (rc != 0)
return rc;
if (transaction)
{
LocalStatus status;
CheckStatusWrapper statusWrapper(&status);
freeEngineData(&statusWrapper);
}
if (transaction)
{
fb_assert(!(transaction->tra_flags & TRA_own_interface));
transaction->tra_flags |= TRA_own_interface;
addRef();
}
else
delete this;
return 0;
}
int JStatement::release()
{
int rc = --refCounter;
if (rc != 0)
return rc;
if (statement)
{
LocalStatus status;
CheckStatusWrapper statusWrapper(&status);
freeEngineData(&statusWrapper);
}
delete this;
return 0;
}
int JRequest::release()
{
int rc = --refCounter;
if (rc != 0)
return rc;
if (rq)
{
LocalStatus status;
CheckStatusWrapper statusWrapper(&status);
freeEngineData(&statusWrapper);
}
delete this;
return 0;
}
int JEvents::release()
{
int rc = --refCounter;
if (rc != 0)
return rc;
if (id >= 0)
{
LocalStatus status;
CheckStatusWrapper statusWrapper(&status);
freeEngineData(&statusWrapper);
}
delete this;
return 0;
}
JAttachment::JAttachment(StableAttachmentPart* sa)
: att(sa)
{
}
Attachment* JAttachment::getHandle() throw()
{
return att ? att->getHandle() : NULL;
}
const Attachment* JAttachment::getHandle() const throw()
{
return att ? att->getHandle() : NULL;
}
//#define DEBUG_ATT_COUNTERS
void JAttachment::addRef()
{
int v = ++refCounter;
#ifdef DEBUG_ATT_COUNTERS
ReferenceCounterDebugger* my = ReferenceCounterDebugger::get(DEB_AR_JATT);
const char* point = my ? my->rcd_point : " <Unknown> ";
fprintf(stderr, "addRef from <%s> att %p cnt=%d\n", point, this, v);
#endif
}
int JAttachment::release()
{
int r = --refCounter;
#ifdef DEBUG_ATT_COUNTERS
ReferenceCounterDebugger* my = ReferenceCounterDebugger::get(DEB_RLS_JATT);
const char* point = my ? my->rcd_point : " <Unknown> ";
fprintf(stderr, "Release from <%s> att %p cnt=%d\n", point, this, r);
#endif
if (r != 0)
return r;
if (att)
{
LocalStatus status;
CheckStatusWrapper statusWrapper(&status);
freeEngineData(&statusWrapper, true);
}
if (!att)
{
delete this;
}
return 0;
}
JBlob::JBlob(blb* handle, StableAttachmentPart* sa)
: blob(handle), sAtt(sa)
{
}
JTransaction::JTransaction(jrd_tra* handle, StableAttachmentPart* sa)
: transaction(handle), sAtt(sa)
{
}
JTransaction::JTransaction(JTransaction* from)
: transaction(from->transaction), sAtt(from->sAtt)
{
}
JResultSet::JResultSet(DsqlCursor* handle, JStatement* aStatement)
: cursor(handle), statement(aStatement), state(-1)
{
}
JRequest::JRequest(Statement* handle, StableAttachmentPart* sa)
: rq(handle), sAtt(sa)
{
}
JEvents::JEvents(int aId, StableAttachmentPart* sa, Firebird::IEventCallback* aCallback)
: id(aId), sAtt(sa), callback(aCallback)
{
}
JStatement::JStatement(DsqlRequest* handle, StableAttachmentPart* sa, Firebird::Array<UCHAR>& meta)
: statement(handle), sAtt(sa), metadata(getPool(), this, sAtt)
{
metadata.parse(meta.getCount(), meta.begin());
}
JService::JService(Jrd::Service* handle)
: svc(handle)
{
}
int JService::release()
{
int rc = --refCounter;
if (rc != 0)
return rc;
if (svc)
{
LocalStatus status;
CheckStatusWrapper statusWrapper(&status);
freeEngineData(&statusWrapper);
}
if (!svc)
{
delete this;
}
return 0;
}
static void threadDetach()
{
ThreadSync* thd = ThreadSync::findThread();
delete thd;
}
static void shutdownBeforeUnload()
{
LocalStatus status;
CheckStatusWrapper statusWrapper(&status);
AutoPlugin<JProvider>(JProvider::getInstance())->shutdown(&statusWrapper, 0, fb_shutrsn_exit_called);
threadDetach();
};
static JTransaction* checkTranIntf(StableAttachmentPart* sAtt, JTransaction* jt, jrd_tra* tra)
{
if (jt && !tra)
{
jt->setHandle(NULL);
jt->release();
jt = NULL;
}
else if (tra && !jt)
{
jt = tra->getInterface(false);
if (jt)
tra->tra_flags &= ~TRA_own_interface;
else
{
jt = FB_NEW JTransaction(tra, sAtt);
tra->setInterface(jt);
jt->addRef();
}
}
else if (tra && jt)
{
jt->setHandle(tra);
tra->setInterface(jt);
}
return jt;
};
class EngineFactory : public AutoIface<IPluginFactoryImpl<EngineFactory, CheckStatusWrapper> >
{
public:
// IPluginFactory implementation
IPluginBase* createPlugin(CheckStatusWrapper* status, IPluginConfig* factoryParameter)
{
try
{
if (getUnloadDetector()->unloadStarted())
{
Arg::Gds(isc_att_shut_engine).raise();
}
IPluginBase* p = FB_NEW JProvider(factoryParameter);
p->addRef();
return p;
}
catch (const Firebird::Exception& ex)
{
ex.stuffException(status);
}
return NULL;
}
};
static Static<EngineFactory> engineFactory;
//-------------------------------
void registerEngine(IPluginManager* iPlugin)
{
UnloadDetectorHelper* module = getUnloadDetector();
module->setCleanup(shutdownBeforeUnload);
module->setThreadDetach(threadDetach);
iPlugin->registerPluginFactory(IPluginManager::TYPE_PROVIDER, CURRENT_ENGINE, &engineFactory);
module->registerMe();
}
} // namespace Jrd
extern "C" FB_DLL_EXPORT void FB_PLUGIN_ENTRY_POINT(IMaster* master)
{
CachedMasterInterface::set(master);
registerEngine(PluginManagerInterfacePtr());
}
namespace
{
using Jrd::Attachment;
// Flag engineShutdown guarantees that no new attachment is created after setting it
// and helps avoid more than 1 shutdown threads running simultaneously.
bool engineShutdown = false;
// This flag is protected with 2 mutexes. shutdownMutex is taken by each shutdown thread
// (for a relatively long time). newAttachmentMutex is taken (for a short time) when
// shutdown thread is starting shutdown and also when new attachment is created.
GlobalPtr<Mutex> shutdownMutex, newAttachmentMutex;
// This mutex is set when new Database block is created. It's global first of all to satisfy
// SS requirement - avoid 2 Database blocks for same database (file). Also guarantees no
// half-done Database block in databases linked list. Always taken before databases_mutex.
GlobalPtr<Mutex> dbInitMutex;
Database* databases = NULL;
// This mutex protects linked list of databases
GlobalPtr<Mutex> databases_mutex;
// Holder for per-database init/fini mutex
class RefMutexUnlock
{
public:
RefMutexUnlock()
: entered(false)
{ }
explicit RefMutexUnlock(Database::ExistenceRefMutex* p)
: ref(p), entered(false)
{ }
void enter()
{
fb_assert(ref);
ref->enter();
entered = true;
}
void leave()
{
if (entered)
{
ref->leave();
entered = false;
}
}
void linkWith(Database::ExistenceRefMutex* to)
{
if (ref == to)
return;
leave();
ref = to;
}
void unlinkFromMutex()
{
linkWith(NULL);
}
Database::ExistenceRefMutex* operator->()
{
return ref;
}
bool operator!() const
{
return !ref;
}
~RefMutexUnlock()
{
leave();
}
private:
RefPtr<Database::ExistenceRefMutex> ref;
bool entered;
};
// We have 2 more related types of mutexes in database and attachment.
// Attachment is using reference counted mutex in JAtt, also making it possible
// to check does object still exist after locking a mutex. This makes great use when
// checking for correctness of attachment in provider's entrypoints. Attachment mutex
// is always taken before database's mutex and (except when new attachment is created)
// when entering inside provider and releases when waiting for something or when rescheduling.
// Database mutex (dbb_sync) is taken when access to database-wide data (like list of
// attachments) is accessed. No other mutex from above mentioned here can be taken after
// dbb_sync with an exception of attachment mutex for new attachment.
// So finally the order of taking mutexes is:
// 1. dbInitMutex (in attach/create database) or attachment mutex in other entries
// 2. databases_mutex (when / if needed)
// 3. dbb_sync (when / if needed)
// 4. only for new attachments: attachment mutex when that attachment is created
// Any of this may be missing when not needed, but order of taking should not be changed.
class EngineStartup
{
public:
static void init()
{
IbUtil::initialize();
IntlManager::initialize();
ExtEngineManager::initialize();
}
static void cleanup()
{
}
};
InitMutex<EngineStartup> engineStartup("EngineStartup");
class OverwriteHolder : public MutexLockGuard
{
public:
explicit OverwriteHolder(Database* to_remove)
: MutexLockGuard(databases_mutex, FB_FUNCTION), dbb(to_remove)
{
if (!dbb)
return;
for (Database** d_ptr = &databases; *d_ptr; d_ptr = &(*d_ptr)->dbb_next)
{
if (*d_ptr == dbb)
{
*d_ptr = dbb->dbb_next;
dbb->dbb_next = NULL;
return;
}
}
fb_assert(!dbb);
dbb = NULL;
}
~OverwriteHolder()
{
if (dbb)
{
dbb->dbb_next = databases;
databases = dbb;
}
}
private:
Database* dbb;
};
inline void validateHandle(thread_db* tdbb, Jrd::Attachment* const attachment)
{
if (attachment && attachment == tdbb->getAttachment())
return;
if (!attachment || !attachment->att_database)
status_exception::raise(Arg::Gds(isc_bad_db_handle));
tdbb->setAttachment(attachment);
tdbb->setDatabase(attachment->att_database);
}
inline void validateHandle(thread_db* tdbb, jrd_tra* const transaction)
{
if (!transaction)
status_exception::raise(Arg::Gds(isc_bad_trans_handle));
const Attachment* att = tdbb->getAttachment();
if (att && transaction->tra_attachment)
fb_assert(att == transaction->tra_attachment);
validateHandle(tdbb, transaction->tra_attachment);
tdbb->setTransaction(transaction);
}
inline void validateHandle(thread_db* tdbb, Statement* const statement)
{
if (!statement)
status_exception::raise(Arg::Gds(isc_bad_req_handle));
validateHandle(tdbb, statement->requests[0]->req_attachment);
}
inline void validateHandle(thread_db* tdbb, DsqlRequest* const statement)
{
if (!statement)
status_exception::raise(Arg::Gds(isc_bad_req_handle));
validateHandle(tdbb, statement->req_dbb->dbb_attachment);
}
inline void validateHandle(thread_db* tdbb, blb* blob)
{
if (!blob)
status_exception::raise(Arg::Gds(isc_bad_segstr_handle));
validateHandle(tdbb, blob->getTransaction());
validateHandle(tdbb, blob->getAttachment());
}
inline void validateHandle(Service* service)
{
if (!service)
status_exception::raise(Arg::Gds(isc_bad_svc_handle));
}
inline void validateHandle(thread_db* tdbb, JEvents* const events)
{
validateHandle(tdbb, events->getAttachment()->getHandle());
}
inline void validateHandle(thread_db* tdbb, DsqlCursor* const cursor)
{
if (!cursor)
status_exception::raise(Arg::Gds(isc_bad_req_handle));
validateHandle(tdbb, cursor->getTransaction());
validateHandle(tdbb, cursor->getAttachment());
}
inline void validateHandle(thread_db* tdbb, DsqlBatch* const batch)
{
if (!batch)
status_exception::raise(Arg::Gds(isc_bad_batch_handle));
validateHandle(tdbb, batch->getAttachment());
}
inline void validateHandle(thread_db* tdbb, Applier* const applier)
{
if (!applier)
status_exception::raise(Arg::Gds(isc_bad_repl_handle));
validateHandle(tdbb, applier->getAttachment());
}
class AttachmentHolder
{
public:
static const unsigned ATT_LOCK_ASYNC = 1;
static const unsigned ATT_DONT_LOCK = 2;
static const unsigned ATT_NO_SHUTDOWN_CHECK = 4;
static const unsigned ATT_NON_BLOCKING = 8;
AttachmentHolder(thread_db* tdbb, StableAttachmentPart* sa, unsigned lockFlags, const char* from)
: sAtt(sa),
async(lockFlags & ATT_LOCK_ASYNC),
nolock(lockFlags & ATT_DONT_LOCK),
blocking(!(lockFlags & ATT_NON_BLOCKING))
{
if (!sa)
Arg::Gds(isc_att_shutdown).raise();
if (blocking)
sAtt->getBlockingMutex()->enter(from);
try
{
if (!nolock)
sAtt->getSync(async)->enter(from);
Jrd::Attachment* attachment = sAtt->getHandle(); // Must be done after entering mutex
try
{
if (!attachment || (engineShutdown && !(lockFlags & ATT_NO_SHUTDOWN_CHECK)))
{
// This shutdown check is an optimization, threads can still enter engine
// with the flag set cause shutdownMutex mutex is not locked here.
// That's not a danger cause check of att_use_count
// in shutdown code makes it anyway safe.
Arg::Gds err(isc_att_shutdown);
if (sAtt->getShutError())
err << Arg::Gds(sAtt->getShutError());
err.raise();
}
tdbb->setAttachment(attachment);
tdbb->setDatabase(attachment->att_database);
if (!async)
{
attachment->att_use_count++;
attachment->setupIdleTimer(true);
}
}
catch (const Firebird::Exception&)
{
if (!nolock)
sAtt->getSync(async)->leave();
throw;
}
}
catch (const Firebird::Exception&)
{
if (blocking)
sAtt->getBlockingMutex()->leave();
throw;
}
}
~AttachmentHolder()
{
Jrd::Attachment* attachment = sAtt->getHandle();
if (attachment && !async)
{
attachment->att_use_count--;
if (!attachment->att_use_count)
attachment->setupIdleTimer(false);
}
if (!nolock)
sAtt->getSync(async)->leave();
if (blocking)
sAtt->getBlockingMutex()->leave();
}
private:
RefPtr<StableAttachmentPart> sAtt;
bool async; // async mutex should be locked instead normal
bool nolock; // if locked manually, no need to take lock recursively
bool blocking; // holder instance is blocking other instances
private:
// copying is prohibited
AttachmentHolder(const AttachmentHolder&);
AttachmentHolder& operator =(const AttachmentHolder&);
};
class EngineContextHolder : public ThreadContextHolder, private AttachmentHolder,
private DatabaseContextHolder
{
public:
template <typename I>
EngineContextHolder(CheckStatusWrapper* status, I* interfacePtr, const char* from,
unsigned lockFlags = 0)
: ThreadContextHolder(status),
AttachmentHolder(*this, interfacePtr->getAttachment(), lockFlags, from),
DatabaseContextHolder(operator thread_db*())
{
validateHandle(*this, interfacePtr->getHandle());
}
};
void validateAccess(thread_db* tdbb, Jrd::Attachment* attachment, SystemPrivilege sp)
{
if (!attachment->locksmith(tdbb, sp))
{
PreparedStatement::Builder sql;
MetaName missPriv("UNKNOWN");
sql << "select" << sql("rdb$type_name", missPriv) << "from rdb$types"
<< "where rdb$field_name = 'RDB$SYSTEM_PRIVILEGES'"
<< " and rdb$type =" << SSHORT(sp);
jrd_tra* transaction = attachment->getSysTransaction();
AutoPreparedStatement ps(attachment->prepareStatement(tdbb, transaction, sql));
AutoResultSet rs(ps->executeQuery(tdbb, transaction));
rs->fetch(tdbb);
const UserId* const u = attachment->att_user;
Arg::Gds err(isc_adm_task_denied);
err << Arg::Gds(isc_miss_prvlg) << missPriv;
if (u && u->testFlag(USR_mapdown))
err << Arg::Gds(isc_map_down);
ERR_post(err);
}
}
class DefaultCallback : public AutoIface<ICryptKeyCallbackImpl<DefaultCallback, CheckStatusWrapper> >
{
public:
unsigned int callback(unsigned int, const void*, unsigned int, void*)
{
return 0;
}
};
DefaultCallback defCallback;
ICryptKeyCallback* getDefCryptCallback(ICryptKeyCallback* callback)
{
return callback ? callback : &defCallback;
}
} // anonymous
#ifdef WIN_NT
#include <windows.h>
// these should stop a most annoying warning
#undef TEXT
#define TEXT SCHAR
#endif // WIN_NT
bool Trigger::isActive() const
{
return statement && statement->isActive();
}
void Trigger::compile(thread_db* tdbb)
{
SET_TDBB(tdbb);
Database* dbb = tdbb->getDatabase();
Jrd::Attachment* const att = tdbb->getAttachment();
if (extTrigger)
return;
if (!statement)
{
// Allocate statement memory pool
MemoryPool* new_pool = att->createPool();
// Trigger request is not compiled yet. Lets do it now
USHORT par_flags = (USHORT) (flags & TRG_ignore_perm) ? csb_ignore_perm : 0;
if (type & 1)
par_flags |= csb_pre_trigger;
else
par_flags |= csb_post_trigger;
try
{
Jrd::ContextPoolHolder context(tdbb, new_pool);
AutoPtr<CompilerScratch> auto_csb(FB_NEW_POOL(*new_pool) CompilerScratch(*new_pool));
CompilerScratch* csb = auto_csb;
csb->csb_g_flags |= par_flags;
if (engine.isEmpty())
{
if (debugInfo.hasData())
{
DBG_parse_debug_info((ULONG) debugInfo.getCount(), debugInfo.begin(),
*csb->csb_dbg_info);
}
PAR_blr(tdbb, relation, blr.begin(), (ULONG) blr.getCount(), NULL, &csb, &statement,
(relation ? true : false), par_flags);
}
else
{
dbb->dbb_extManager->makeTrigger(tdbb, csb, this, engine, entryPoint, extBody.c_str(),
(relation ?
(type & 1 ? IExternalTrigger::TYPE_BEFORE : IExternalTrigger::TYPE_AFTER) :
IExternalTrigger::TYPE_DATABASE));
}
}
catch (const Exception&)
{
if (statement)
{
statement->release(tdbb);
statement = NULL;
}
else
att->deletePool(new_pool);
throw;
}
statement->triggerName = name;
if (ssDefiner.orElse(false))
statement->triggerInvoker = att->getUserId(owner);
if (sysTrigger)
statement->flags |= Statement::FLAG_SYS_TRIGGER;
if (flags & TRG_ignore_perm)
statement->flags |= Statement::FLAG_IGNORE_PERM;
}
}
void Trigger::release(thread_db* tdbb)
{
if (extTrigger)
{
delete extTrigger;
extTrigger = NULL;
}
// dimitr: We should never release triggers created by MET_parse_sys_trigger().
// System triggers do have BLR, but it's not stored inside the trigger object.
// However, triggers backing RI constraints are also marked as system,
// but they are loaded in a regular way and their BLR is present here.
// This is why we cannot simply check for sysTrigger, sigh.
const bool sysTableTrigger = (blr.isEmpty() && engine.isEmpty());
if (sysTableTrigger || !statement || statement->isActive() || releaseInProgress)
return;
AutoSetRestore<bool> autoProgressFlag(&releaseInProgress, true);
statement->release(tdbb);
statement = NULL;
}
namespace
{
class DatabaseBindings : public CoercionArray
{
public:
DatabaseBindings(MemoryPool& p)
: CoercionArray(p)
{
// FB 2.5
versions[0].ind = getCount();
versions[0].txt = "2.5";
// bool compatibility
add().makeLegacy()->makeBoolean();
// FB 3.0
versions[1].ind = getCount();
versions[1].txt = "3.0";
// decfloat compatibility
add().makeLegacy()->makeDecimal128();
// int128 compatibility
add().makeLegacy()->makeInt128(0);
// TZ compatibility
add().makeLegacy()->makeTimestampTz();
add().makeLegacy()->makeTimeTz();
}
unsigned getCompatibilityIndex(const char* txt)
{
if (txt)
{
for (unsigned i = 0; i < FB_NELEM(versions); ++i)
{
if (strcmp(txt, versions[i].txt) == 0)
return i;
}
}
return ~0U;
}
private:
struct Version
{
unsigned ind;
const char* txt;
};
Version versions[2];
};
InitInstance<DatabaseBindings> databaseBindings;
}
namespace Jrd
{
// Option block for database parameter block
class DatabaseOptions
{
public:
USHORT dpb_wal_action;
SLONG dpb_sweep_interval;
ULONG dpb_page_buffers;
bool dpb_set_page_buffers;
ULONG dpb_buffers;
USHORT dpb_verify;
USHORT dpb_sweep;
USHORT dpb_dbkey_scope;
SLONG dpb_page_size;
bool dpb_activate_shadow;
bool dpb_delete_shadow;
bool dpb_no_garbage;
USHORT dpb_shutdown;
SSHORT dpb_shutdown_delay;
USHORT dpb_online;
bool dpb_force_write;
bool dpb_set_force_write;
bool dpb_no_reserve;
bool dpb_set_no_reserve;
SSHORT dpb_interp;
bool dpb_single_user;
bool dpb_overwrite;
bool dpb_sec_attach;
bool dpb_disable_wal;
SLONG dpb_connect_timeout;
SLONG dpb_dummy_packet_interval;
bool dpb_db_readonly;
bool dpb_set_db_readonly;
bool dpb_gfix_attach;
bool dpb_gstat_attach;
USHORT dpb_sql_dialect;
USHORT dpb_set_db_sql_dialect;
SLONG dpb_remote_pid;
bool dpb_no_db_triggers;
bool dpb_gbak_attach;
bool dpb_utf8_filename;
ULONG dpb_ext_call_depth;
ULONG dpb_flags; // to OR'd with dbb_flags
bool dpb_nolinger;
bool dpb_reset_icu;
bool dpb_map_attach;
ULONG dpb_remote_flags;
ReplicaMode dpb_replica_mode;
bool dpb_set_db_replica;
bool dpb_clear_map;
// here begin compound objects
// for constructor to work properly dpb_user_name
// MUST be FIRST
string dpb_user_name;
AuthReader::AuthBlock dpb_auth_block;
string dpb_role_name;
string dpb_journal;
string dpb_lc_ctype;
PathName dpb_working_directory;
string dpb_set_db_charset;
string dpb_network_protocol;
PathName dpb_remote_crypt;
string dpb_remote_address;
string dpb_remote_host;
string dpb_remote_os_user;
string dpb_client_version;
string dpb_remote_protocol;
string dpb_trusted_login;
PathName dpb_remote_process;
PathName dpb_org_filename;
string dpb_config;
string dpb_session_tz;
PathName dpb_set_bind;
string dpb_decfloat_round;
string dpb_decfloat_traps;
public:
static const ULONG DPB_FLAGS_MASK = DBB_damaged;
DatabaseOptions()
{
memset(this, 0, reinterpret_cast<char*>(&this->dpb_user_name) - reinterpret_cast<char*>(this));
}
void get(const UCHAR*, USHORT, bool&);
void setBuffers(RefPtr<const Config> config)
{
if (dpb_buffers == 0)
{
dpb_buffers = config->getDefaultDbCachePages();
if (dpb_buffers < MIN_PAGE_BUFFERS)
dpb_buffers = MIN_PAGE_BUFFERS;
if (dpb_buffers > MAX_PAGE_BUFFERS)
dpb_buffers = MAX_PAGE_BUFFERS;
}
}
private:
void getPath(ClumpletReader& reader, PathName& s)
{
reader.getPath(s);
if (!dpb_utf8_filename)
ISC_systemToUtf8(s);
ISC_unescape(s);
}
void getString(ClumpletReader& reader, string& s)
{
reader.getString(s);
if (!dpb_utf8_filename)
ISC_systemToUtf8(s);
ISC_unescape(s);
}
};
const CoercionArray* Database::getBindings() const
{
return &(databaseBindings());
}
void Attachment::setInitialOptions(thread_db* tdbb, DatabaseOptions& options, bool newDb)
{
if (newDb)
{
Database* dbb = tdbb->getDatabase();
const char* dataTypeCompatibility = dbb->dbb_config->getDataTypeCompatibility();
dbb->dbb_compatibility_index = databaseBindings().getCompatibilityIndex(dataTypeCompatibility);
}
att_initial_options.setInitialOptions(tdbb, options);
att_initial_options.resetAttachment(this);
}
void Attachment::InitialOptions::setInitialOptions(thread_db* tdbb, const DatabaseOptions& options)
{
if (options.dpb_set_bind.hasData())
{
ParsedList rules(options.dpb_set_bind, ";");
Attachment* att = tdbb->getAttachment();
AutoSetRestore<CoercionArray*> defSet(&att->att_dest_bind, getBindings());
for (unsigned i = 0; i < rules.getCount(); ++i)
{
rules[i].insert(0, "SET BIND OF ");
try
{
AutoPreparedStatement ps(att->prepareStatement(tdbb, nullptr, rules[i].ToString()));
ps->execute(tdbb, nullptr);
}
catch (const Exception& ex)
{
FbLocalStatus status;
ex.stuffException(&status);
// strip spam messages
const ISC_STATUS* v = status->getErrors();
for (; v[0] == isc_arg_gds; v = fb_utils::nextCode(v))
{
if (v[1] != isc_dsql_error && v[1] != isc_sqlerr)
break;
}
// build and throw new vector
Arg::Gds newErr(isc_bind_err);
newErr << options.dpb_set_bind <<
Arg::Gds(isc_bind_statement) << rules[i];
newErr << Arg::StatusVector(v);
newErr.raise();
}
}
}
if (options.dpb_decfloat_round.hasData())
{
const DecFloatConstant* dfConst = DecFloatConstant::getByText(
options.dpb_decfloat_round.c_str(), FB_DEC_RoundModes, FB_DEC_RMODE_OFFSET);
if (!dfConst)
(Arg::Gds(isc_invalid_decfloat_round) << options.dpb_decfloat_round).raise();
decFloatStatus.roundingMode = dfConst->val;
}
if (options.dpb_decfloat_traps.hasData())
{
FB_SIZE_T pos = -1;
USHORT traps = 0;
do {
FB_SIZE_T start = pos + 1;
pos = options.dpb_decfloat_traps.find(',', start);
const auto trap = options.dpb_decfloat_traps.substr(start,
(pos == string::npos ? pos : pos - start));
const DecFloatConstant* dfConst = DecFloatConstant::getByText(
trap.c_str(), FB_DEC_IeeeTraps, FB_DEC_TRAPS_OFFSET);
if (!dfConst)
(Arg::Gds(isc_invalid_decfloat_trap) << trap).raise();
traps |= dfConst->val;
if (pos != string::npos)
{
const char* p = &options.dpb_decfloat_traps[pos + 1];
while (*p == ' ')
{
++p;
++pos;
}
}
} while (pos != string::npos);
decFloatStatus.decExtFlag = traps;
}
originalTimeZone = options.dpb_session_tz.isEmpty() ?
TimeZoneUtil::getSystemTimeZone() :
TimeZoneUtil::parse(options.dpb_session_tz.c_str(), options.dpb_session_tz.length());
}
void Attachment::InitialOptions::resetAttachment(Attachment* attachment) const
{
// reset DecFloat options
attachment->att_dec_status = decFloatStatus;
// reset time zone options
attachment->att_current_timezone = attachment->att_original_timezone = originalTimeZone;
// reset bindings
attachment->att_bindings.clear();
}
} // namespace Jrd
/// trace manager support
class TraceFailedConnection :
public AutoIface<ITraceDatabaseConnectionImpl<TraceFailedConnection, CheckStatusWrapper> >
{
public:
TraceFailedConnection(const char* filename, const DatabaseOptions* options);
// TraceConnection implementation
unsigned getKind() { return KIND_DATABASE; };
int getProcessID() { return m_options->dpb_remote_pid; }
const char* getUserName() { return m_id.getUserName().c_str(); }
const char* getRoleName() { return m_options->dpb_role_name.c_str(); }
const char* getCharSet() { return m_options->dpb_lc_ctype.c_str(); }
const char* getRemoteProtocol() { return m_options->dpb_network_protocol.c_str(); }
const char* getRemoteAddress() { return m_options->dpb_remote_address.c_str(); }
int getRemoteProcessID() { return m_options->dpb_remote_pid; }
const char* getRemoteProcessName() { return m_options->dpb_remote_process.c_str(); }
// TraceDatabaseConnection implementation
ISC_INT64 getConnectionID() { return 0; }
const char* getDatabaseName() { return m_filename; }
private:
const char* m_filename;
const DatabaseOptions* m_options;
UserId m_id;
};
static void check_database(thread_db* tdbb, bool async = false);
static void commit(thread_db*, jrd_tra*, const bool);
static bool drop_files(const jrd_file*);
static void find_intl_charset(thread_db*, Jrd::Attachment*, const DatabaseOptions*);
static void init_database_lock(thread_db*);
static void run_commit_triggers(thread_db* tdbb, jrd_tra* transaction);
static Request* verify_request_synchronization(Statement* statement, USHORT level);
static void purge_transactions(thread_db*, Jrd::Attachment*, const bool);
static void check_single_maintenance(thread_db* tdbb);
namespace {
enum VdnResult {VDN_FAIL, VDN_OK/*, VDN_SECURITY*/};
}
static VdnResult verifyDatabaseName(const PathName&, FbStatusVector*, bool);
static void unwindAttach(thread_db* tdbb, const Exception& ex, FbStatusVector* userStatus, bool internalFlag);
static JAttachment* initAttachment(thread_db*, const PathName&, const PathName&, RefPtr<const Config>, bool,
const DatabaseOptions&, RefMutexUnlock&, IPluginConfig*, JProvider*);
static JAttachment* create_attachment(const PathName&, Database*, JProvider* provider, const DatabaseOptions&, bool newDb);
static void prepare_tra(thread_db*, jrd_tra*, USHORT, const UCHAR*);
static void release_attachment(thread_db*, Attachment*);
static void start_transaction(thread_db* tdbb, bool transliterate, jrd_tra** tra_handle,
Jrd::Attachment* attachment, unsigned int tpb_length, const UCHAR* tpb);
static void rollback(thread_db*, jrd_tra*, const bool);
static void purge_attachment(thread_db* tdbb, StableAttachmentPart* sAtt, unsigned flags = 0);
static void getUserInfo(UserId&, const DatabaseOptions&, const char*,
const RefPtr<const Config>*, bool, Mapping& mapping, bool);
static void waitForShutdown(Semaphore&);
static THREAD_ENTRY_DECLARE shutdown_thread(THREAD_ENTRY_PARAM);
// purge_attachment() flags
static const unsigned PURGE_FORCE = 0x01;
static const unsigned PURGE_LINGER = 0x02;
static const unsigned PURGE_NOCHECK = 0x04;
TraceFailedConnection::TraceFailedConnection(const char* filename, const DatabaseOptions* options) :
m_filename(filename),
m_options(options)
{
Mapping mapping(Mapping::MAP_ERROR_HANDLER, NULL);
mapping.setAuthBlock(m_options->dpb_auth_block);
getUserInfo(m_id, *m_options, m_filename, NULL, false, mapping, false);
}
//____________________________________________________________
//
// check whether we need to perform an autocommit;
// do it here to prevent committing every record update
// in a statement
//
static void check_autocommit(thread_db* tdbb, Request* request)
{
jrd_tra* const transaction = request->req_transaction;
// Ignore autocommit for:
// 1) cancelled requests (already detached from the transaction)
// 2) requests created by EXECUTE STATEMENT or coming from external engines
// 3) internal requests (they may be executed through the DSQL layer)
if (!transaction ||
transaction->tra_callback_count ||
request->hasInternalStatement())
{
return;
}
if (transaction->tra_flags & TRA_perform_autocommit)
{
if (!(tdbb->getAttachment()->att_flags & ATT_no_db_triggers) &&
!(transaction->tra_flags & TRA_prepared))
{
// run ON TRANSACTION COMMIT triggers
run_commit_triggers(tdbb, transaction);
}
transaction->tra_flags &= ~TRA_perform_autocommit;
TRA_commit(tdbb, transaction, true);
}
}
static void successful_completion(CheckStatusWrapper* s, ISC_STATUS acceptCode = 0)
{
fb_assert(s);
const ISC_STATUS* status = s->getErrors();
// This assert validates whether we really have a successful status vector
fb_assert(status[0] != isc_arg_gds || status[1] == FB_SUCCESS || status[1] == acceptCode);
// Clear the status vector if it doesn't contain a warning
if (status[0] != isc_arg_gds || status[1] != FB_SUCCESS || !(s->getState() & IStatus::STATE_WARNINGS))
{
s->init();
}
}
// Stuff exception transliterated to the client charset.
static ISC_STATUS transliterateException(thread_db* tdbb, const Exception& ex, FbStatusVector* vector,
const char* func) throw()
{
ex.stuffException(vector);
Jrd::Attachment* attachment = tdbb->getAttachment();
if (func && attachment && attachment->att_trace_manager->needs(ITraceFactory::TRACE_EVENT_ERROR))
{
TraceConnectionImpl conn(attachment);
TraceStatusVectorImpl traceStatus(vector, TraceStatusVectorImpl::TS_ERRORS);
attachment->att_trace_manager->event_error(&conn, &traceStatus, func);
}
JRD_transliterate(tdbb, vector);
return vector->getErrors()[1];
}
// Transliterate status vector to the client charset.
void JRD_transliterate(thread_db* tdbb, Firebird::IStatus* vector) throw()
{
Jrd::Attachment* attachment = tdbb->getAttachment();
USHORT charSet;
if (!attachment || (charSet = attachment->att_client_charset) == CS_METADATA ||
charSet == CS_NONE)
{
return;
}
const ISC_STATUS* const vectorStart = vector->getErrors();
const ISC_STATUS* status = vectorStart;
StaticStatusVector newVector;
ObjectsArray<UCharBuffer> buffers;
try
{
bool cont = true;
while (cont)
{
const ISC_STATUS type = *status++;
newVector.push(type);
switch (type)
{
case isc_arg_end:
cont = false;
break;
case isc_arg_cstring:
{
FB_SIZE_T len = *status++;
const UCHAR* str = reinterpret_cast<UCHAR*>(*status++);
try
{
UCharBuffer& b(buffers.add());
UCHAR* p = b.getBuffer(len + 1);
len = INTL_convert_bytes(tdbb, charSet, p, len, CS_METADATA, str, len, ERR_post);
p[len] = '\0';
str = p;
}
catch (const Exception&)
{} // no-op
newVector.push(len);
newVector.push((ISC_STATUS)(IPTR) str);
}
break;
case isc_arg_string:
case isc_arg_interpreted:
{
const UCHAR* str = reinterpret_cast<UCHAR*>(*status++);
FB_SIZE_T len = fb_strlen((const char*) str);
try
{
UCharBuffer& b(buffers.add());
UCHAR* p = b.getBuffer(len + 1);
len = INTL_convert_bytes(tdbb, charSet, p, len, CS_METADATA, str, len, ERR_post);
p[len] = '\0';
str = p;
}
catch (const Exception&)
{} // no-op
newVector.push((ISC_STATUS)(IPTR) str);
}
break;
default:
newVector.push(*status++);
break;
}
}
}
catch (...)
{
return;
}
vector->setErrors2(newVector.getCount() - 1, newVector.begin());
}
const ULONG SWEEP_INTERVAL = 20000;
static void trace_warning(thread_db* tdbb, FbStatusVector* userStatus, const char* func)
{
Jrd::Attachment* att = tdbb->getAttachment();
if (!att)
return;
if (att->att_trace_manager->needs(ITraceFactory::TRACE_EVENT_ERROR))
{
TraceStatusVectorImpl traceStatus(userStatus, TraceStatusVectorImpl::TS_WARNINGS);
if (traceStatus.hasWarning())
{
TraceConnectionImpl conn(att);
att->att_trace_manager->event_error(&conn, &traceStatus, func);
}
}
}
static void trace_failed_attach(TraceManager* traceManager, const char* filename,
const DatabaseOptions& options, bool create, FbStatusVector* status)
{
// Report to Trace API that attachment has not been created
const char* origFilename = filename;
if (options.dpb_org_filename.hasData())
origFilename = options.dpb_org_filename.c_str();
TraceFailedConnection conn(origFilename, &options);
TraceStatusVectorImpl traceStatus(status, TraceStatusVectorImpl::TS_ERRORS);
ISC_STATUS s = status->getErrors()[1];
const ntrace_result_t result = (s == isc_login || s == isc_no_priv) ?
ITracePlugin::RESULT_UNAUTHORIZED : ITracePlugin::RESULT_FAILED;
const char* func = create ? "JProvider::createDatabase" : "JProvider::attachDatabase";
if (!traceManager)
{
TraceManager tempMgr(origFilename);
if (tempMgr.needs(ITraceFactory::TRACE_EVENT_ATTACH))
tempMgr.event_attach(&conn, create, result);
if (tempMgr.needs(ITraceFactory::TRACE_EVENT_ERROR))
tempMgr.event_error(&conn, &traceStatus, func);
}
else
{
if (traceManager->needs(ITraceFactory::TRACE_EVENT_ATTACH))
traceManager->event_attach(&conn, create, result);
if (traceManager->needs(ITraceFactory::TRACE_EVENT_ERROR))
traceManager->event_error(&conn, &traceStatus, func);
}
}
namespace Jrd {
JTransaction* JAttachment::getTransactionInterface(CheckStatusWrapper* status, ITransaction* tra)
{
if (!tra)
Arg::Gds(isc_bad_trans_handle).raise();
status->init();
// If validation is successfull, this means that this attachment and valid transaction
// use same provider. I.e. the following cast is safe.
JTransaction* jt = static_cast<JTransaction*>(tra->validate(status, this));
if (status->getState() & IStatus::STATE_ERRORS)
status_exception::raise(status);
if (!jt)
Arg::Gds(isc_bad_trans_handle).raise();
return jt;
}
jrd_tra* JAttachment::getEngineTransaction(CheckStatusWrapper* status, ITransaction* tra)
{
return getTransactionInterface(status, tra)->getHandle();
}
JAttachment* JProvider::attachDatabase(CheckStatusWrapper* user_status, const char* filename,
unsigned int dpb_length, const unsigned char* dpb)
{
return internalAttach(user_status, filename, dpb_length, dpb, NULL);
}
JAttachment* JProvider::internalAttach(CheckStatusWrapper* user_status, const char* const filename,
unsigned int dpb_length, const unsigned char* dpb, const UserId* existingId)
{
/**************************************
*
* g d s _ $ a t t a c h _ d a t a b a s e
*
**************************************
*
* Functional description
* Attach a moldy, grungy, old database
* sullied by user data.
*
**************************************/
try
{
ThreadContextHolder tdbb(user_status);
DatabaseOptions options;
RefPtr<const Config> config;
bool invalid_client_SQL_dialect = false;
PathName org_filename, expanded_name;
bool is_alias = false;
MutexEnsureUnlock guardDbInit(dbInitMutex, FB_FUNCTION);
Mapping mapping(Mapping::MAP_THROW_NOT_FOUND, cryptCallback);
try
{
// Process database parameter block
options.get(dpb, dpb_length, invalid_client_SQL_dialect);
// And provide info about auth block to mapping
mapping.setAuthBlock(options.dpb_auth_block);
if (options.dpb_org_filename.hasData())
org_filename = options.dpb_org_filename;
else
{
org_filename = filename;
if (!options.dpb_utf8_filename)
ISC_systemToUtf8(org_filename);
ISC_unescape(org_filename);
}
ISC_utf8ToSystem(org_filename);
// Resolve given alias name
is_alias = expandDatabaseName(org_filename, expanded_name, &config);
if (!is_alias)
{
expanded_name = filename;
if (!options.dpb_utf8_filename)
ISC_systemToUtf8(expanded_name);
ISC_unescape(expanded_name);
ISC_utf8ToSystem(expanded_name);
}
// Check to see if the database is truly local
if (ISC_check_if_remote(expanded_name, true))
ERR_post(Arg::Gds(isc_unavailable));
// We are ready to setup security database - before entering guardDbInit!!!
mapping.setSecurityDbAlias(config->getSecurityDatabase(), expanded_name.c_str());
#ifdef WIN_NT
guardDbInit.enter(); // Required to correctly expand name of just created database
// Need to re-expand under lock to take into an account file existance (or not)
is_alias = expandDatabaseName(org_filename, expanded_name, &config);
if (!is_alias)
{
expanded_name = filename;
if (!options.dpb_utf8_filename)
ISC_systemToUtf8(expanded_name);
ISC_unescape(expanded_name);
ISC_utf8ToSystem(expanded_name);
}
#endif
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
trace_failed_attach(NULL, filename, options, false, user_status);
throw;
}
// Check database against conf file.
const VdnResult vdn = verifyDatabaseName(expanded_name, tdbb->tdbb_status_vector, is_alias);
if (!is_alias && vdn == VDN_FAIL)
{
trace_failed_attach(NULL, filename, options, false, tdbb->tdbb_status_vector);
status_exception::raise(tdbb->tdbb_status_vector);
}
Database* dbb = NULL;
Jrd::Attachment* attachment = NULL;
bool attachTraced = false;
// Initialize special error handling
try
{
// Check for ability to access requested DB remotely
if (options.dpb_remote_address.hasData() && !config->getRemoteAccess())
{
ERR_post(Arg::Gds(isc_no_priv) << Arg::Str("remote") <<
Arg::Str("database") <<
Arg::Str(org_filename));
}
#ifndef WIN_NT
guardDbInit.enter();
#endif
// Unless we're already attached, do some initialization
RefMutexUnlock initGuard;
JAttachment* jAtt = initAttachment(tdbb, expanded_name,
is_alias ? org_filename : expanded_name,
config, true, options, initGuard, pluginConfig, this);
dbb = tdbb->getDatabase();
fb_assert(dbb);
attachment = tdbb->getAttachment();
fb_assert(attachment);
if (!(dbb->dbb_flags & DBB_new))
{
// That's already initialized DBB
// No need keeping dbInitMutex any more
guardDbInit.leave();
}
EngineContextHolder tdbb(user_status, jAtt, FB_FUNCTION, AttachmentHolder::ATT_DONT_LOCK);
attachment->att_crypt_callback = getDefCryptCallback(cryptCallback);
attachment->att_client_charset = attachment->att_charset = options.dpb_interp;
if (existingId)
attachment->att_flags |= ATT_overwrite_check;
if (options.dpb_no_garbage)
attachment->att_flags |= ATT_no_cleanup;
if (options.dpb_sec_attach)
attachment->att_flags |= ATT_security_db;
if (options.dpb_map_attach)
attachment->att_flags |= ATT_mapping;
if (options.dpb_gbak_attach)
attachment->att_utility = Attachment::UTIL_GBAK;
else if (options.dpb_gstat_attach)
attachment->att_utility = Attachment::UTIL_GSTAT;
else if (options.dpb_gfix_attach)
attachment->att_utility = Attachment::UTIL_GFIX;
if (options.dpb_working_directory.hasData())
attachment->att_working_directory = options.dpb_working_directory;
TRA_init(attachment);
bool newDb = false;
if (dbb->dbb_flags & DBB_new)
{
// If we're a not a secondary attachment, initialize some stuff
newDb = true;
// NS: Use alias as database ID only if accessing database using file name is not possible.
//
// This way we:
// 1. Ensure uniqueness of ID even in presence of multiple processes
// 2. Make sure that ID value can be used to connect back to database
//
if (is_alias && vdn == VDN_FAIL)
dbb->dbb_database_name = org_filename;
else
dbb->dbb_database_name = expanded_name;
PageSpace* pageSpace = dbb->dbb_page_manager.findPageSpace(DB_PAGE_SPACE);
pageSpace->file = PIO_open(tdbb, expanded_name, org_filename);
// Initialize the global objects
dbb->initGlobalObjects();
// Initialize locks
LCK_init(tdbb, LCK_OWNER_database);
LCK_init(tdbb, LCK_OWNER_attachment);
init_database_lock(tdbb);
jAtt->getStable()->manualAsyncUnlock(attachment->att_flags);
INI_init(tdbb);
SHUT_init(tdbb);
PAG_header_init(tdbb);
INI_init2(tdbb);
PAG_init(tdbb);
if (options.dpb_set_page_buffers)
{
// In a case when we need to preset cache size set it first to minimum value.
// We will check access rights and call CCH_expand() later when database is initialized.
dbb->dbb_page_buffers = MIN_PAGE_BUFFERS;
}
options.setBuffers(dbb->dbb_config);
CCH_init(tdbb, options.dpb_buffers);
// Initialize backup difference subsystem. This must be done before WAL and shadowing
// is enabled because nbackup it is a lower level subsystem
dbb->dbb_backup_manager = FB_NEW_POOL(*dbb->dbb_permanent) BackupManager(tdbb,
dbb, Ods::hdr_nbak_unknown);
dbb->dbb_backup_manager->initializeAlloc(tdbb);
dbb->dbb_crypto_manager = FB_NEW_POOL(*dbb->dbb_permanent) CryptoManager(tdbb);
dbb->dbb_monitoring_data = FB_NEW_POOL(*dbb->dbb_permanent) MonitoringData(dbb);
PAG_init2(tdbb, 0);
PAG_header(tdbb, false);
dbb->dbb_page_manager.initTempPageSpace(tdbb);
dbb->dbb_crypto_manager->attach(tdbb, attachment);
// initialize shadowing as soon as the database is ready for it
// but before any real work is done
SDW_init(tdbb, options.dpb_activate_shadow, options.dpb_delete_shadow);
// Initialize TIP cache. We do this late to give SDW a chance to
// work while we read states for all interesting transactions
dbb->dbb_tip_cache = FB_NEW_POOL(*dbb->dbb_permanent) TipCache(dbb);
dbb->dbb_tip_cache->initializeTpc(tdbb);
// linger
dbb->dbb_linger_seconds = MET_get_linger(tdbb);
// Init complete - we can release dbInitMutex
dbb->dbb_flags &= ~DBB_new;
guardDbInit.leave();
}
else
{
if ((dbb->dbb_flags & DatabaseOptions::DPB_FLAGS_MASK) !=
(options.dpb_flags & DatabaseOptions::DPB_FLAGS_MASK))
{
// looks like someone tries to attach incompatibly
Arg::Gds err(isc_bad_dpb_content);
if ((dbb->dbb_flags & DBB_damaged) != (options.dpb_flags & DBB_damaged))
err << Arg::Gds(isc_baddpb_damaged_mode);
err.raise();
}
LCK_init(tdbb, LCK_OWNER_attachment);
check_single_maintenance(tdbb);
jAtt->getStable()->manualAsyncUnlock(attachment->att_flags);
INI_init(tdbb);
INI_init2(tdbb);
PAG_header(tdbb, true);
dbb->dbb_crypto_manager->attach(tdbb, attachment);
}
// Basic DBB initialization complete
initGuard.leave();
// Attachments to a ReadOnly database need NOT do garbage collection
if (dbb->readOnly())
attachment->att_flags |= ATT_no_cleanup;
if (options.dpb_nolinger)
dbb->dbb_linger_seconds = 0;
if (options.dpb_disable_wal)
{
ERR_post(Arg::Gds(isc_lock_timeout) <<
Arg::Gds(isc_obj_in_use) << Arg::Str(org_filename));
}
if (options.dpb_buffers && !dbb->dbb_page_buffers)
{
if (CCH_expand(tdbb, options.dpb_buffers))
dbb->dbb_linger_seconds = 0;
}
PAG_attachment_id(tdbb);
bool cleanupTransactions = false;
if (!options.dpb_verify && CCH_exclusive(tdbb, LCK_PW, LCK_NO_WAIT, NULL))
cleanupTransactions = TRA_cleanup(tdbb);
if (invalid_client_SQL_dialect)
{
ERR_post(Arg::Gds(isc_inv_client_dialect_specified) << Arg::Num(options.dpb_sql_dialect) <<
Arg::Gds(isc_valid_client_dialects) << Arg::Str("1, 2 or 3"));
}
switch (options.dpb_sql_dialect)
{
case 0:
// V6 Client --> V6 Server, dummy client SQL dialect 0 was passed
// It means that client SQL dialect was not set by user
// and takes DB SQL dialect as client SQL dialect
if (dbb->dbb_flags & DBB_DB_SQL_dialect_3)
{
// DB created in IB V6.0 by client SQL dialect 3
options.dpb_sql_dialect = SQL_DIALECT_V6;
}
else
{
// old DB was gbaked in IB V6.0
options.dpb_sql_dialect = SQL_DIALECT_V5;
}
break;
case 99:
// V5 Client --> V6 Server, old client has no concept of dialect
options.dpb_sql_dialect = SQL_DIALECT_V5;
break;
default:
// V6 Client --> V6 Server, but client SQL dialect was set
// by user and was passed.
break;
}
// Clear old mapping cache data on request.
// Unfortunately have to do it w/o access rights check - to check access rights engine
// needs correct mapping which sometimes can't be guaranteed before cleaning cache.
if (options.dpb_clear_map)
Mapping::clearCache(dbb->dbb_filename.c_str(), Mapping::ALL_CACHE);
// Check for correct credentials supplied
UserId userId;
if (existingId)
userId = *existingId;
else
{
jAtt->getStable()->manualUnlock(attachment->att_flags);
try
{
mapping.setDb(filename, expanded_name.c_str(), jAtt);
getUserInfo(userId, options, filename, &config, false, mapping, options.dpb_reset_icu);
}
catch(const Exception&)
{
jAtt->getStable()->manualLock(attachment->att_flags, ATT_manual_lock);
throw;
}
jAtt->getStable()->manualLock(attachment->att_flags, ATT_manual_lock);
}
userId.makeRoleName(options.dpb_sql_dialect);
userId.sclInit(tdbb, false);
Monitoring::publishAttachment(tdbb);
// This pair (SHUT_database/SHUT_online) checks itself for valid user name
if (options.dpb_shutdown)
SHUT_database(tdbb, options.dpb_shutdown, options.dpb_shutdown_delay, NULL);
if (options.dpb_online)
SHUT_online(tdbb, options.dpb_online, NULL);
// Check if another attachment has or is requesting exclusive database access.
// If this is an implicit attachment for the security (password) database, don't
// try to get exclusive attachment to avoid a deadlock condition which happens
// when a client tries to connect to the security database itself.
if (!options.dpb_sec_attach)
{
bool attachment_succeeded = true;
if (dbb->dbb_ast_flags & DBB_shutdown_single)
attachment_succeeded = CCH_exclusive_attachment(tdbb, LCK_none, -1, NULL);
else
CCH_exclusive_attachment(tdbb, LCK_none, LCK_WAIT, NULL);
if (attachment->att_flags & ATT_shutdown)
{
const ISC_STATUS err = jAtt->getStable()->getShutError();
if (dbb->dbb_ast_flags & DBB_shutdown)
ERR_post(Arg::Gds(isc_shutdown) << Arg::Str(org_filename));
if (err)
ERR_post(Arg::Gds(isc_att_shutdown) << Arg::Gds(err));
ERR_post(Arg::Gds(isc_att_shutdown));
}
if (!attachment_succeeded)
ERR_post(Arg::Gds(isc_shutdown) << Arg::Str(org_filename));
}
// If database is shutdown then kick 'em out.
if (dbb->dbb_ast_flags & (DBB_shut_attach | DBB_shut_tran))
ERR_post(Arg::Gds(isc_shutinprog) << Arg::Str(org_filename));
if (dbb->dbb_ast_flags & DBB_shutdown)
{
// Allow only SYSDBA/owner to access database that is shut down
bool allow_access = attachment->locksmith(tdbb, ACCESS_SHUTDOWN_DATABASE);
// Handle special shutdown modes
if (allow_access)
{
if (dbb->dbb_ast_flags & DBB_shutdown_full)
{
// Full shutdown. Deny access always
allow_access = false;
}
else if (dbb->dbb_ast_flags & DBB_shutdown_single)
{
// Single user maintenance. Allow access only if we were able to take exclusive lock
// Note that logic below this exclusive lock differs for SS and CS builds:
// - CS keeps PW database lock from releasing in AST in single-user maintenance mode
// - for SS this code effectively checks that no other attachments are present
// at call point, ATT_exclusive bit is released just before this procedure exits
// Things are done this way to handle return to online mode nicely.
allow_access = CCH_exclusive(tdbb, LCK_PW, WAIT_PERIOD, NULL);
}
}
if (!allow_access)
{
// Note we throw exception here when entering full-shutdown mode
ERR_post(Arg::Gds(isc_shutdown) << org_filename);
}
}
// Figure out what character set & collation this attachment prefers
find_intl_charset(tdbb, attachment, &options);
if (!options.dpb_session_tz.isEmpty())
{
attachment->att_timestamp.time_zone = attachment->att_current_timezone =
attachment->att_original_timezone = TimeZoneUtil::parse(
options.dpb_session_tz.c_str(), options.dpb_session_tz.length());
}
// if the attachment is through gbak and this attachment is not by owner
// or sysdba then return error. This has been added here to allow for the
// GBAK security feature of only allowing the owner or sysdba to backup a
// database. smistry 10/5/98
if (attachment->isUtility())
{
validateAccess(tdbb, attachment,
attachment->att_utility == Attachment::UTIL_GBAK ? USE_GBAK_UTILITY :
attachment->att_utility == Attachment::UTIL_GFIX ? USE_GFIX_UTILITY :
USE_GSTAT_UTILITY);
}
if (options.dpb_verify)
{
validateAccess(tdbb, attachment, USE_GFIX_UTILITY);
if (!CCH_exclusive(tdbb, LCK_PW, WAIT_PERIOD, NULL))
ERR_post(Arg::Gds(isc_bad_dpb_content) << Arg::Gds(isc_cant_validate));
// Can't allow garbage collection during database validation.
AutoSetRestoreFlag<ULONG> noCleanup(&attachment->att_flags, ATT_no_cleanup, true);
VIO_fini(tdbb);
if (!VAL_validate(tdbb, options.dpb_verify))
ERR_punt();
}
if (options.dpb_reset_icu)
{
validateAccess(tdbb, attachment, USE_GFIX_UTILITY);
DFW_reset_icu(tdbb);
// force system privileges recheck for sysdba
fb_assert(attachment->att_user); // set by UserId::sclInit()
attachment->att_user->setFlag(USR_newrole);
}
if (options.dpb_journal.hasData())
ERR_post(Arg::Gds(isc_bad_dpb_content) << Arg::Gds(isc_cant_start_journal));
if (options.dpb_wal_action)
{
// No WAL anymore. We deleted it.
ERR_post(Arg::Gds(isc_no_wal));
}
if (attachment->att_utility == Attachment::UTIL_GFIX ||
attachment->att_utility == Attachment::UTIL_GSTAT)
{
options.dpb_no_db_triggers = true;
}
if (options.dpb_no_db_triggers)
{
validateAccess(tdbb, attachment, IGNORE_DB_TRIGGERS);
attachment->att_flags |= ATT_no_db_triggers;
}
if (options.dpb_set_db_sql_dialect)
{
validateAccess(tdbb, attachment, CHANGE_HEADER_SETTINGS);
PAG_set_db_SQL_dialect(tdbb, options.dpb_set_db_sql_dialect);
dbb->dbb_linger_seconds = 0;
}
if (options.dpb_sweep_interval > -1)
{
validateAccess(tdbb, attachment, CHANGE_HEADER_SETTINGS);
PAG_set_sweep_interval(tdbb, options.dpb_sweep_interval);
dbb->dbb_sweep_interval = options.dpb_sweep_interval;
}
if (options.dpb_set_force_write)
{
validateAccess(tdbb, attachment, CHANGE_HEADER_SETTINGS);
PAG_set_force_write(tdbb, options.dpb_force_write);
}
if (options.dpb_set_no_reserve)
{
validateAccess(tdbb, attachment, CHANGE_HEADER_SETTINGS);
PAG_set_no_reserve(tdbb, options.dpb_no_reserve);
}
if (options.dpb_set_page_buffers)
{
if (dbb->dbb_flags & DBB_shared)
validateAccess(tdbb, attachment, CHANGE_HEADER_SETTINGS);
CCH_expand(tdbb, options.dpb_page_buffers);
if (attachment->locksmith(tdbb, CHANGE_HEADER_SETTINGS))
{
PAG_set_page_buffers(tdbb, options.dpb_page_buffers);
dbb->dbb_linger_seconds = 0;
}
}
if (options.dpb_set_db_readonly)
{
validateAccess(tdbb, attachment, CHANGE_HEADER_SETTINGS);
if (!CCH_exclusive(tdbb, LCK_EX, WAIT_PERIOD, NULL))
{
ERR_post(Arg::Gds(isc_lock_timeout) <<
Arg::Gds(isc_obj_in_use) << Arg::Str(org_filename));
}
PAG_set_db_readonly(tdbb, options.dpb_db_readonly);
dbb->dbb_linger_seconds = 0;
}
if (options.dpb_set_db_replica)
{
validateAccess(tdbb, attachment, CHANGE_HEADER_SETTINGS);
if (!CCH_exclusive(tdbb, LCK_EX, WAIT_PERIOD, NULL))
{
ERR_post(Arg::Gds(isc_lock_timeout) <<
Arg::Gds(isc_obj_in_use) << Arg::Str(org_filename));
}
PAG_set_db_replica(tdbb, options.dpb_replica_mode);
dbb->dbb_linger_seconds = 0;
}
CCH_init2(tdbb);
VIO_init(tdbb);
attachment->setInitialOptions(tdbb, options, newDb);
CCH_release_exclusive(tdbb);
REPL_attach(tdbb, cleanupTransactions);
attachment->att_trace_manager->activate();
if (attachment->att_trace_manager->needs(ITraceFactory::TRACE_EVENT_ATTACH))
{
TraceConnectionImpl conn(attachment);
attachment->att_trace_manager->event_attach(&conn, false, ITracePlugin::RESULT_SUCCESS);
}
attachTraced = true;
// Recover database after crash during backup difference file merge
dbb->dbb_backup_manager->endBackup(tdbb, true); // true = do recovery
if (options.dpb_sweep & isc_dpb_records)
TRA_sweep(tdbb);
dbb->dbb_crypto_manager->startCryptThread(tdbb);
if (options.dpb_dbkey_scope)
attachment->att_dbkey_trans = TRA_start(tdbb, 0, 0);
if (!(attachment->att_flags & ATT_no_db_triggers))
{
jrd_tra* transaction = NULL;
const ULONG save_flags = attachment->att_flags;
try
{
// load all database triggers
MET_load_db_triggers(tdbb, DB_TRIGGER_CONNECT);
MET_load_db_triggers(tdbb, DB_TRIGGER_DISCONNECT);
MET_load_db_triggers(tdbb, DB_TRIGGER_TRANS_START);
MET_load_db_triggers(tdbb, DB_TRIGGER_TRANS_COMMIT);
MET_load_db_triggers(tdbb, DB_TRIGGER_TRANS_ROLLBACK);
// load DDL triggers
MET_load_ddl_triggers(tdbb);
const TrigVector* trig_connect = attachment->att_triggers[DB_TRIGGER_CONNECT];
if (trig_connect && !trig_connect->isEmpty())
{
// Start a transaction to execute ON CONNECT triggers.
// Ensure this transaction can't trigger auto-sweep.
//// TODO: register the transaction in y-valve - for external engines
attachment->att_flags |= ATT_no_cleanup;
transaction = TRA_start(tdbb, 0, NULL);
attachment->att_flags = save_flags;
// run ON CONNECT triggers
EXE_execute_db_triggers(tdbb, transaction, TRIGGER_CONNECT);
// and commit the transaction
TRA_commit(tdbb, transaction, false);
}
}
catch (const Exception&)
{
attachment->att_flags = save_flags;
if (!(dbb->dbb_flags & DBB_bugcheck) && transaction)
TRA_rollback(tdbb, transaction, false, false);
throw;
}
}
jAtt->getStable()->manualUnlock(attachment->att_flags);
return jAtt;
} // try
catch (const Exception& ex)
{
ex.stuffException(user_status);
if (attachTraced)
{
TraceManager* traceManager = attachment->att_trace_manager;
TraceConnectionImpl conn(attachment);
TraceStatusVectorImpl traceStatus(user_status, TraceStatusVectorImpl::TS_ERRORS);
if (traceManager->needs(ITraceFactory::TRACE_EVENT_ERROR))
traceManager->event_error(&conn, &traceStatus, "JProvider::attachDatabase");
if (traceManager->needs(ITraceFactory::TRACE_EVENT_DETACH))
traceManager->event_detach(&conn, false);
}
else
{
trace_failed_attach(attachment && attachment->att_trace_manager &&
attachment->att_trace_manager->isActive() ? attachment->att_trace_manager : NULL,
filename, options, false, user_status);
}
mapping.clearMainHandle();
unwindAttach(tdbb, ex, user_status, existingId);
}
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
}
return NULL;
}
void JBlob::getInfo(CheckStatusWrapper* user_status,
unsigned int itemsLength, const unsigned char* items,
unsigned int bufferLength, unsigned char* buffer)
{
/**************************************
*
* g d s _ $ b l o b _ i n f o
*
**************************************
*
* Functional description
* Provide information on blob object.
*
**************************************/
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
try
{
INF_blob_info(getHandle(), itemsLength, items, bufferLength, buffer);
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JBlob::getInfo");
return;
}
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return;
}
successful_completion(user_status);
}
void JBlob::deprecatedCancel(CheckStatusWrapper* user_status)
{
/**************************************
*
* g d s _ $ c a n c e l _ b l o b
*
**************************************
*
* Functional description
* Abort a partially completed blob.
*
**************************************/
freeEngineData(user_status);
}
void JBlob::cancel(CheckStatusWrapper* user_status)
{
freeEngineData(user_status);
if (user_status->isEmpty())
release();
}
void JBlob::freeEngineData(CheckStatusWrapper* user_status)
{
/**************************************
*
* g d s _ $ c a n c e l _ b l o b
*
**************************************
*
* Functional description
* Abort a partially completed blob.
*
**************************************/
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
try
{
getHandle()->BLB_cancel(tdbb);
blob = NULL;
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JBlob::freeEngineData");
return;
}
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return;
}
successful_completion(user_status);
}
void JEvents::deprecatedCancel(CheckStatusWrapper* user_status)
{
/**************************************
*
* g d s _ $ c a n c e l _ e v e n t s
*
**************************************
*
* Functional description
* Cancel an outstanding event.
*
**************************************/
freeEngineData(user_status);
}
void JEvents::cancel(CheckStatusWrapper* user_status)
{
freeEngineData(user_status);
if (user_status->isEmpty())
release();
}
void JEvents::freeEngineData(CheckStatusWrapper* user_status)
{
/**************************************
*
* g d s _ $ c a n c e l _ e v e n t s
*
**************************************
*
* Functional description
* Cancel an outstanding event.
*
**************************************/
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
try
{
Database* const dbb = tdbb->getDatabase();
Attachment* const attachment = tdbb->getAttachment();
if (attachment->att_event_session)
dbb->eventManager()->cancelEvents(id);
id = -1;
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JEvents::freeEngineData");
return;
}
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return;
}
successful_completion(user_status);
}
void JAttachment::cancelOperation(CheckStatusWrapper* user_status, int option)
{
/**************************************
*
* g d s _ $ c a n c e l _ o p e r a t i o n
*
**************************************
*
* Functional description
* Try to cancel an operation.
*
**************************************/
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION,
AttachmentHolder::ATT_LOCK_ASYNC | AttachmentHolder::ATT_NON_BLOCKING);
try
{
JRD_cancel_operation(tdbb, getHandle(), option);
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JAttachment::cancelOperation");
return;
}
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return;
}
successful_completion(user_status);
}
void JBlob::close(CheckStatusWrapper* user_status)
{
internalClose(user_status);
if (user_status->isEmpty())
release();
}
void JBlob::deprecatedClose(CheckStatusWrapper* user_status)
{
internalClose(user_status);
}
void JBlob::internalClose(CheckStatusWrapper* user_status)
{
/**************************************
*
* g d s _ $ c l o s e _ b l o b
*
**************************************
*
* Functional description
* Abort a partially completed blob.
*
**************************************/
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
try
{
if (!getHandle()->BLB_close(tdbb))
getHandle()->blb_interface = NULL;
blob = NULL;
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JBlob::close");
return;
}
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return;
}
successful_completion(user_status);
}
void JTransaction::commit(CheckStatusWrapper* user_status)
{
internalCommit(user_status);
if (user_status->isEmpty())
release();
}
void JTransaction::deprecatedCommit(CheckStatusWrapper* user_status)
{
internalCommit(user_status);
}
void JTransaction::internalCommit(CheckStatusWrapper* user_status)
{
/**************************************
*
* g d s _ $ c o m m i t
*
**************************************
*
* Functional description
* Commit a transaction.
*
**************************************/
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
try
{
JRD_commit_transaction(tdbb, getHandle());
transaction = NULL;
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JTransaction::commit");
return;
}
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return;
}
successful_completion(user_status);
}
void JTransaction::commitRetaining(CheckStatusWrapper* user_status)
{
/**************************************
*
* g d s _ $ c o m m i t _ r e t a i n i n g
*
**************************************
*
* Functional description
* Commit a transaction.
*
**************************************/
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
try
{
JRD_commit_retaining(tdbb, getHandle());
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JTransaction::commitRetaining");
return;
}
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return;
}
successful_completion(user_status);
}
ITransaction* JTransaction::join(CheckStatusWrapper* user_status, ITransaction* transaction)
{
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
return DtcInterfacePtr()->join(user_status, this, transaction);
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
}
return NULL;
}
JTransaction* JTransaction::validate(CheckStatusWrapper* user_status, IAttachment* testAtt)
{
// Do not raise error in status - just return NULL if attachment does not match
return (sAtt && sAtt->getInterface() == testAtt) ? this : NULL;
}
JTransaction* JTransaction::enterDtc(CheckStatusWrapper* user_status)
{
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
JTransaction* copy = FB_NEW JTransaction(this);
copy->addRef();
transaction = NULL;
release();
return copy;
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
}
return NULL;
}
JRequest* JAttachment::compileRequest(CheckStatusWrapper* user_status,
unsigned int blr_length, const unsigned char* blr)
{
/**************************************
*
* g d s _ $ c o m p i l e
*
**************************************
*
* Functional description
*
**************************************/
Statement* stmt = NULL;
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
TraceBlrCompile trace(tdbb, blr_length, blr);
try
{
stmt = CMP_compile(tdbb, blr, blr_length, false, 0, nullptr);
const auto attachment = tdbb->getAttachment();
const auto rootRequest = stmt->getRequest(tdbb, 0);
rootRequest->setAttachment(attachment);
attachment->att_requests.add(rootRequest);
trace.finish(stmt, ITracePlugin::RESULT_SUCCESS);
}
catch (const Exception& ex)
{
const ISC_STATUS exc = transliterateException(tdbb, ex, user_status, "JAttachment::compileRequest");
const bool no_priv = (exc == isc_no_priv);
trace.finish(NULL, no_priv ? ITracePlugin::RESULT_UNAUTHORIZED : ITracePlugin::RESULT_FAILED);
return NULL;
}
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return NULL;
}
successful_completion(user_status);
JRequest* jr = FB_NEW JRequest(stmt, getStable());
jr->addRef();
return jr;
}
JBlob* JAttachment::createBlob(CheckStatusWrapper* user_status, ITransaction* tra, ISC_QUAD* blob_id,
unsigned int bpb_length, const unsigned char* bpb)
{
/**************************************
*
* g d s _ $ c r e a t e _ b l o b
*
**************************************
*
* Functional description
* Create a new blob.
*
**************************************/
blb* blob = NULL;
try
{
JTransaction* const jt = getTransactionInterface(user_status, tra);
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
jrd_tra* transaction = jt->getHandle();
validateHandle(tdbb, transaction);
check_database(tdbb);
try
{
blob = blb::create2(tdbb, transaction, reinterpret_cast<bid*>(blob_id), bpb_length, bpb, true);
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JAttachment::createBlob");
return NULL;
}
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return NULL;
}
successful_completion(user_status);
JBlob* jb = FB_NEW JBlob(blob, getStable());
jb->addRef();
blob->blb_interface = jb;
return jb;
}
JAttachment* JProvider::createDatabase(CheckStatusWrapper* user_status, const char* filename,
unsigned int dpb_length, const unsigned char* dpb)
{
/**************************************
*
* g d s _ $ c r e a t e _ d a t a b a s e
*
**************************************
*
* Functional description
* Create a nice, squeeky clean database, uncorrupted by user data.
*
**************************************/
try
{
ThreadContextHolder tdbb(user_status);
MutexEnsureUnlock guardDbInit(dbInitMutex, FB_FUNCTION);
UserId userId;
DatabaseOptions options;
PathName org_filename, expanded_name;
bool is_alias = false;
Firebird::RefPtr<const Config> config;
Mapping mapping(Mapping::MAP_THROW_NOT_FOUND, cryptCallback);
try
{
// Process database parameter block
bool invalid_client_SQL_dialect = false;
options.get(dpb, dpb_length, invalid_client_SQL_dialect);
mapping.setAuthBlock(options.dpb_auth_block);
if (!invalid_client_SQL_dialect && options.dpb_sql_dialect == 99) {
options.dpb_sql_dialect = 0;
}
if (options.dpb_org_filename.hasData())
org_filename = options.dpb_org_filename;
else
{
org_filename = filename;
if (!options.dpb_utf8_filename)
ISC_systemToUtf8(org_filename);
ISC_unescape(org_filename);
}
ISC_utf8ToSystem(org_filename);
// Resolve given alias name
is_alias = expandDatabaseName(org_filename, expanded_name, &config);
if (!is_alias)
{
expanded_name = filename;
if (!options.dpb_utf8_filename)
ISC_systemToUtf8(expanded_name);
ISC_unescape(expanded_name);
ISC_utf8ToSystem(expanded_name);
}
// Check to see if the database is truly local or if it just looks
// that way
if (ISC_check_if_remote(expanded_name, true))
ERR_post(Arg::Gds(isc_unavailable));
// Check for correct credentials supplied
mapping.setSecurityDbAlias(config->getSecurityDatabase(), nullptr);
getUserInfo(userId, options, filename, &config, true, mapping, false);
#ifdef WIN_NT
guardDbInit.enter(); // Required to correctly expand name of just created database
// Need to re-expand under lock to take into an account file existance (or not)
is_alias = expandDatabaseName(org_filename, expanded_name, &config);
if (!is_alias)
{
expanded_name = filename;
if (!options.dpb_utf8_filename)
ISC_systemToUtf8(expanded_name);
ISC_unescape(expanded_name);
ISC_utf8ToSystem(expanded_name);
}
#endif
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
trace_failed_attach(NULL, filename, options, true, user_status);
throw;
}
// Check database against conf file.
const VdnResult vdn = verifyDatabaseName(expanded_name, tdbb->tdbb_status_vector, is_alias);
if (!is_alias && vdn == VDN_FAIL)
{
trace_failed_attach(NULL, filename, options, true, tdbb->tdbb_status_vector);
status_exception::raise(tdbb->tdbb_status_vector);
}
Database* dbb = NULL;
Jrd::Attachment* attachment = NULL;
// Initialize special error handling
try
{
// Check for ability to access requested DB remotely
if (options.dpb_remote_address.hasData() && !config->getRemoteAccess())
{
ERR_post(Arg::Gds(isc_no_priv) << Arg::Str("remote") <<
Arg::Str("database") <<
Arg::Str(org_filename));
}
#ifndef WIN_NT
guardDbInit.enter();
#endif
// Unless we're already attached, do some initialization
RefMutexUnlock initGuard;
JAttachment* jAtt = initAttachment(tdbb, expanded_name,
is_alias ? org_filename : expanded_name,
config, false, options, initGuard, pluginConfig, this);
dbb = tdbb->getDatabase();
fb_assert(dbb);
fb_assert(dbb->dbb_flags & DBB_new);
fb_assert(dbb->dbb_flags & DBB_creating);
attachment = tdbb->getAttachment();
fb_assert(attachment);
Sync dbbGuard(&dbb->dbb_sync, "createDatabase");
dbbGuard.lock(SYNC_EXCLUSIVE);
EngineContextHolder tdbb(user_status, jAtt, FB_FUNCTION, AttachmentHolder::ATT_DONT_LOCK);
attachment->att_crypt_callback = getDefCryptCallback(cryptCallback);
if (options.dpb_working_directory.hasData())
attachment->att_working_directory = options.dpb_working_directory;
if (options.dpb_sec_attach)
attachment->att_flags |= ATT_security_db;
if (options.dpb_map_attach)
attachment->att_flags |= ATT_mapping;
if (options.dpb_gbak_attach)
attachment->att_utility = Attachment::UTIL_GBAK;
if (options.dpb_no_db_triggers)
attachment->att_flags |= ATT_no_db_triggers;
switch (options.dpb_sql_dialect)
{
case SQL_DIALECT_V5:
break;
case 0:
case SQL_DIALECT_V6:
dbb->dbb_flags |= DBB_DB_SQL_dialect_3;
break;
default:
ERR_post(Arg::Gds(isc_database_create_failed) << Arg::Str(expanded_name) <<
Arg::Gds(isc_inv_dialect_specified) << Arg::Num(options.dpb_sql_dialect) <<
Arg::Gds(isc_valid_db_dialects) << Arg::Str("1 and 3"));
break;
}
attachment->att_client_charset = attachment->att_charset = options.dpb_interp;
if (options.dpb_page_size <= 0) {
options.dpb_page_size = DEFAULT_PAGE_SIZE;
}
SLONG page_size = MIN_PAGE_SIZE;
for (; page_size < MAX_PAGE_SIZE; page_size <<= 1)
{
if (options.dpb_page_size < page_size << 1)
break;
}
dbb->dbb_page_size = (page_size > MAX_PAGE_SIZE) ? MAX_PAGE_SIZE : page_size;
TRA_init(attachment);
PageSpace* pageSpace = dbb->dbb_page_manager.findPageSpace(DB_PAGE_SPACE);
try
{
// try to create with overwrite = false
pageSpace->file = PIO_create(tdbb, expanded_name, false, false);
}
catch (const status_exception&)
{
if (!options.dpb_overwrite)
throw;
// isc_dpb_no_db_triggers is required for 2 reasons
// - it disables non-DBA attaches with isc_adm_task_denied or isc_miss_prvlg error
// - it disables any user code to be executed when we later lock
// databases_mutex with OverwriteHolder
ClumpletWriter dpbWriter(ClumpletReader::dpbList, MAX_DPB_SIZE, dpb, dpb_length);
dpbWriter.insertByte(isc_dpb_no_db_triggers, 1);
dpb = dpbWriter.getBuffer();
dpb_length = dpbWriter.getBufferLength();
OverwriteHolder overwriteCheckHolder(dbb);
JAttachment* attachment2 = internalAttach(user_status, filename, dpb_length,
dpb, &userId);
switch (user_status->getErrors()[1])
{
case isc_adm_task_denied:
case isc_miss_prvlg:
throw;
default:
break;
}
bool allow_overwrite = false;
if (attachment2)
{
allow_overwrite = attachment2->getHandle()->locksmith(tdbb, DROP_DATABASE);
attachment2->detach(user_status);
}
else
{
// clear status after failed attach
user_status->init();
allow_overwrite = true;
}
if (!allow_overwrite)
{
ERR_post(Arg::Gds(isc_no_priv) << Arg::Str("overwrite") <<
Arg::Str("database") <<
Arg::Str(expanded_name));
}
// file is a database and the user (SYSDBA or owner) has right to overwrite
pageSpace->file = PIO_create(tdbb, expanded_name, options.dpb_overwrite, false);
}
#ifdef WIN_NT
dbb->dbb_filename.assign(pageSpace->file->fil_string); // first dbb file
#endif
#ifdef HAVE_ID_BY_NAME
os_utils::getUniqueFileId(dbb->dbb_filename.c_str(), dbb->dbb_id);
#endif
// Initialize the global objects
dbb->initGlobalObjects();
// Initialize locks
LCK_init(tdbb, LCK_OWNER_database);
LCK_init(tdbb, LCK_OWNER_attachment);
init_database_lock(tdbb);
jAtt->getStable()->manualAsyncUnlock(attachment->att_flags);
INI_init(tdbb);
PAG_init(tdbb);
userId.sclInit(tdbb, true);
if (options.dpb_set_page_buffers)
dbb->dbb_page_buffers = options.dpb_page_buffers;
options.setBuffers(dbb->dbb_config);
CCH_init(tdbb, options.dpb_buffers);
// NS: Use alias as database ID only if accessing database using file name is not possible.
//
// This way we:
// 1. Ensure uniqueness of ID even in presence of multiple processes
// 2. Make sure that ID value can be used to connect back to database
//
if (is_alias && vdn == VDN_FAIL)
dbb->dbb_database_name = org_filename;
else
dbb->dbb_database_name = dbb->dbb_filename;
// Clear old mapping cache data (if present)
Mapping::clearCache(dbb->dbb_filename.c_str(), Mapping::ALL_CACHE);
// Initialize backup difference subsystem. This must be done before WAL and shadowing
// is enabled because nbackup it is a lower level subsystem
dbb->dbb_backup_manager = FB_NEW_POOL(*dbb->dbb_permanent) BackupManager(tdbb,
dbb, Ods::hdr_nbak_normal);
dbb->dbb_backup_manager->dbCreating = true;
dbb->dbb_crypto_manager = FB_NEW_POOL(*dbb->dbb_permanent) CryptoManager(tdbb);
dbb->dbb_monitoring_data = FB_NEW_POOL(*dbb->dbb_permanent) MonitoringData(dbb);
PAG_format_header(tdbb);
INI_init2(tdbb);
PAG_format_pip(tdbb, *pageSpace);
dbb->dbb_page_manager.initTempPageSpace(tdbb);
GenerateGuid(&dbb->dbb_guid);
PAG_set_db_guid(tdbb, dbb->dbb_guid);
if (options.dpb_set_page_buffers)
PAG_set_page_buffers(tdbb, options.dpb_page_buffers);
if (options.dpb_set_no_reserve)
PAG_set_no_reserve(tdbb, options.dpb_no_reserve);
fb_assert(attachment->att_user); // set by UserId::sclInit()
INI_format(attachment->getUserName().c_str(), options.dpb_set_db_charset.c_str());
// If we have not allocated first TIP page, do it now.
if (!dbb->dbb_t_pages || !dbb->dbb_t_pages->count())
TRA_extend_tip(tdbb, 0);
// There is no point to move database online at database creation since it is online by default.
// We do not allow to create database that is fully shut down.
if (options.dpb_online || (options.dpb_shutdown & isc_dpb_shut_mode_mask) == isc_dpb_shut_full)
ERR_post(Arg::Gds(isc_bad_shutdown_mode) << Arg::Str(org_filename));
if (options.dpb_shutdown) {
SHUT_database(tdbb, options.dpb_shutdown, options.dpb_shutdown_delay, &dbbGuard);
}
if (options.dpb_sweep_interval > -1)
{
PAG_set_sweep_interval(tdbb, options.dpb_sweep_interval);
dbb->dbb_sweep_interval = options.dpb_sweep_interval;
}
if (options.dpb_set_force_write)
PAG_set_force_write(tdbb, options.dpb_force_write);
// initialize shadowing semaphore as soon as the database is ready for it
// but before any real work is done
SDW_init(tdbb, options.dpb_activate_shadow, options.dpb_delete_shadow);
CCH_init2(tdbb);
VIO_init(tdbb);
if (options.dpb_set_db_readonly)
{
if (!CCH_exclusive(tdbb, LCK_EX, WAIT_PERIOD, &dbbGuard))
{
ERR_post(Arg::Gds(isc_lock_timeout) <<
Arg::Gds(isc_obj_in_use) << Arg::Str(org_filename));
}
PAG_set_db_readonly(tdbb, options.dpb_db_readonly);
}
if (options.dpb_set_db_replica)
{
if (!CCH_exclusive(tdbb, LCK_EX, WAIT_PERIOD, &dbbGuard))
{
ERR_post(Arg::Gds(isc_lock_timeout) <<
Arg::Gds(isc_obj_in_use) << Arg::Str(org_filename));
}
PAG_set_db_replica(tdbb, options.dpb_replica_mode);
}
PAG_attachment_id(tdbb);
Monitoring::publishAttachment(tdbb);
attachment->setInitialOptions(tdbb, options, true);
CCH_release_exclusive(tdbb);
// Figure out what character set & collation this attachment prefers
find_intl_charset(tdbb, attachment, &options);
if (!options.dpb_session_tz.isEmpty())
{
attachment->att_timestamp.time_zone = attachment->att_current_timezone =
attachment->att_original_timezone = TimeZoneUtil::parse(
options.dpb_session_tz.c_str(), options.dpb_session_tz.length());
}
CCH_flush(tdbb, FLUSH_FINI, 0);
if (!options.dpb_set_force_write)
PAG_set_force_write(tdbb, true);
dbb->dbb_crypto_manager->attach(tdbb, attachment);
dbb->dbb_backup_manager->dbCreating = false;
config->notify();
// Initialize TIP cache
dbb->dbb_tip_cache = FB_NEW_POOL(*dbb->dbb_permanent) TipCache(dbb);
dbb->dbb_tip_cache->initializeTpc(tdbb);
// Init complete - we can release dbInitMutex
dbb->dbb_flags &= ~(DBB_new | DBB_creating);
guardDbInit.leave();
REPL_attach(tdbb, false);
// Report that we created attachment to Trace API
attachment->att_trace_manager->activate();
if (attachment->att_trace_manager->needs(ITraceFactory::TRACE_EVENT_ATTACH))
{
TraceConnectionImpl conn(attachment);
attachment->att_trace_manager->event_attach(&conn, true, ITracePlugin::RESULT_SUCCESS);
}
jAtt->getStable()->manualUnlock(attachment->att_flags);
return jAtt;
} // try
catch (const Exception& ex)
{
ex.stuffException(user_status);
trace_failed_attach(attachment && attachment->att_trace_manager &&
attachment->att_trace_manager->isActive() ? attachment->att_trace_manager : NULL,
filename, options, true, user_status);
mapping.clearMainHandle();
unwindAttach(tdbb, ex, user_status, false);
}
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
}
return NULL;
}
void JAttachment::getInfo(CheckStatusWrapper* user_status, unsigned int item_length, const unsigned char* items,
unsigned int buffer_length, unsigned char* buffer)
{
/**************************************
*
* g d s _ $ d a t a b a s e _ i n f o
*
**************************************
*
* Functional description
* Provide information on database object.
*
**************************************/
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
try
{
INF_database_info(tdbb, item_length, items, buffer_length, buffer);
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JAttachment::getInfo");
return;
}
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return;
}
successful_completion(user_status);
}
void JAttachment::executeDyn(CheckStatusWrapper* status, ITransaction* /*tra*/, unsigned int /*length*/,
const unsigned char* /*dyn*/)
{
/**************************************
*
* g d s _ $ d d l
*
**************************************
*
* This function is deprecated and "removed".
*
**************************************/
(Arg::Gds(isc_feature_removed) << Arg::Str("isc_ddl")).copyTo(status);
}
void JAttachment::internalDetach(CheckStatusWrapper* user_status)
{
if (!att->getHandle())
return; // already detached
freeEngineData(user_status, false);
}
void JAttachment::deprecatedDetach(CheckStatusWrapper* user_status)
{
internalDetach(user_status);
}
void JAttachment::detach(CheckStatusWrapper* user_status)
{
internalDetach(user_status);
if (user_status->isEmpty())
release();
}
void JAttachment::freeEngineData(CheckStatusWrapper* user_status, bool forceFree)
{
/**************************************
*
* f r e e E n g i n e D a t a
* former g d s _ $ d e t a c h
*
**************************************
*
* Functional description
* Close down a database.
*
**************************************/
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION, AttachmentHolder::ATT_NO_SHUTDOWN_CHECK);
Jrd::Attachment* const attachment = getHandle();
Database* const dbb = tdbb->getDatabase();
try
{
if (attachment->att_in_use)
status_exception::raise(Arg::Gds(isc_attachment_in_use));
unsigned flags = PURGE_LINGER;
if (engineShutdown ||
(dbb->dbb_ast_flags & DBB_shutdown) ||
(attachment->att_flags & ATT_shutdown))
{
flags |= PURGE_FORCE;
}
if (forceFree)
flags |= PURGE_NOCHECK;
ISC_STATUS reason = 0;
if (!forceFree)
reason = 0;
else if (engineShutdown)
reason = isc_att_shut_engine;
else if (dbb->dbb_ast_flags & DBB_shutdown)
reason = isc_att_shut_db_down;
attachment->signalShutdown(reason);
purge_attachment(tdbb, getStable(), flags);
att->release();
att = NULL;
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JAttachment::freeEngineData");
return;
}
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
if (user_status->getErrors()[1] != isc_att_shutdown)
return;
user_status->init();
if (att)
{
att->release();
att = NULL;
}
}
successful_completion(user_status);
}
void JAttachment::dropDatabase(CheckStatusWrapper* user_status)
{
internalDropDatabase(user_status);
if (user_status->isEmpty())
release();
}
void JAttachment::deprecatedDropDatabase(CheckStatusWrapper* user_status)
{
internalDropDatabase(user_status);
}
void JAttachment::internalDropDatabase(CheckStatusWrapper* user_status)
{
/**************************************
*
* i s c _ d r o p _ d a t a b a s e
*
**************************************
*
* Functional description
* Close down and purge a database.
*
**************************************/
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION, AttachmentHolder::ATT_LOCK_ASYNC);
Attachment* attachment = getHandle();
Database* const dbb = tdbb->getDatabase();
try
{
EnsureUnlock<StableAttachmentPart::Sync, NotRefCounted> guard(*(getStable()->getSync()), FB_FUNCTION);
if (!guard.tryEnter())
{
status_exception::raise(Arg::Gds(isc_attachment_in_use));
}
// Prepare to set ODS to 0
WIN window(HEADER_PAGE_NUMBER);
Ods::header_page* header = NULL;
try
{
Sync sync(&dbb->dbb_sync, "JAttachment::dropDatabase()");
if (attachment->att_in_use || attachment->att_use_count)
status_exception::raise(Arg::Gds(isc_attachment_in_use));
const PathName& file_name = attachment->att_filename;
SCL_check_database(tdbb, SCL_drop);
if (attachment->att_flags & ATT_shutdown)
{
const ISC_STATUS err = getStable()->getShutError();
if (dbb->dbb_ast_flags & DBB_shutdown)
ERR_post(Arg::Gds(isc_shutdown) << Arg::Str(file_name));
if (err)
ERR_post(Arg::Gds(isc_att_shutdown) << Arg::Gds(err));
ERR_post(Arg::Gds(isc_att_shutdown));
}
if (!CCH_exclusive(tdbb, LCK_PW, WAIT_PERIOD, NULL))
{
ERR_post(Arg::Gds(isc_lock_timeout) <<
Arg::Gds(isc_obj_in_use) << Arg::Str(file_name));
}
// Lock header page before taking database lock
header = (Ods::header_page*) CCH_FETCH(tdbb, &window, LCK_write, pag_header);
// Check if same process has more attachments
sync.lock(SYNC_EXCLUSIVE);
if (dbb->dbb_attachments && dbb->dbb_attachments->att_next)
{
ERR_post(Arg::Gds(isc_no_meta_update) <<
Arg::Gds(isc_obj_in_use) << Arg::Str("DATABASE"));
}
// dbb->dbb_extManager->closeAttachment(tdbb, attachment);
// To be reviewed by Adriano - it will be anyway called in release_attachment
// Forced release of all transactions
purge_transactions(tdbb, attachment, true);
tdbb->tdbb_flags |= TDBB_detaching;
// Here we have database locked in exclusive mode.
// Just mark the header page with an 0 ods version so that no other
// process can attach to this database once we release our exclusive
// lock and start dropping files.
CCH_MARK_MUST_WRITE(tdbb, &window);
header->hdr_ods_version = 0;
header = NULL; // In case of exception in CCH_RELEASE() do not repeat it in catch
CCH_RELEASE(tdbb, &window);
// Notify Trace API manager about successful drop of database
if (attachment->att_trace_manager->needs(ITraceFactory::TRACE_EVENT_DETACH))
{
TraceConnectionImpl conn(attachment);
attachment->att_trace_manager->event_detach(&conn, true);
}
}
catch (const Exception&)
{
if (header)
{
CCH_RELEASE(tdbb, &window);
}
CCH_release_exclusive(tdbb);
throw;
}
// Unlink attachment from database
release_attachment(tdbb, attachment);
att = NULL;
attachment = NULL;
guard.leave();
PageSpace* pageSpace = dbb->dbb_page_manager.findPageSpace(DB_PAGE_SPACE);
const jrd_file* file = pageSpace->file;
const Shadow* shadow = dbb->dbb_shadow;
if (JRD_shutdown_database(dbb))
{
// This point on database is useless
// drop the files here
bool err = drop_files(file);
for (; shadow; shadow = shadow->sdw_next)
{
err = drop_files(shadow->sdw_file) || err;
}
tdbb->setDatabase(NULL);
Database::destroy(dbb);
if (err)
{
Arg::Gds(isc_drdb_completed_with_errs).copyTo(user_status);
}
}
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JAttachment::drop");
return;
}
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return;
}
successful_completion(user_status, isc_drdb_completed_with_errs);
}
int JBlob::getSegment(CheckStatusWrapper* user_status, unsigned int buffer_length, void* buffer,
unsigned int* segment_length)
{
/**************************************
*
* g d s _ $ g e t _ s e g m e n t
*
**************************************
*
* Functional description
* Get a segment from a blob.
*
**************************************/
unsigned int len = 0;
int cc = IStatus::RESULT_ERROR;
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
try
{
len = getHandle()->BLB_get_segment(tdbb, buffer, buffer_length);
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JBlob::getSegment");
return cc;
}
if (getHandle()->blb_flags & BLB_eof)
cc = IStatus::RESULT_NO_DATA;
else if (getHandle()->getFragmentSize())
cc = IStatus::RESULT_SEGMENT;
else
cc = IStatus::RESULT_OK;
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return cc;
}
successful_completion(user_status);
if (segment_length)
*segment_length = len;
return cc;
}
int JAttachment::getSlice(CheckStatusWrapper* user_status, ITransaction* tra, ISC_QUAD* array_id,
unsigned int /*sdl_length*/, const unsigned char* sdl, unsigned int param_length,
const unsigned char* param, int slice_length, unsigned char* slice)
{
/**************************************
*
* g d s _ $ g e t _ s l i c e
*
**************************************
*
* Functional description
* Snatch a slice of an array.
*
**************************************/
int return_length = 0;
try
{
JTransaction* const jt = getTransactionInterface(user_status, tra);
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
jrd_tra* transaction = jt->getHandle();
validateHandle(tdbb, transaction);
check_database(tdbb);
try
{
if (!array_id->gds_quad_low && !array_id->gds_quad_high)
MOVE_CLEAR(slice, slice_length);
else
{
return_length = blb::get_slice(tdbb, transaction, reinterpret_cast<bid*>(array_id),
sdl, param_length, param, slice_length, slice);
}
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JAttachment::getSlice");
return return_length;
}
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return return_length;
}
successful_completion(user_status);
return return_length;
}
JBlob* JAttachment::openBlob(CheckStatusWrapper* user_status, ITransaction* tra, ISC_QUAD* blob_id,
unsigned int bpb_length, const unsigned char* bpb)
{
/**************************************
*
* g d s _ $ o p e n _ b l o b 2
*
**************************************
*
* Functional description
* Open an existing blob.
*
**************************************/
blb* blob = NULL;
try
{
JTransaction* const jt = getTransactionInterface(user_status, tra);
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
jrd_tra* transaction = jt->getHandle();
validateHandle(tdbb, transaction);
check_database(tdbb);
try
{
const bid* id = reinterpret_cast<bid*>(blob_id);
if (blob_id->gds_quad_high)
transaction->checkBlob(tdbb, id, NULL, true);
blob = blb::open2(tdbb, transaction, id, bpb_length, bpb, true);
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JAttachment::openBlob");
return NULL;
}
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return NULL;
}
successful_completion(user_status);
JBlob* jb = FB_NEW JBlob(blob, getStable());
jb->addRef();
blob->blb_interface = jb;
return jb;
}
void JTransaction::prepare(CheckStatusWrapper* user_status, unsigned int msg_length, const unsigned char* msg)
{
/**************************************
*
* g d s _ $ p r e p a r e
*
**************************************
*
* Functional description
* Prepare a transaction for commit. First phase of a two
* phase commit.
*
**************************************/
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
try
{
prepare_tra(tdbb, getHandle(), msg_length, msg);
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JTransaction::prepare");
return;
}
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return;
}
successful_completion(user_status);
}
void JBlob::putSegment(CheckStatusWrapper* user_status, unsigned int buffer_length, const void* buffer)
{
/**************************************
*
* g d s _ $ p u t _ s e g m e n t
*
**************************************
*
* Functional description
* Abort a partially completed blob.
*
**************************************/
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
try
{
blb* b = getHandle();
if (buffer_length <= MAX_USHORT)
b->BLB_put_segment(tdbb, buffer, buffer_length);
else if (!b->isSegmented())
b->BLB_put_data(tdbb, static_cast<const UCHAR*>(buffer), buffer_length);
else
{
ERR_post(Arg::Gds(isc_imp_exc) << Arg::Gds(isc_blobtoobig) <<
Arg::Gds(isc_big_segment) << Arg::Num(buffer_length));
}
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JBlob::putSegment");
return;
}
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return;
}
successful_completion(user_status);
}
void JAttachment::putSlice(CheckStatusWrapper* user_status, ITransaction* tra, ISC_QUAD* array_id,
unsigned int /*sdlLength*/, const unsigned char* sdl, unsigned int paramLength,
const unsigned char* param, int sliceLength, unsigned char* slice)
{
/**************************************
*
* g d s _ $ p u t _ s l i c e
*
**************************************
*
* Functional description
* Snatch a slice of an array.
*
**************************************/
try
{
JTransaction* const jt = getTransactionInterface(user_status, tra);
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
jrd_tra* transaction = jt->getHandle();
validateHandle(tdbb, transaction);
check_database(tdbb);
try
{
blb::put_slice(tdbb, transaction, reinterpret_cast<bid*>(array_id),
sdl, paramLength, param, sliceLength, slice);
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JAttachment::putSlice");
return;
}
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return;
}
successful_completion(user_status);
}
JEvents* JAttachment::queEvents(CheckStatusWrapper* user_status, IEventCallback* callback,
unsigned int length, const unsigned char* events)
{
/**************************************
*
* g d s _ $ q u e _ e v e n t s
*
**************************************
*
* Functional description
* Que a request for event notification.
*
**************************************/
JEvents* ev = NULL;
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
try
{
Database* const dbb = tdbb->getDatabase();
Attachment* const attachment = getHandle();
EventManager::init(attachment);
const int id = dbb->eventManager()->queEvents(attachment->att_event_session,
length, events, callback);
ev = FB_NEW JEvents(id, getStable(), callback);
ev->addRef();
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JAttachment::queEvents");
return ev;
}
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return ev;
}
successful_completion(user_status);
return ev;
}
void JRequest::receive(CheckStatusWrapper* user_status, int level, unsigned int msg_type,
unsigned int msg_length, void* msg)
{
/**************************************
*
* g d s _ $ r e c e i v e
*
**************************************
*
* Functional description
* Send a record to the host program.
**************************************/
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
Request* request = verify_request_synchronization(getHandle(), level);
try
{
JRD_receive(tdbb, request, msg_type, msg_length, msg);
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JRequest::receive");
return;
}
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return;
}
successful_completion(user_status);
}
JTransaction* JAttachment::reconnectTransaction(CheckStatusWrapper* user_status, unsigned int length,
const unsigned char* id)
{
/**************************************
*
* g d s _ $ r e c o n n e c t
*
**************************************
*
* Functional description
* Connect to a transaction in limbo.
*
**************************************/
jrd_tra* tra = NULL;
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
try
{
tra = TRA_reconnect(tdbb, id, length);
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JAttachment::reconnectTransaction");
return NULL;
}
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return NULL;
}
successful_completion(user_status);
JTransaction* jt = FB_NEW JTransaction(tra, getStable());
tra->setInterface(jt);
jt->addRef();
return jt;
}
void JRequest::deprecatedFree(CheckStatusWrapper* user_status)
{
freeEngineData(user_status);
}
void JRequest::free(CheckStatusWrapper* user_status)
{
freeEngineData(user_status);
if (user_status->isEmpty())
release();
}
void JRequest::freeEngineData(CheckStatusWrapper* user_status)
{
/**************************************
*
* g d s _ $ r e l e a s e _ r e q u e s t
*
**************************************
*
* Functional description
* Release a request.
*
**************************************/
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
try
{
getHandle()->release(tdbb);
rq = NULL;
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JRequest::freeEngineData");
return;
}
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return;
}
successful_completion(user_status);
}
void JRequest::getInfo(CheckStatusWrapper* user_status, int level, unsigned int itemsLength,
const unsigned char* items, unsigned int bufferLength, unsigned char* buffer)
{
/**************************************
*
* g d s _ $ r e q u e s t _ i n f o
*
**************************************
*
* Functional description
* Provide information on blob object.
*
**************************************/
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
Request* request = verify_request_synchronization(getHandle(), level);
try
{
INF_request_info(request, itemsLength, items, bufferLength, buffer);
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JRequest::getInfo");
return;
}
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return;
}
successful_completion(user_status);
}
void JTransaction::rollbackRetaining(CheckStatusWrapper* user_status)
{
/**************************************
*
* i s c _ r o l l b a c k _ r e t a i n i n g
*
**************************************
*
* Functional description
* Abort a transaction but keep the environment valid
*
**************************************/
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
try
{
JRD_rollback_retaining(tdbb, getHandle());
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JTransaction::rollbackRetaining");
return;
}
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return;
}
successful_completion(user_status);
}
void JTransaction::rollback(CheckStatusWrapper* user_status)
{
internalRollback(user_status);
if (user_status->isEmpty())
release();
}
void JTransaction::deprecatedRollback(CheckStatusWrapper* user_status)
{
internalRollback(user_status);
}
void JTransaction::internalRollback(CheckStatusWrapper* user_status)
{
/**************************************
*
* g d s _ $ r o l l b a c k
*
**************************************
*
* Functional description
* Abort a transaction.
*
**************************************/
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
try
{
JRD_rollback_transaction(tdbb, getHandle());
transaction = NULL;
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JTransaction::rollback");
return;
}
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return;
}
successful_completion(user_status);
}
void JTransaction::disconnect(CheckStatusWrapper* user_status)
{
internalDisconnect(user_status);
if (user_status->isEmpty())
release();
}
void JTransaction::deprecatedDisconnect(CheckStatusWrapper* user_status)
{
internalDisconnect(user_status);
}
void JTransaction::internalDisconnect(CheckStatusWrapper* user_status)
{
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
// ASF: Looks wrong that this method is ignored in the engine and remote providers.
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return;
}
successful_completion(user_status);
}
int JBlob::seek(CheckStatusWrapper* user_status, int mode, int offset)
{
/**************************************
*
* g d s _ $ s e e k _ b l o b
*
**************************************
*
* Functional description
* Seek a stream blob.
*
**************************************/
int result = -1;
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
try
{
result = getHandle()->BLB_lseek(mode, offset);
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JBlob::seek");
return result;
}
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return result;
}
successful_completion(user_status);
return result;
}
void JRequest::send(CheckStatusWrapper* user_status, int level, unsigned int msg_type,
unsigned int msg_length, const void* msg)
{
/**************************************
*
* g d s _ $ s e n d
*
**************************************
*
* Functional description
* Get a record from the host program.
*
**************************************/
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
Request* request = verify_request_synchronization(getHandle(), level);
try
{
JRD_send(tdbb, request, msg_type, msg_length, msg);
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JRequest::send");
return;
}
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return;
}
successful_completion(user_status);
}
JService* JProvider::attachServiceManager(CheckStatusWrapper* user_status, const char* service_name,
unsigned int spbLength, const unsigned char* spb)
{
/**************************************
*
* g d s _ $ s e r v i c e _ a t t a c h
*
**************************************
*
* Functional description
* Connect to a Firebird service.
*
**************************************/
JService* jSvc = NULL;
try
{
ThreadContextHolder tdbb(user_status);
Service* svc = FB_NEW Service(service_name, spbLength, spb, cryptCallback);
jSvc = FB_NEW JService(svc);
jSvc->addRef();
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return jSvc;
}
successful_completion(user_status);
return jSvc;
}
void JService::deprecatedDetach(CheckStatusWrapper* user_status)
{
freeEngineData(user_status);
}
void JService::detach(CheckStatusWrapper* user_status)
{
freeEngineData(user_status);
if (user_status->isEmpty())
release();
}
void JService::freeEngineData(CheckStatusWrapper* user_status)
{
/**************************************
*
* g d s _ $ s e r v i c e _ d e t a c h
*
**************************************
*
* Functional description
* Close down a service.
*
**************************************/
try
{
ThreadContextHolder tdbb(user_status);
validateHandle(svc);
svc->detach();
svc = NULL;
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return;
}
successful_completion(user_status);
}
void JService::query(CheckStatusWrapper* user_status,
unsigned int sendLength, const unsigned char* sendItems,
unsigned int receiveLength, const unsigned char* receiveItems,
unsigned int bufferLength, unsigned char* buffer)
{
/**************************************
*
* g d s _ $ s e r v i c e _ q u e r y
*
**************************************
*
* Functional description
* Provide information on service object.
*
* NOTE: The parameter RESERVED must not be used
* for any purpose as there are networking issues
* involved (as with any handle that goes over the
* network). This parameter will be implemented at
* a later date.
*
**************************************/
try
{
ThreadContextHolder tdbb(user_status);
validateHandle(svc);
if (svc->getVersion() == isc_spb_version1)
{
svc->query(sendLength, sendItems, receiveLength,
receiveItems, bufferLength, buffer);
}
else
{
// For SVC_query2, we are going to completly dismantle user_status (since at this point it is
// meaningless anyway). The status vector returned by this function can hold information about
// the call to query the service manager and/or a service thread that may have been running.
svc->query2(tdbb, sendLength, sendItems, receiveLength,
receiveItems, bufferLength, buffer);
// If there is a status vector from a service thread, copy it into the thread status
const FbStatusVector* from = svc->getStatus();
if (from->getState())
{
fb_utils::copyStatus(user_status, from);
// Empty out the service status vector
svc->initStatus();
return;
}
}
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return;
}
successful_completion(user_status);
}
void JService::start(CheckStatusWrapper* user_status, unsigned int spbLength, const unsigned char* spb)
{
/**************************************
*
* g d s _ s e r v i c e _ s t a r t
*
**************************************
*
* Functional description
* Start the specified service
*
* NOTE: The parameter RESERVED must not be used
* for any purpose as there are networking issues
* involved (as with any handle that goes over the
* network). This parameter will be implemented at
* a later date.
**************************************/
try
{
ThreadContextHolder tdbb(user_status);
validateHandle(svc);
svc->start(spbLength, spb);
if (svc->getStatus()->getState() & IStatus::STATE_ERRORS)
{
fb_utils::copyStatus(user_status, svc->getStatus());
return;
}
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return;
}
successful_completion(user_status);
}
void JRequest::startAndSend(CheckStatusWrapper* user_status, ITransaction* tra, int level,
unsigned int msg_type, unsigned int msg_length, const void* msg)
{
/**************************************
*
* g d s _ $ s t a r t _ a n d _ s e n d
*
**************************************
*
* Functional description
* Get a record from the host program.
*
**************************************/
try
{
JTransaction* const jt = getAttachment()->getTransactionInterface(user_status, tra);
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
jrd_tra* transaction = jt->getHandle();
validateHandle(tdbb, transaction);
check_database(tdbb);
Request* request = getHandle()->getRequest(tdbb, level);
try
{
TraceBlrExecute trace(tdbb, request);
try
{
JRD_start_and_send(tdbb, request, transaction, msg_type, msg_length, msg);
// Notify Trace API about blr execution
trace.finish(ITracePlugin::RESULT_SUCCESS);
}
catch (const Exception& ex)
{
const ISC_STATUS exc = transliterateException(tdbb, ex, user_status, "JRequest::startAndSend");
const bool no_priv = (exc == isc_login || exc == isc_no_priv);
trace.finish(no_priv ? ITracePlugin::RESULT_UNAUTHORIZED : ITracePlugin::RESULT_FAILED);
return;
}
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JRequest::startAndSend");
return;
}
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return;
}
successful_completion(user_status);
}
void JRequest::start(CheckStatusWrapper* user_status, ITransaction* tra, int level)
{
/**************************************
*
* g d s _ $ s t a r t
*
**************************************
*
* Functional description
* Get a record from the host program.
*
**************************************/
try
{
JTransaction* const jt = getAttachment()->getTransactionInterface(user_status, tra);
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
jrd_tra* transaction = jt->getHandle();
validateHandle(tdbb, transaction);
check_database(tdbb);
Request* request = getHandle()->getRequest(tdbb, level);
try
{
TraceBlrExecute trace(tdbb, request);
try
{
JRD_start(tdbb, request, transaction);
trace.finish(ITracePlugin::RESULT_SUCCESS);
}
catch (const Exception& ex)
{
const ISC_STATUS exc = transliterateException(tdbb, ex, user_status, "JRequest::start");
const bool no_priv = (exc == isc_login || exc == isc_no_priv);
trace.finish(no_priv ? ITracePlugin::RESULT_UNAUTHORIZED : ITracePlugin::RESULT_FAILED);
return;
}
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JRequest::start");
return;
}
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return;
}
successful_completion(user_status);
}
void JProvider::shutdown(CheckStatusWrapper* status, unsigned int timeout, const int reason)
{
/**************************************
*
* G D S _ S H U T D O W N
*
**************************************
*
* Functional description
* Rollback every transaction, release
* every attachment, and shutdown every
* database.
*
**************************************/
try
{
MutexLockGuard guard(shutdownMutex, FB_FUNCTION);
if (engineShutdown)
{
return;
}
{ // scope
MutexLockGuard guard(newAttachmentMutex, FB_FUNCTION);
engineShutdown = true;
}
ThreadContextHolder tdbb;
EDS::Manager::shutdown();
ULONG attach_count, database_count, svc_count;
JRD_enum_attachments(NULL, attach_count, database_count, svc_count);
if (attach_count > 0 || svc_count > 0)
{
gds__log("Shutting down the server with %d active connection(s) to %d database(s), "
"%d active service(s)",
attach_count, database_count, svc_count);
}
if (reason == fb_shutrsn_exit_called)
{
// Starting threads may fail when task is going to close.
// This happens at least with some microsoft C runtimes.
// If people wish to have timeout, they should better call fb_shutdown() themselves.
// Therefore:
timeout = 0;
}
if (timeout)
{
Semaphore shutdown_semaphore;
Thread::Handle h;
Thread::start(shutdown_thread, &shutdown_semaphore, THREAD_medium, &h);
if (!shutdown_semaphore.tryEnter(0, timeout))
waitForShutdown(shutdown_semaphore);
Thread::waitForCompletion(h);
}
else
{
shutdown_thread(NULL);
}
// Do not put it into separate shutdown thread - during shutdown of TraceManager
// PluginManager wants to lock a mutex, which is sometimes already locked in current thread
TraceManager::shutdown();
Mapping::shutdownIpc();
}
catch (const Exception& ex)
{
ex.stuffException(status);
iscLogStatus("JProvider::shutdown:", status);
}
}
void JProvider::setDbCryptCallback(CheckStatusWrapper* status, ICryptKeyCallback* cryptCb)
{
status->init();
cryptCallback = cryptCb;
}
JTransaction* JAttachment::startTransaction(CheckStatusWrapper* user_status,
unsigned int tpbLength, const unsigned char* tpb)
{
/**************************************
*
* g d s _ $ s t a r t _ t r a n s a c t i o n
*
**************************************
*
* Functional description
* Start a transaction.
*
**************************************/
jrd_tra* tra = NULL;
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
start_transaction(tdbb, true, &tra, getHandle(), tpbLength, tpb);
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return NULL;
}
successful_completion(user_status);
JTransaction* jt = tra->getInterface(false);
if (jt)
tra->tra_flags &= ~TRA_own_interface;
else
{
jt = FB_NEW JTransaction(tra, getStable());
tra->setInterface(jt);
jt->addRef();
}
return jt;
}
void JAttachment::transactRequest(CheckStatusWrapper* user_status, ITransaction* tra,
unsigned int blr_length, const unsigned char* blr,
unsigned int in_msg_length, const unsigned char* in_msg,
unsigned int out_msg_length, unsigned char* out_msg)
{
/**************************************
*
* i s c _ t r a n s a c t _ r e q u e s t
*
**************************************
*
* Functional description
* Execute a procedure.
*
**************************************/
try
{
JTransaction* const jt = getTransactionInterface(user_status, tra);
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
jrd_tra* transaction = jt->getHandle();
validateHandle(tdbb, transaction);
check_database(tdbb);
try
{
Jrd::Attachment* const att = transaction->tra_attachment;
const MessageNode* inMessage = NULL;
const MessageNode* outMessage = NULL;
Request* request = NULL;
MemoryPool* new_pool = att->createPool();
try
{
Jrd::ContextPoolHolder context(tdbb, new_pool);
CompilerScratch* csb = PAR_parse(tdbb, reinterpret_cast<const UCHAR*>(blr),
blr_length, false);
for (FB_SIZE_T i = 0; i < csb->csb_rpt.getCount(); i++)
{
if (const auto node = csb->csb_rpt[i].csb_message)
{
if (node->messageNumber == 0)
inMessage = node;
else if (node->messageNumber == 1)
outMessage = node;
}
}
request = Statement::makeRequest(tdbb, csb, false);
request->getStatement()->verifyAccess(tdbb);
}
catch (const Exception&)
{
if (request)
CMP_release(tdbb, request);
else
att->deletePool(new_pool);
throw;
}
request->req_attachment = tdbb->getAttachment();
if (in_msg_length)
{
const ULONG len = inMessage ? inMessage->format->fmt_length : 0;
if (in_msg_length != len)
{
ERR_post(Arg::Gds(isc_port_len) << Arg::Num(in_msg_length) <<
Arg::Num(len));
}
memcpy(request->getImpure<UCHAR>(inMessage->impureOffset), in_msg, in_msg_length);
}
EXE_start(tdbb, request, transaction);
const ULONG len = outMessage ? outMessage->format->fmt_length : 0;
if (out_msg_length != len)
{
ERR_post(Arg::Gds(isc_port_len) << Arg::Num(out_msg_length) <<
Arg::Num(len));
}
if (out_msg_length)
{
memcpy(out_msg, request->getImpure<UCHAR>(outMessage->impureOffset),
out_msg_length);
}
check_autocommit(tdbb, request);
CMP_release(tdbb, request);
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JAttachment::transactRequest");
return;
}
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return;
}
successful_completion(user_status);
}
unsigned int JAttachment::getIdleTimeout(Firebird::CheckStatusWrapper* user_status)
{
unsigned int result = 0;
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
result = getHandle()->getIdleTimeout();
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return 0;
}
successful_completion(user_status);
return result;
}
void JAttachment::setIdleTimeout(Firebird::CheckStatusWrapper* user_status, unsigned int timeOut)
{
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
getHandle()->setIdleTimeout(timeOut);
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return;
}
successful_completion(user_status);
}
unsigned int JAttachment::getStatementTimeout(Firebird::CheckStatusWrapper* user_status)
{
unsigned int result = 0;
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
result = getHandle()->getStatementTimeout();
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return 0;
}
successful_completion(user_status);
return result;
}
void JAttachment::setStatementTimeout(Firebird::CheckStatusWrapper* user_status, unsigned int timeOut)
{
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
getHandle()->setStatementTimeout(timeOut);
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return;
}
successful_completion(user_status);
}
void JTransaction::getInfo(CheckStatusWrapper* user_status,
unsigned int itemsLength, const unsigned char* items,
unsigned int bufferLength, unsigned char* buffer)
{
/**************************************
*
* g d s _ $ t r a n s a c t i o n _ i n f o
*
**************************************
*
* Functional description
* Provide information on blob object.
*
**************************************/
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
try
{
INF_transaction_info(getHandle(), itemsLength, items, bufferLength, buffer);
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JTransaction::getInfo");
return;
}
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return;
}
successful_completion(user_status);
}
void JRequest::unwind(CheckStatusWrapper* user_status, int level)
{
/**************************************
*
* g d s _ $ u n w i n d
*
**************************************
*
* Functional description
* Unwind a running request. This is potentially nasty since it can
* be called asynchronously.
*
**************************************/
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
Request* request = verify_request_synchronization(getHandle(), level);
try
{
JRD_unwind_request(tdbb, request);
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JRequest::unwind");
return;
}
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return;
}
successful_completion(user_status);
}
SysStableAttachment::SysStableAttachment(Attachment* handle)
: StableAttachmentPart(handle)
{
handle->att_flags |= ATT_system;
m_JAttachment = FB_NEW JAttachment(this);
this->setInterface(m_JAttachment);
}
void SysStableAttachment::initDone()
{
Jrd::Attachment* attachment = getHandle();
Database* dbb = attachment->att_database;
SyncLockGuard guard(&dbb->dbb_sys_attach, SYNC_EXCLUSIVE, "SysStableAttachment::initDone");
attachment->att_next = dbb->dbb_sys_attachments;
dbb->dbb_sys_attachments = attachment;
}
void SysStableAttachment::destroy(Attachment* attachment)
{
{
Database* dbb = attachment->att_database;
SyncLockGuard guard(&dbb->dbb_sys_attach, SYNC_EXCLUSIVE, "SysStableAttachment::destroy");
for (Jrd::Attachment** ptr = &dbb->dbb_sys_attachments; *ptr; ptr = &(*ptr)->att_next)
{
if (*ptr == attachment)
{
*ptr = attachment->att_next;
break;
}
}
}
// Make Attachment::destroy() happy
AttSyncLockGuard async(*getSync(true), FB_FUNCTION);
AttSyncLockGuard sync(*getSync(), FB_FUNCTION);
setInterface(NULL);
Jrd::Attachment::destroy(attachment);
}
ITransaction* JStatement::execute(CheckStatusWrapper* user_status, ITransaction* apiTra,
IMessageMetadata* inMetadata, void* inBuffer, IMessageMetadata* outMetadata, void* outBuffer)
{
JTransaction* jt = NULL;
try
{
if (apiTra)
jt = getAttachment()->getTransactionInterface(user_status, apiTra);
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
jrd_tra* tra = jt ? jt->getHandle() : NULL;
if (tra)
validateHandle(tdbb, tra);
check_database(tdbb);
try
{
DSQL_execute(tdbb, &tra, getHandle(),
inMetadata, static_cast<UCHAR*>(inBuffer),
outMetadata, static_cast<UCHAR*>(outBuffer));
jt = checkTranIntf(getAttachment(), jt, tra);
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JStatement::execute");
jt = checkTranIntf(getAttachment(), jt, tra);
return jt;
}
trace_warning(tdbb, user_status, "JStatement::execute");
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return apiTra;
}
successful_completion(user_status);
return jt;
}
JResultSet* JStatement::openCursor(CheckStatusWrapper* user_status, ITransaction* transaction,
IMessageMetadata* inMetadata, void* inBuffer, IMessageMetadata* outMetadata, unsigned int flags)
{
JResultSet* rs = NULL;
try
{
JTransaction* jt = transaction ? getAttachment()->getTransactionInterface(user_status, transaction) : NULL;
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
jrd_tra* tra = jt ? jt->getHandle() : NULL;
if (tra)
validateHandle(tdbb, tra);
check_database(tdbb);
try
{
RefPtr<IMessageMetadata> defaultOut;
if (!outMetadata)
{
defaultOut.assignRefNoIncr(metadata.getOutputMetadata());
if (defaultOut)
{
outMetadata = defaultOut;
}
}
const auto cursor = getHandle()->openCursor(tdbb, &tra,
inMetadata, static_cast<UCHAR*>(inBuffer), outMetadata, flags);
rs = FB_NEW JResultSet(cursor, this);
rs->addRef();
cursor->setInterfacePtr(rs);
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JStatement::openCursor");
return NULL;
}
trace_warning(tdbb, user_status, "JStatement::openCursor");
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return NULL;
}
successful_completion(user_status);
return rs;
}
IResultSet* JAttachment::openCursor(CheckStatusWrapper* user_status, ITransaction* apiTra,
unsigned int length, const char* string, unsigned int dialect,
IMessageMetadata* inMetadata, void* inBuffer, IMessageMetadata* outMetadata,
const char* cursorName, unsigned int cursorFlags)
{
IStatement* tmpStatement = prepare(user_status, apiTra, length, string, dialect,
(outMetadata ? 0 : IStatement::PREPARE_PREFETCH_OUTPUT_PARAMETERS));
if (user_status->getState() & IStatus::STATE_ERRORS)
{
return NULL;
}
if (cursorName)
{
tmpStatement->setCursorName(user_status, cursorName);
if (user_status->getState() & IStatus::STATE_ERRORS)
{
tmpStatement->release();
return NULL;
}
}
IResultSet* rs = tmpStatement->openCursor(user_status, apiTra,
inMetadata, inBuffer, outMetadata, cursorFlags);
tmpStatement->release();
return rs;
}
ITransaction* JAttachment::execute(CheckStatusWrapper* user_status, ITransaction* apiTra,
unsigned int length, const char* string, unsigned int dialect,
IMessageMetadata* inMetadata, void* inBuffer, IMessageMetadata* outMetadata, void* outBuffer)
{
JTransaction* jt = NULL;
try
{
if (apiTra)
jt = getTransactionInterface(user_status, apiTra);
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
jrd_tra* tra = jt ? jt->getHandle() : NULL;
if (tra)
validateHandle(tdbb, tra);
check_database(tdbb);
try
{
DSQL_execute_immediate(tdbb, getHandle(), &tra, length, string, dialect,
inMetadata, static_cast<UCHAR*>(inBuffer),
outMetadata, static_cast<UCHAR*>(outBuffer),
false);
jt = checkTranIntf(getStable(), jt, tra);
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JAttachment::execute");
jt = checkTranIntf(getStable(), jt, tra);
return jt;
}
trace_warning(tdbb, user_status, "JAttachment::execute");
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return apiTra;
}
successful_completion(user_status);
return jt;
}
IBatch* JAttachment::createBatch(CheckStatusWrapper* status, ITransaction* transaction,
unsigned stmtLength, const char* sqlStmt, unsigned dialect,
IMessageMetadata* inMetadata, unsigned parLength, const unsigned char* par)
{
RefPtr<IStatement> tmpStatement(REF_NO_INCR, prepare(status, transaction, stmtLength, sqlStmt,
dialect, 0));
if (status->getState() & IStatus::STATE_ERRORS)
{
return NULL;
}
return tmpStatement->createBatch(status, inMetadata, parLength, par);
}
IReplicator* JAttachment::createReplicator(CheckStatusWrapper* user_status)
{
JReplicator* jr = NULL;
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
try
{
const auto applier = Applier::create(tdbb);
jr = FB_NEW JReplicator(applier, getStable());
jr->addRef();
applier->setInterfacePtr(jr);
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JAttachment::createReplicator");
return nullptr;
}
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return nullptr;
}
successful_completion(user_status);
return jr;
}
int JResultSet::fetchNext(CheckStatusWrapper* user_status, void* buffer)
{
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
try
{
state = cursor->fetchNext(tdbb, static_cast<UCHAR*>(buffer));
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JResultSet::fetchNext");
return IStatus::RESULT_ERROR;
}
trace_warning(tdbb, user_status, "JResultSet::fetchNext");
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return IStatus::RESULT_ERROR;
}
successful_completion(user_status);
return (state == 0) ? IStatus::RESULT_OK : IStatus::RESULT_NO_DATA;
}
int JResultSet::fetchPrior(CheckStatusWrapper* user_status, void* buffer)
{
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
try
{
state = cursor->fetchPrior(tdbb, static_cast<UCHAR*>(buffer));
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JResultSet::fetchPrior");
return IStatus::RESULT_ERROR;
}
trace_warning(tdbb, user_status, "JResultSet::fetchPrior");
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return IStatus::RESULT_ERROR;
}
successful_completion(user_status);
return (state == 0) ? IStatus::RESULT_OK : IStatus::RESULT_NO_DATA;
}
int JResultSet::fetchFirst(CheckStatusWrapper* user_status, void* buffer)
{
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
try
{
state = cursor->fetchFirst(tdbb, static_cast<UCHAR*>(buffer));
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JResultSet::fetchFirst");
return IStatus::RESULT_ERROR;
}
trace_warning(tdbb, user_status, "JResultSet::fetchFirst");
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return IStatus::RESULT_ERROR;
}
successful_completion(user_status);
return (state == 0) ? IStatus::RESULT_OK : IStatus::RESULT_NO_DATA;
}
int JResultSet::fetchLast(CheckStatusWrapper* user_status, void* buffer)
{
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
try
{
state = cursor->fetchLast(tdbb, static_cast<UCHAR*>(buffer));
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JResultSet::fetchLast");
return IStatus::RESULT_ERROR;
}
trace_warning(tdbb, user_status, "JResultSet::fetchLast");
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return IStatus::RESULT_ERROR;
}
successful_completion(user_status);
return (state == 0) ? IStatus::RESULT_OK : IStatus::RESULT_NO_DATA;
}
int JResultSet::fetchAbsolute(CheckStatusWrapper* user_status, int position, void* buffer)
{
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
try
{
state = cursor->fetchAbsolute(tdbb, static_cast<UCHAR*>(buffer), position);
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JResultSet::fetchAbsolute");
return IStatus::RESULT_ERROR;
}
trace_warning(tdbb, user_status, "JResultSet::fetchAbsolute");
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return IStatus::RESULT_ERROR;
}
successful_completion(user_status);
return (state == 0) ? IStatus::RESULT_OK : IStatus::RESULT_NO_DATA;
}
int JResultSet::fetchRelative(CheckStatusWrapper* user_status, int offset, void* buffer)
{
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
try
{
state = cursor->fetchRelative(tdbb, static_cast<UCHAR*>(buffer), offset);
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JResultSet::fetchRelative");
return IStatus::RESULT_ERROR;
}
trace_warning(tdbb, user_status, "JResultSet::fetchRelative");
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return IStatus::RESULT_ERROR;
}
successful_completion(user_status);
return (state == 0) ? IStatus::RESULT_OK : IStatus::RESULT_NO_DATA;
}
FB_BOOLEAN JResultSet::isEof(CheckStatusWrapper* user_status)
{
return (state > 0);
}
FB_BOOLEAN JResultSet::isBof(CheckStatusWrapper* user_status)
{
return (state < 0);
}
int JResultSet::release()
{
int rc = --refCounter;
if (rc != 0)
return rc;
if (cursor)
{
LocalStatus status;
CheckStatusWrapper statusWrapper(&status);
freeEngineData(&statusWrapper);
}
if (!cursor)
delete this;
return 0;
}
void JResultSet::freeEngineData(CheckStatusWrapper* user_status)
{
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
try
{
DsqlCursor::close(tdbb, cursor);
cursor = NULL;
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JResultSet::freeEngineData");
return;
}
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return;
}
successful_completion(user_status);
}
StableAttachmentPart* JResultSet::getAttachment()
{
return statement->getAttachment();
}
IMessageMetadata* JResultSet::getMetadata(CheckStatusWrapper* user_status)
{
return statement->getOutputMetadata(user_status);
}
void JResultSet::deprecatedClose(CheckStatusWrapper* user_status)
{
freeEngineData(user_status);
}
void JResultSet::close(CheckStatusWrapper* user_status)
{
freeEngineData(user_status);
if (user_status->isEmpty())
release();
}
void JStatement::freeEngineData(CheckStatusWrapper* user_status)
{
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
try
{
DSQL_free_statement(tdbb, getHandle(), DSQL_drop);
statement = NULL;
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JStatement::freeEngineData");
return;
}
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return;
}
successful_completion(user_status);
}
void JStatement::deprecatedFree(CheckStatusWrapper* user_status)
{
freeEngineData(user_status);
}
void JStatement::free(CheckStatusWrapper* user_status)
{
freeEngineData(user_status);
if (user_status->isEmpty())
release();
}
JStatement* JAttachment::prepare(CheckStatusWrapper* user_status, ITransaction* apiTra,
unsigned int stmtLength, const char* sqlStmt,
unsigned int dialect, unsigned int flags)
{
JStatement* rc = NULL;
try
{
JTransaction* const jt = apiTra ? getTransactionInterface(user_status, apiTra) : nullptr;
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
jrd_tra* tra = jt ? jt->getHandle() : nullptr;
if (tra)
validateHandle(tdbb, tra);
check_database(tdbb);
DsqlRequest* statement = NULL;
try
{
Array<UCHAR> items, buffer;
// ASF: The original code (first commit) was:
// buffer.resize(StatementMetadata::buildInfoItems(items, flags));
// which makes DSQL_prepare internals to fill the statement metadata.
// The code as now makes DSQL_prepare to not do this job.
// For embedded connection I believe the pre-filling is better but for
// remote I'm not sure it's unnecessary job, so I'm only putting that
// observation for now.
StatementMetadata::buildInfoItems(items, flags);
statement = DSQL_prepare(tdbb, getHandle(), tra, stmtLength, sqlStmt, dialect, flags,
&items, &buffer, false);
rc = FB_NEW JStatement(statement, getStable(), buffer);
rc->addRef();
trace_warning(tdbb, user_status, "JStatement::prepare");
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JStatement::prepare");
if (statement)
{
try
{
DSQL_free_statement(tdbb, statement, DSQL_drop);
}
catch (const Exception&)
{ }
}
return NULL;
}
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return NULL;
}
successful_completion(user_status);
return rc;
}
unsigned JStatement::getType(CheckStatusWrapper* userStatus)
{
unsigned ret = 0;
try
{
EngineContextHolder tdbb(userStatus, this, FB_FUNCTION);
check_database(tdbb);
try
{
ret = metadata.getType();
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, userStatus, "JStatement::getType");
return ret;
}
}
catch (const Exception& ex)
{
ex.stuffException(userStatus);
return ret;
}
successful_completion(userStatus);
return ret;
}
unsigned JStatement::getFlags(CheckStatusWrapper* userStatus)
{
unsigned ret = 0;
try
{
EngineContextHolder tdbb(userStatus, this, FB_FUNCTION);
check_database(tdbb);
try
{
ret = metadata.getFlags();
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, userStatus, "JStatement::getFlags");
return ret;
}
}
catch (const Exception& ex)
{
ex.stuffException(userStatus);
return ret;
}
successful_completion(userStatus);
return ret;
}
const char* JStatement::getPlan(CheckStatusWrapper* userStatus, FB_BOOLEAN detailed)
{
const char* ret = NULL;
try
{
EngineContextHolder tdbb(userStatus, this, FB_FUNCTION);
check_database(tdbb);
try
{
ret = metadata.getPlan(detailed);
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, userStatus, "JStatement::getPlan");
return ret;
}
trace_warning(tdbb, userStatus, "JStatement::getPlan");
}
catch (const Exception& ex)
{
ex.stuffException(userStatus);
return ret;
}
successful_completion(userStatus);
return ret;
}
IMessageMetadata* JStatement::getInputMetadata(CheckStatusWrapper* userStatus)
{
IMessageMetadata* ret = NULL;
try
{
EngineContextHolder tdbb(userStatus, this, FB_FUNCTION);
check_database(tdbb);
try
{
ret = metadata.getInputMetadata();
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, userStatus, "JStatement::getInputMetadata");
return ret;
}
trace_warning(tdbb, userStatus, "JStatement::getInputMetadata");
}
catch (const Exception& ex)
{
ex.stuffException(userStatus);
return ret;
}
successful_completion(userStatus);
return ret;
}
IMessageMetadata* JStatement::getOutputMetadata(CheckStatusWrapper* userStatus)
{
IMessageMetadata* ret = NULL;
try
{
EngineContextHolder tdbb(userStatus, this, FB_FUNCTION);
check_database(tdbb);
try
{
ret = metadata.getOutputMetadata();
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, userStatus, "JStatement::getOutputMetadata");
return ret;
}
trace_warning(tdbb, userStatus, "JStatement::getOutputMetadata");
}
catch (const Exception& ex)
{
ex.stuffException(userStatus);
return ret;
}
successful_completion(userStatus);
return ret;
}
ISC_UINT64 JStatement::getAffectedRecords(CheckStatusWrapper* userStatus)
{
ISC_UINT64 ret = 0;
try
{
EngineContextHolder tdbb(userStatus, this, FB_FUNCTION);
check_database(tdbb);
try
{
ret = metadata.getAffectedRecords();
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, userStatus, "JStatement::getAffectedRecords");
return ret;
}
}
catch (const Exception& ex)
{
ex.stuffException(userStatus);
return ret;
}
successful_completion(userStatus);
return ret;
}
void JStatement::setCursorName(CheckStatusWrapper* user_status, const char* cursor)
{
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
try
{
getHandle()->setCursor(tdbb, cursor);
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JResultSet::setCursorName");
return;
}
trace_warning(tdbb, user_status, "JResultSet::setCursorName");
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return;
}
successful_completion(user_status);
}
void JResultSet::setDelayedOutputFormat(CheckStatusWrapper* user_status, Firebird::IMessageMetadata* outMetadata)
{
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
try
{
DsqlRequest* req = statement->getHandle();
fb_assert(req);
req->setDelayedFormat(tdbb, outMetadata);
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JResultSet::setDelayedOutputFormat");
return;
}
trace_warning(tdbb, user_status, "JResultSet::setDelayedOutputFormat");
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return;
}
successful_completion(user_status);
}
void JStatement::getInfo(CheckStatusWrapper* user_status,
unsigned int item_length, const unsigned char* items,
unsigned int buffer_length, unsigned char* buffer)
{
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
try
{
DSQL_sql_info(tdbb, getHandle(), item_length, items, buffer_length, buffer);
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JStatement::getInfo");
return;
}
trace_warning(tdbb, user_status, "JStatement::getInfo");
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return;
}
successful_completion(user_status);
}
unsigned int JStatement::getTimeout(CheckStatusWrapper* user_status)
{
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
try
{
Jrd::DsqlRequest* req = getHandle();
return req->getTimeout();
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, FB_FUNCTION);
return 0;
}
trace_warning(tdbb, user_status, FB_FUNCTION);
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return 0;
}
successful_completion(user_status);
return 0;
}
void JStatement::setTimeout(CheckStatusWrapper* user_status, unsigned int timeOut)
{
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
try
{
Jrd::DsqlRequest* req = getHandle();
req->setTimeout(timeOut);
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, FB_FUNCTION);
return;
}
trace_warning(tdbb, user_status, FB_FUNCTION);
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return;
}
successful_completion(user_status);
}
JBatch* JStatement::createBatch(Firebird::CheckStatusWrapper* status, Firebird::IMessageMetadata* inMetadata,
unsigned parLength, const unsigned char* par)
{
JBatch* batch = NULL;
try
{
EngineContextHolder tdbb(status, this, FB_FUNCTION);
check_database(tdbb);
try
{
RefPtr<IMessageMetadata> defaultIn;
if (!inMetadata)
{
defaultIn.assignRefNoIncr(metadata.getInputMetadata());
if (defaultIn)
{
inMetadata = defaultIn;
}
}
const auto dsqlBatch = getHandle()->openBatch(tdbb, inMetadata, parLength, par);
batch = FB_NEW JBatch(dsqlBatch, this, inMetadata);
batch->addRef();
dsqlBatch->setInterfacePtr(batch);
tdbb->getAttachment()->registerBatch(batch);
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, status, "JStatement::createBatch");
return NULL;
}
trace_warning(tdbb, status, "JStatement::createBatch");
}
catch (const Exception& ex)
{
ex.stuffException(status);
return NULL;
}
successful_completion(status);
return batch;
}
JBatch::JBatch(DsqlBatch* handle, JStatement* aStatement, IMessageMetadata* aMetadata)
: batch(handle),
statement(aStatement),
m_meta(aMetadata)
{ }
StableAttachmentPart* JBatch::getAttachment()
{
return statement->getAttachment();
}
int JBatch::release()
{
int rc = --refCounter;
if (rc != 0)
return rc;
if (batch)
{
LocalStatus status;
CheckStatusWrapper statusWrapper(&status);
freeEngineData(&statusWrapper);
}
delete this;
return 0;
}
void JBatch::deprecatedClose(CheckStatusWrapper* user_status)
{
freeEngineData(user_status);
}
void JBatch::close(CheckStatusWrapper* user_status)
{
freeEngineData(user_status);
if (user_status->isEmpty())
release();
}
void JBatch::freeEngineData(Firebird::CheckStatusWrapper* user_status)
{
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
try
{
Attachment* att = getAttachment()->getHandle();
if (att)
att->deregisterBatch(this);
delete batch;
batch = nullptr;
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, FB_FUNCTION);
return;
}
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return;
}
successful_completion(user_status);
}
void JBatch::add(CheckStatusWrapper* status, unsigned count, const void* inBuffer)
{
try
{
EngineContextHolder tdbb(status, this, FB_FUNCTION);
check_database(tdbb);
try
{
DsqlBatch* b = getHandle();
b->add(tdbb, count, inBuffer);
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, status, "JBatch::add");
return;
}
trace_warning(tdbb, status, "JBatch::add");
}
catch (const Exception& ex)
{
ex.stuffException(status);
return;
}
successful_completion(status);
}
void JBatch::addBlob(CheckStatusWrapper* status, unsigned length, const void* inBuffer, ISC_QUAD* blobId,
unsigned parLength, const unsigned char* par)
{
try
{
EngineContextHolder tdbb(status, this, FB_FUNCTION);
check_database(tdbb);
try
{
DsqlBatch* b = getHandle();
b->addBlob(tdbb, length, inBuffer, blobId, parLength, par);
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, status, "JBatch::addBlob");
return;
}
trace_warning(tdbb, status, "JBatch::addBlob");
}
catch (const Exception& ex)
{
ex.stuffException(status);
return;
}
successful_completion(status);
}
void JBatch::appendBlobData(CheckStatusWrapper* status, unsigned length, const void* inBuffer)
{
try
{
EngineContextHolder tdbb(status, this, FB_FUNCTION);
check_database(tdbb);
try
{
DsqlBatch* b = getHandle();
b->appendBlobData(tdbb, length, inBuffer);
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, status, "JBatch::appendBlobData");
return;
}
trace_warning(tdbb, status, "JBatch::appendBlobData");
}
catch (const Exception& ex)
{
ex.stuffException(status);
return;
}
successful_completion(status);
}
void JBatch::addBlobStream(CheckStatusWrapper* status, unsigned length, const void* inBuffer)
{
try
{
EngineContextHolder tdbb(status, this, FB_FUNCTION);
check_database(tdbb);
try
{
DsqlBatch* b = getHandle();
b->addBlobStream(tdbb, length, inBuffer);
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, status, "JBatch::addBlobStream");
return;
}
trace_warning(tdbb, status, "JBatch::addBlobStream");
}
catch (const Exception& ex)
{
ex.stuffException(status);
return;
}
successful_completion(status);
}
void JBatch::setDefaultBpb(CheckStatusWrapper* status, unsigned parLength, const unsigned char* par)
{
try
{
EngineContextHolder tdbb(status, this, FB_FUNCTION);
check_database(tdbb);
try
{
DsqlBatch* b = getHandle();
b->setDefaultBpb(tdbb, parLength, par);
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, status, "JBatch::setDefaultBpb");
return;
}
trace_warning(tdbb, status, "JBatch::setDefaultBpb");
}
catch (const Exception& ex)
{
ex.stuffException(status);
return;
}
successful_completion(status);
}
unsigned JBatch::getBlobAlignment(CheckStatusWrapper*)
{
return DsqlBatch::BLOB_STREAM_ALIGN;
}
IMessageMetadata* JBatch::getMetadata(CheckStatusWrapper* status)
{
IMessageMetadata* meta;
try
{
EngineContextHolder tdbb(status, this, FB_FUNCTION);
check_database(tdbb);
try
{
DsqlBatch* b = getHandle();
meta = b->getMetadata(tdbb);
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, status, "JBatch::getMetadata");
return NULL;
}
trace_warning(tdbb, status, "JBatch::getMetadata");
}
catch (const Exception& ex)
{
ex.stuffException(status);
return NULL;
}
successful_completion(status);
return meta;
}
void JBatch::registerBlob(CheckStatusWrapper* status, const ISC_QUAD* existingBlob, ISC_QUAD* blobId)
{
try
{
EngineContextHolder tdbb(status, this, FB_FUNCTION);
check_database(tdbb);
try
{
DsqlBatch* b = getHandle();
b->registerBlob(tdbb, existingBlob, blobId);
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, status, "JBatch::registerBlob");
return;
}
trace_warning(tdbb, status, "JBatch::registerBlob");
}
catch (const Exception& ex)
{
ex.stuffException(status);
return;
}
successful_completion(status);
}
IBatchCompletionState* JBatch::execute(CheckStatusWrapper* status, ITransaction* transaction)
{
IBatchCompletionState* cs;
try
{
JTransaction* jt = transaction ? getAttachment()->getTransactionInterface(status, transaction) : nullptr;
EngineContextHolder tdbb(status, this, FB_FUNCTION);
jrd_tra* tra = jt ? jt->getHandle() : nullptr;
validateHandle(tdbb, tra);
check_database(tdbb);
try
{
DsqlBatch* b = getHandle();
cs = b->execute(tdbb);
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, status, "JBatch::execute");
return NULL;
}
trace_warning(tdbb, status, "JBatch::execute");
}
catch (const Exception& ex)
{
ex.stuffException(status);
return NULL;
}
successful_completion(status);
return cs;
}
void JBatch::cancel(CheckStatusWrapper* status)
{
try
{
EngineContextHolder tdbb(status, this, FB_FUNCTION);
check_database(tdbb);
try
{
DsqlBatch* b = getHandle();
b->cancel(tdbb);
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, status, "JBatch::cancel");
return;
}
trace_warning(tdbb, status, "JBatch::cancel");
}
catch (const Exception& ex)
{
ex.stuffException(status);
return;
}
successful_completion(status);
}
void JBatch::getInfo(CheckStatusWrapper* user_status,
unsigned int itemsLength, const unsigned char* items,
unsigned int bufferLength, unsigned char* buffer)
{
/**************************************
*
* g d s _ $ b l o b _ i n f o
*
**************************************
*
* Functional description
* Provide information on blob object.
*
**************************************/
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
try
{
DsqlBatch* b = getHandle();
b->info(tdbb, itemsLength, items, bufferLength, buffer);
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JBatch::getInfo");
return;
}
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return;
}
successful_completion(user_status);
}
JReplicator::JReplicator(Applier* appl, StableAttachmentPart* sa)
: applier(appl), sAtt(sa)
{ }
int JReplicator::release()
{
int rc = --refCounter;
if (rc != 0)
return rc;
if (applier)
{
LocalStatus status;
CheckStatusWrapper statusWrapper(&status);
freeEngineData(&statusWrapper);
}
delete this;
return 0;
}
void JReplicator::freeEngineData(Firebird::CheckStatusWrapper* user_status)
{
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb);
try
{
AutoPtr<Applier> cleanupApplier(applier);
cleanupApplier->shutdown(tdbb);
fb_assert(!applier);
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, FB_FUNCTION);
return;
}
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return;
}
successful_completion(user_status);
}
void JReplicator::process(CheckStatusWrapper* status, unsigned length, const UCHAR* data)
{
try
{
EngineContextHolder tdbb(status, this, FB_FUNCTION);
check_database(tdbb);
try
{
applier->process(tdbb, length, data);
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, status, "JReplicator::process");
return;
}
trace_warning(tdbb, status, "JReplicator::process");
}
catch (const Exception& ex)
{
ex.stuffException(status);
return;
}
successful_completion(status);
}
void JReplicator::deprecatedClose(CheckStatusWrapper* user_status)
{
freeEngineData(user_status);
}
void JReplicator::close(CheckStatusWrapper* user_status)
{
freeEngineData(user_status);
if (user_status->isEmpty())
release();
}
void JAttachment::ping(CheckStatusWrapper* user_status)
{
/**************************************
*
* G D S _ P I N G
*
**************************************
*
* Functional description
* Check the attachment handle for persistent errors.
*
**************************************/
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb, true);
}
catch (const Exception& ex)
{
ex.stuffException(user_status);
return;
}
successful_completion(user_status);
}
} // namespace Jrd
#ifdef DEBUG_PROCS
void JRD_print_procedure_info(thread_db* tdbb, const char* mesg)
{
/*****************************************************
*
* J R D _ p r i n t _ p r o c e d u r e _ i n f o
*
*****************************************************
*
* Functional description
* print name , use_count of all procedures in
* cache
*
******************************************************/
TEXT fname[MAXPATHLEN];
Firebird::string fname = fb_utils::getPrefix(IConfigManager::DIR_LOG, "proc_info.log");
FILE* fptr = os_utils::fopen(fname.c_str(), "a+");
if (!fptr)
{
gds__log("Failed to open %s\n", fname.c_str());
return;
}
if (mesg)
fputs(mesg, fptr);
fprintf(fptr, "Prc Name , prc id , flags , Use Count , Alter Count\n");
vec<jrd_prc*>* procedures = tdbb->getDatabase()->dbb_procedures;
if (procedures)
{
vec<jrd_prc*>::iterator ptr, end;
for (ptr = procedures->begin(), end = procedures->end(); ptr < end; ++ptr)
{
const jrd_prc* procedure = *ptr;
if (procedure)
{
fprintf(fptr, "%s , %d, %X, %d, %d\n",
(procedure->getName().toString().hasData() ?
procedure->getName().toString().c_str() : "NULL"),
procedure->getId(), procedure->flags, procedure->useCount,
0); // procedure->prc_alter_count
}
}
}
else
fprintf(fptr, "No Cached Procedures\n");
fclose(fptr);
}
#endif // DEBUG_PROCS
void jrd_vtof(const char* string, char* field, SSHORT length)
{
/**************************************
*
* j r d _ v t o f
*
**************************************
*
* Functional description
* Move a null terminated string to a fixed length
* field.
* If the length of the string pointed to by 'field'
* is less than 'length', this function pads the
* destination string with space upto 'length' bytes.
*
* The call is primarily generated by the preprocessor.
*
* This is the same code as gds__vtof but is used internally.
*
**************************************/
while (*string)
{
*field++ = *string++;
if (--length <= 0) {
return;
}
}
if (length) {
memset(field, ' ', length);
}
}
static void check_database(thread_db* tdbb, bool async)
{
/**************************************
*
* c h e c k _ d a t a b a s e
*
**************************************
*
* Functional description
* Check an attachment for validity.
*
**************************************/
SET_TDBB(tdbb);
Database* const dbb = tdbb->getDatabase();
Jrd::Attachment* const attachment = tdbb->getAttachment();
// Test for persistent errors
if (dbb->dbb_flags & DBB_bugcheck)
{
static const char string[] = "can't continue after bugcheck";
status_exception::raise(Arg::Gds(isc_bug_check) << Arg::Str(string));
}
if ((attachment->att_flags & ATT_shutdown) &&
(attachment->att_purge_tid != Thread::getId()) ||
((dbb->dbb_ast_flags & DBB_shutdown) &&
((dbb->dbb_ast_flags & DBB_shutdown_full) || !attachment->locksmith(tdbb, ACCESS_SHUTDOWN_DATABASE))))
{
if (dbb->dbb_ast_flags & DBB_shutdown)
{
const PathName& filename = attachment->att_filename;
status_exception::raise(Arg::Gds(isc_shutdown) << Arg::Str(filename));
}
Arg::Gds err(isc_att_shutdown);
if (attachment->getStable() && attachment->getStable()->getShutError())
err << Arg::Gds(attachment->getStable()->getShutError());
err.raise();
}
// No further checks for the async calls
if (async)
return;
// Test for temporary errors
if ((attachment->att_flags & ATT_cancel_raise) &&
!(attachment->att_flags & ATT_cancel_disable))
{
attachment->att_flags &= ~ATT_cancel_raise;
status_exception::raise(Arg::Gds(isc_cancelled));
}
Monitoring::checkState(tdbb);
}
static void commit(thread_db* tdbb, jrd_tra* transaction, const bool retaining_flag)
{
/**************************************
*
* c o m m i t
*
**************************************
*
* Functional description
* Commit a transaction.
*
**************************************/
if (transaction->tra_in_use)
status_exception::raise(Arg::Gds(isc_transaction_in_use));
const Jrd::Attachment* const attachment = tdbb->getAttachment();
if (!(attachment->att_flags & ATT_no_db_triggers) && !(transaction->tra_flags & TRA_prepared))
{
// run ON TRANSACTION COMMIT triggers
run_commit_triggers(tdbb, transaction);
}
validateHandle(tdbb, transaction->tra_attachment);
tdbb->setTransaction(transaction);
TRA_commit(tdbb, transaction, retaining_flag);
}
static bool drop_files(const jrd_file* file)
{
/**************************************
*
* d r o p _ f i l e s
*
**************************************
*
* Functional description
* drop a linked list of files
*
**************************************/
FbLocalStatus status;
for (; file; file = file->fil_next)
{
if (unlink(file->fil_string))
{
ERR_build_status(&status, Arg::Gds(isc_io_error) << Arg::Str("unlink") <<
Arg::Str(file->fil_string) <<
Arg::Gds(isc_io_delete_err) << SYS_ERR(errno));
Database* dbb = GET_DBB();
PageSpace* pageSpace = dbb->dbb_page_manager.findPageSpace(DB_PAGE_SPACE);
iscDbLogStatus(pageSpace->file->fil_string, &status);
}
}
return status->getState() & IStatus::STATE_ERRORS ? true : false;
}
static void find_intl_charset(thread_db* tdbb, Jrd::Attachment* attachment, const DatabaseOptions* options)
{
/**************************************
*
* f i n d _ i n t l _ c h a r s e t
*
**************************************
*
* Functional description
* Attachment has declared it's prefered character set
* as part of LC_CTYPE, passed over with the attachment
* block. Now let's resolve that to an internal subtype id.
*
**************************************/
SET_TDBB(tdbb);
if (options->dpb_lc_ctype.isEmpty())
{
// No declaration of character set, act like 3.x Interbase
attachment->att_client_charset = attachment->att_charset = DEFAULT_ATTACHMENT_CHARSET;
return;
}
USHORT id;
const UCHAR* lc_ctype = reinterpret_cast<const UCHAR*>(options->dpb_lc_ctype.c_str());
if (MET_get_char_coll_subtype(tdbb, &id, lc_ctype, options->dpb_lc_ctype.length()) &&
INTL_defined_type(tdbb, id & 0xFF))
{
if ((id & 0xFF) == CS_BINARY)
{
ERR_post(Arg::Gds(isc_bad_dpb_content) <<
Arg::Gds(isc_invalid_attachment_charset) << Arg::Str(options->dpb_lc_ctype));
}
attachment->att_client_charset = attachment->att_charset = id & 0xFF;
}
else
{
// Report an error - we can't do what user has requested
ERR_post(Arg::Gds(isc_bad_dpb_content) <<
Arg::Gds(isc_charset_not_found) << Arg::Str(options->dpb_lc_ctype));
}
}
namespace
{
void dpbErrorRaise()
{
ERR_post(Arg::Gds(isc_bad_dpb_form) <<
Arg::Gds(isc_wrodpbver));
}
} // anonymous
void DatabaseOptions::get(const UCHAR* dpb, USHORT dpb_length, bool& invalid_client_SQL_dialect)
{
/**************************************
*
* D a t a b a s e O p t i o n s : : g e t
*
**************************************
*
* Functional description
* Parse database parameter block picking up options and things.
*
**************************************/
SSHORT num_old_files = 0;
dpb_buffers = 0;
dpb_sweep_interval = -1;
dpb_overwrite = false;
dpb_sql_dialect = 99;
invalid_client_SQL_dialect = false;
if (dpb_length == 0)
return;
if (dpb == NULL)
ERR_post(Arg::Gds(isc_bad_dpb_form));
ClumpletReader rdr(ClumpletReader::dpbList, dpb, dpb_length, dpbErrorRaise);
dumpAuthBlock("DatabaseOptions::get()", &rdr, isc_dpb_auth_block);
dpb_utf8_filename = rdr.find(isc_dpb_utf8_filename);
for (rdr.rewind(); !rdr.isEof(); rdr.moveNext())
{
switch (rdr.getClumpTag())
{
case isc_dpb_working_directory:
getPath(rdr, dpb_working_directory);
break;
case isc_dpb_set_page_buffers:
dpb_page_buffers = rdr.getInt();
if (dpb_page_buffers &&
(dpb_page_buffers < MIN_PAGE_BUFFERS || dpb_page_buffers > MAX_PAGE_BUFFERS))
{
ERR_post(Arg::Gds(isc_bad_dpb_content) << Arg::Gds(isc_baddpb_buffers_range) <<
Arg::Num(MIN_PAGE_BUFFERS) << Arg::Num(MAX_PAGE_BUFFERS));
}
dpb_set_page_buffers = true;
break;
case isc_dpb_num_buffers:
if (Config::getServerMode() != MODE_SUPER)
{
dpb_buffers = rdr.getInt();
const unsigned TEMP_LIMIT = 25;
if (dpb_buffers < TEMP_LIMIT)
{
ERR_post(Arg::Gds(isc_bad_dpb_content) <<
Arg::Gds(isc_baddpb_temp_buffers) << Arg::Num(TEMP_LIMIT));
}
}
else
rdr.getInt();
break;
case isc_dpb_page_size:
dpb_page_size = rdr.getInt();
break;
case isc_dpb_debug:
rdr.getInt();
break;
case isc_dpb_sweep:
dpb_sweep = (USHORT) rdr.getInt();
break;
case isc_dpb_sweep_interval:
dpb_sweep_interval = rdr.getInt();
break;
case isc_dpb_verify:
dpb_verify = (USHORT) rdr.getInt();
if (dpb_verify & isc_dpb_ignore)
dpb_flags |= DBB_damaged;
break;
case isc_dpb_trace:
rdr.getInt();
break;
case isc_dpb_damaged:
if (rdr.getInt() & 1)
dpb_flags |= DBB_damaged;
break;
case isc_dpb_enable_journal:
rdr.getString(dpb_journal);
break;
case isc_dpb_wal_backup_dir:
// ignore, skip
break;
case isc_dpb_drop_walfile:
dpb_wal_action = (USHORT) rdr.getInt();
break;
case isc_dpb_old_dump_id:
case isc_dpb_online_dump:
case isc_dpb_old_file_size:
case isc_dpb_old_num_files:
case isc_dpb_old_start_page:
case isc_dpb_old_start_seqno:
case isc_dpb_old_start_file:
// ignore, skip
break;
case isc_dpb_old_file:
//if (num_old_files >= MAX_OLD_FILES) complain here, for now.
ERR_post(Arg::Gds(isc_num_old_files));
// following code is never executed now !
num_old_files++;
break;
case isc_dpb_wal_chkptlen:
case isc_dpb_wal_numbufs:
case isc_dpb_wal_bufsize:
case isc_dpb_wal_grp_cmt_wait:
// ignore, skip
break;
case isc_dpb_dbkey_scope:
dpb_dbkey_scope = (USHORT) rdr.getInt();
break;
case isc_dpb_sql_role_name:
getString(rdr, dpb_role_name);
break;
case isc_dpb_auth_block:
dpb_auth_block.clear();
dpb_auth_block.add(rdr.getBytes(), rdr.getClumpLength());
break;
case isc_dpb_user_name:
getString(rdr, dpb_user_name);
break;
case isc_dpb_trusted_auth:
getString(rdr, dpb_trusted_login);
break;
case isc_dpb_encrypt_key:
// Just in case there WAS a customer using this unsupported
// feature - post an error when they try to access it now
ERR_post(Arg::Gds(isc_uns_ext) <<
Arg::Gds(isc_random) << Arg::Str("Passing encryption key in DPB not supported"));
break;
case isc_dpb_no_garbage_collect:
dpb_no_garbage = true;
break;
case isc_dpb_activate_shadow:
dpb_activate_shadow = true;
break;
case isc_dpb_delete_shadow:
dpb_delete_shadow = true;
break;
case isc_dpb_force_write:
dpb_set_force_write = true;
dpb_force_write = rdr.getInt() != 0;
break;
case isc_dpb_begin_log:
break;
case isc_dpb_quit_log:
break;
case isc_dpb_no_reserve:
dpb_set_no_reserve = true;
dpb_no_reserve = rdr.getInt() != 0;
break;
case isc_dpb_interp:
dpb_interp = (SSHORT) rdr.getInt();
break;
case isc_dpb_lc_ctype:
rdr.getString(dpb_lc_ctype);
break;
case isc_dpb_shutdown:
dpb_shutdown = (USHORT) rdr.getInt();
// Enforce default
if ((dpb_shutdown & isc_dpb_shut_mode_mask) == isc_dpb_shut_default)
dpb_shutdown |= isc_dpb_shut_multi;
break;
case isc_dpb_shutdown_delay:
dpb_shutdown_delay = (SSHORT) rdr.getInt();
break;
case isc_dpb_online:
dpb_online = (USHORT) rdr.getInt();
// Enforce default
if ((dpb_online & isc_dpb_shut_mode_mask) == isc_dpb_shut_default)
{
dpb_online |= isc_dpb_shut_normal;
}
break;
case isc_dpb_reserved:
{
string single;
rdr.getString(single);
if (single == "YES")
{
dpb_single_user = true;
}
}
break;
case isc_dpb_overwrite:
dpb_overwrite = rdr.getInt() != 0;
break;
case isc_dpb_nolinger:
dpb_nolinger = true;
break;
case isc_dpb_reset_icu:
dpb_reset_icu = true;
break;
case isc_dpb_sec_attach:
dpb_sec_attach = rdr.getInt() != 0;
break;
case isc_dpb_map_attach:
dpb_map_attach = true;
break;
case isc_dpb_gbak_attach:
{
string gbakStr;
rdr.getString(gbakStr);
dpb_gbak_attach = gbakStr.hasData();
}
break;
case isc_dpb_gstat_attach:
dpb_gstat_attach = true;
break;
case isc_dpb_gfix_attach:
dpb_gfix_attach = true;
break;
case isc_dpb_disable_wal:
dpb_disable_wal = true;
break;
case isc_dpb_connect_timeout:
dpb_connect_timeout = rdr.getInt();
break;
case isc_dpb_dummy_packet_interval:
dpb_dummy_packet_interval = rdr.getInt();
break;
case isc_dpb_sql_dialect:
dpb_sql_dialect = (USHORT) rdr.getInt();
if (dpb_sql_dialect > SQL_DIALECT_V6)
invalid_client_SQL_dialect = true;
break;
case isc_dpb_set_db_sql_dialect:
dpb_set_db_sql_dialect = (USHORT) rdr.getInt();
break;
case isc_dpb_set_db_readonly:
dpb_set_db_readonly = true;
dpb_db_readonly = rdr.getInt() != 0;
break;
case isc_dpb_set_db_charset:
getString(rdr, dpb_set_db_charset);
fb_utils::dpbItemUpper(dpb_set_db_charset);
break;
case isc_dpb_address_path:
{
ClumpletReader address_stack(ClumpletReader::UnTagged,
rdr.getBytes(), rdr.getClumpLength());
while (!address_stack.isEof())
{
if (address_stack.getClumpTag() != isc_dpb_address)
{
address_stack.moveNext();
continue;
}
ClumpletReader address(ClumpletReader::UnTagged,
address_stack.getBytes(), address_stack.getClumpLength());
while (!address.isEof())
{
switch (address.getClumpTag())
{
case isc_dpb_addr_protocol:
address.getString(dpb_network_protocol);
break;
case isc_dpb_addr_endpoint:
address.getString(dpb_remote_address);
break;
case isc_dpb_addr_flags:
dpb_remote_flags = address.getInt();
break;
case isc_dpb_addr_crypt:
address.getPath(dpb_remote_crypt);
break;
default:
break;
}
address.moveNext();
}
break;
}
}
break;
case isc_dpb_process_id:
dpb_remote_pid = rdr.getInt();
break;
case isc_dpb_process_name:
getPath(rdr, dpb_remote_process);
break;
case isc_dpb_host_name:
getString(rdr, dpb_remote_host);
break;
case isc_dpb_os_user:
getString(rdr, dpb_remote_os_user);
break;
case isc_dpb_client_version:
getString(rdr, dpb_client_version);
break;
case isc_dpb_remote_protocol:
getString(rdr, dpb_remote_protocol);
break;
case isc_dpb_no_db_triggers:
dpb_no_db_triggers = rdr.getInt() != 0;
break;
case isc_dpb_org_filename:
getPath(rdr, dpb_org_filename);
break;
case isc_dpb_ext_call_depth:
dpb_ext_call_depth = (ULONG) rdr.getInt();
if (dpb_ext_call_depth >= MAX_CALLBACKS)
ERR_post(Arg::Gds(isc_exec_sql_max_call_exceeded));
break;
case isc_dpb_config:
getString(rdr, dpb_config);
break;
case isc_dpb_session_time_zone:
rdr.getString(dpb_session_tz);
break;
case isc_dpb_set_db_replica:
dpb_set_db_replica = true;
dpb_replica_mode = (ReplicaMode) rdr.getInt();
break;
case isc_dpb_set_bind:
rdr.getPath(dpb_set_bind);
break;
case isc_dpb_decfloat_round:
rdr.getString(dpb_decfloat_round);
break;
case isc_dpb_decfloat_traps:
rdr.getString(dpb_decfloat_traps);
break;
case isc_dpb_clear_map:
dpb_clear_map = rdr.getBoolean();
break;
default:
break;
}
}
if (! rdr.isEof())
ERR_post(Arg::Gds(isc_bad_dpb_form));
}
static JAttachment* initAttachment(thread_db* tdbb, const PathName& expanded_name,
const PathName& alias_name, RefPtr<const Config> config, bool attach_flag,
const DatabaseOptions& options, RefMutexUnlock& initGuard, IPluginConfig* pConf,
JProvider* provider)
{
/**************************************
*
* i n i t A t t a c h m e n t
*
**************************************
*
* Functional description
* Initialize for database access. First call from both CREATE and ATTACH.
* Upon entry mutex dbInitMutex must be locked.
*
**************************************/
SET_TDBB(tdbb);
fb_assert(dbInitMutex->locked());
// make sure that no new attachments arrive after shutdown started
if (engineShutdown)
{
Arg::Gds(isc_att_shutdown).raise();
}
// Initialize standard random generator.
// MSVC (at least since version 7) have per-thread random seed.
// As we don't know who uses per-thread seed, this should work for both cases.
static bool first_rand = true;
static int first_rand_value = rand();
if (first_rand || (rand() == first_rand_value))
srand(time(NULL));
first_rand = false;
#ifdef HAVE_ID_BY_NAME
UCharBuffer db_id;
os_utils::getUniqueFileId(expanded_name.c_str(), db_id);
#endif
engineStartup.init();
if (!attach_flag && options.dpb_set_db_charset.hasData() &&
!IntlManager::charSetInstalled(options.dpb_set_db_charset))
{
ERR_post(Arg::Gds(isc_charset_not_installed) << options.dpb_set_db_charset);
}
// Check to see if the database is already attached
Database* dbb = NULL;
JAttachment* jAtt;
bool shared = false;
{ // scope
MutexLockGuard listGuard(databases_mutex, FB_FUNCTION);
if (config->getServerMode() == MODE_SUPER)
{
shared = true;
dbb = databases;
while (dbb)
{
if (dbb->dbb_filename == expanded_name
#ifdef HAVE_ID_BY_NAME
|| dbb->dbb_id == db_id
#endif
)
{
if (attach_flag)
{
if (dbb->dbb_flags & DBB_bugcheck)
{
status_exception::raise(Arg::Gds(isc_bug_check) << "can't attach after bugcheck");
}
initGuard.linkWith(dbb->dbb_init_fini);
{ // scope
MutexUnlockGuard listUnlock(databases_mutex, FB_FUNCTION);
fb_assert(!databases_mutex->locked());
// after unlocking databases_mutex we lose control over dbb
// as long as dbb_init_fini is not locked and its activity is not checked
initGuard.enter();
if (initGuard->doesExist())
{
Sync dbbGuard(&dbb->dbb_sync, FB_FUNCTION);
dbbGuard.lock(SYNC_EXCLUSIVE);
fb_assert(!(dbb->dbb_flags & DBB_new));
tdbb->setDatabase(dbb);
jAtt = create_attachment(alias_name, dbb, provider, options, !attach_flag);
if (dbb->dbb_linger_timer)
dbb->dbb_linger_timer->reset();
tdbb->setAttachment(jAtt->getHandle());
if (options.dpb_config.hasData())
{
ERR_post_warning(Arg::Warning(isc_random) <<
"Secondary attachment - config data from DPB ignored");
}
return jAtt;
}
}
// If we reached this point this means that found dbb was removed
// Forget about it and repeat search
initGuard.unlinkFromMutex();
dbb = databases;
continue;
}
ERR_post(Arg::Gds(isc_no_meta_update) <<
Arg::Gds(isc_obj_in_use) << Arg::Str("DATABASE"));
}
dbb = dbb->dbb_next;
}
}
Config::merge(config, &options.dpb_config);
dbb = Database::create(pConf, shared);
dbb->dbb_config = config;
dbb->dbb_filename = expanded_name;
dbb->dbb_callback = provider->getCryptCallback();
#ifdef HAVE_ID_BY_NAME
dbb->dbb_id = db_id; // will be reassigned in create database after PIO operation
#endif
// safely take init lock on just created database
initGuard.linkWith(dbb->dbb_init_fini);
initGuard.enter();
dbb->dbb_next = databases;
databases = dbb;
dbb->dbb_flags |= (DBB_exclusive | DBB_new | options.dpb_flags);
if (!attach_flag)
dbb->dbb_flags |= DBB_creating;
dbb->dbb_sweep_interval = SWEEP_INTERVAL;
Sync dbbGuard(&dbb->dbb_sync, FB_FUNCTION);
dbbGuard.lock(SYNC_EXCLUSIVE);
tdbb->setDatabase(dbb);
// now it's time to create DB objects that need MetaName
dbb->dbb_extManager = FB_NEW_POOL(*dbb->dbb_permanent) ExtEngineManager(*dbb->dbb_permanent);
jAtt = create_attachment(alias_name, dbb, provider, options, !attach_flag);
tdbb->setAttachment(jAtt->getHandle());
} // end scope
// provide context pool for the rest stuff
Jrd::ContextPoolHolder context(tdbb, dbb->dbb_permanent);
// set a garbage collection policy
if ((dbb->dbb_flags & (DBB_gc_cooperative | DBB_gc_background)) == 0)
{
if (dbb->dbb_flags & DBB_shared)
{
string gc_policy = dbb->dbb_config->getGCPolicy();
gc_policy.lower();
if (gc_policy == GCPolicyCooperative)
dbb->dbb_flags |= DBB_gc_cooperative;
else if (gc_policy == GCPolicyBackground)
dbb->dbb_flags |= DBB_gc_background;
else if (gc_policy == GCPolicyCombined)
dbb->dbb_flags |= DBB_gc_cooperative | DBB_gc_background;
else // config value is invalid
{
// this should not happen - means bug in config
fb_assert(false);
}
}
else
dbb->dbb_flags |= DBB_gc_cooperative;
}
return jAtt;
}
static JAttachment* create_attachment(const PathName& alias_name,
Database* dbb,
JProvider* provider,
const DatabaseOptions& options,
bool newDb)
{
/**************************************
*
* c r e a t e _ a t t a c h m e n t
*
**************************************
*
* Functional description
* Create attachment and link it to dbb
*
**************************************/
fb_assert(dbb->locked());
Attachment* attachment = NULL;
{ // scope
MutexLockGuard guard(newAttachmentMutex, FB_FUNCTION);
if (engineShutdown)
{
status_exception::raise(Arg::Gds(isc_att_shutdown));
}
attachment = Attachment::create(dbb, provider);
attachment->att_next = dbb->dbb_attachments;
dbb->dbb_attachments = attachment;
}
attachment->att_filename = alias_name;
attachment->att_network_protocol = options.dpb_network_protocol;
attachment->att_remote_crypt = options.dpb_remote_crypt;
attachment->att_remote_address = options.dpb_remote_address;
attachment->att_remote_pid = options.dpb_remote_pid;
attachment->att_remote_flags = options.dpb_remote_flags;
attachment->att_remote_process = options.dpb_remote_process;
attachment->att_remote_host = options.dpb_remote_host;
attachment->att_remote_os_user = options.dpb_remote_os_user;
attachment->att_client_version = options.dpb_client_version;
attachment->att_remote_protocol = options.dpb_remote_protocol;
attachment->att_ext_call_depth = options.dpb_ext_call_depth;
StableAttachmentPart* sAtt = FB_NEW StableAttachmentPart(attachment);
attachment->setStable(sAtt);
sAtt->addRef();
JAttachment* jAtt = NULL;
try
{
sAtt->manualLock(attachment->att_flags);
jAtt = FB_NEW JAttachment(sAtt);
}
catch (const Exception&)
{
sAtt->release();
throw;
}
jAtt->addRef(); // See also REF_NO_INCR RefPtr in unwindAttach()
sAtt->setInterface(jAtt);
if (newDb)
attachment->att_flags |= ATT_creator;
return jAtt;
}
static void check_single_maintenance(thread_db* tdbb)
{
UCHAR spare_memory[RAW_HEADER_SIZE + PAGE_ALIGNMENT];
UCHAR* header_page_buffer = FB_ALIGN(spare_memory, PAGE_ALIGNMENT);
Ods::header_page* const header_page = reinterpret_cast<Ods::header_page*>(header_page_buffer);
PIO_header(tdbb, header_page_buffer, RAW_HEADER_SIZE);
if ((header_page->hdr_flags & Ods::hdr_shutdown_mask) == Ods::hdr_shutdown_single)
{
ERR_post(Arg::Gds(isc_shutdown) << Arg::Str(tdbb->getAttachment()->att_filename));
}
}
static void init_database_lock(thread_db* tdbb)
{
/**************************************
*
* i n i t _ d a t a b a s e _ l o c k
*
**************************************
*
* Functional description
* Initialize the main database lock.
*
**************************************/
SET_TDBB(tdbb);
Database* const dbb = tdbb->getDatabase();
// Main database lock
Lock* const lock = FB_NEW_RPT(*dbb->dbb_permanent, 0)
Lock(tdbb, 0, LCK_database, dbb, CCH_down_grade_dbb);
dbb->dbb_lock = lock;
// Try to get an exclusive lock on database.
// If this fails, insist on at least a shared lock.
dbb->dbb_flags |= DBB_exclusive;
if (!LCK_lock(tdbb, lock, LCK_EX, LCK_NO_WAIT))
{
// Clean status vector from lock manager error code
fb_utils::init_status(tdbb->tdbb_status_vector);
dbb->dbb_flags &= ~DBB_exclusive;
while (!LCK_lock(tdbb, lock, LCK_SW, -1))
{
fb_utils::init_status(tdbb->tdbb_status_vector);
// If we are in a single-threaded maintenance mode then clean up and stop waiting
check_single_maintenance(tdbb);
}
}
}
static void prepare_tra(thread_db* tdbb, jrd_tra* transaction, USHORT length, const UCHAR* msg)
{
/**************************************
*
* p r e p a r e
*
**************************************
*
* Functional description
* Attempt to prepare a transaction.
*
**************************************/
SET_TDBB(tdbb);
if (transaction->tra_in_use)
status_exception::raise(Arg::Gds(isc_transaction_in_use));
if (!(transaction->tra_flags & TRA_prepared))
{
// run ON TRANSACTION COMMIT triggers
run_commit_triggers(tdbb, transaction);
}
validateHandle(tdbb, transaction->tra_attachment);
tdbb->setTransaction(transaction);
TRA_prepare(tdbb, transaction, length, msg);
}
void release_attachment(thread_db* tdbb, Jrd::Attachment* attachment)
{
/**************************************
*
* r e l e a s e _ a t t a c h m e n t
*
**************************************
*
* Functional description
* Disconnect attachment block from database block.
*
**************************************/
SET_TDBB(tdbb);
Database* dbb = tdbb->getDatabase();
CHECK_DBB(dbb);
fb_assert(!dbb->locked());
if (!attachment)
return;
attachment->att_replicator = nullptr;
if (attachment->att_dsql_instance)
attachment->att_dsql_instance->dbb_statement_cache->purge(tdbb);
while (attachment->att_repl_appliers.hasData())
{
AutoPtr<Applier> cleanupApplier(attachment->att_repl_appliers.pop());
cleanupApplier->shutdown(tdbb);
}
if (dbb->dbb_crypto_manager)
dbb->dbb_crypto_manager->detach(tdbb, attachment);
Monitoring::cleanupAttachment(tdbb);
dbb->dbb_extManager->closeAttachment(tdbb, attachment);
if (dbb->dbb_config->getServerMode() == MODE_SUPER)
attachment->releaseGTTs(tdbb);
if (attachment->att_event_session)
dbb->eventManager()->deleteSession(attachment->att_event_session);
// CMP_release() changes att_requests.
while (attachment->att_requests.hasData())
CMP_release(tdbb, attachment->att_requests.back());
MET_clear_cache(tdbb);
attachment->releaseLocks(tdbb);
// Shut down any extern relations
attachment->releaseRelations(tdbb);
// Release any validation error vector allocated
delete attachment->att_validation;
attachment->att_validation = NULL;
attachment->destroyIntlObjects(tdbb);
attachment->detachLocks();
LCK_fini(tdbb, LCK_OWNER_attachment);
delete attachment->att_compatibility_table;
if (attachment->att_dsql_instance)
{
MemoryPool* const pool = &attachment->att_dsql_instance->dbb_pool;
delete attachment->att_dsql_instance;
attachment->deletePool(pool);
}
attachment->mergeStats();
Sync sync(&dbb->dbb_sync, "jrd.cpp: release_attachment");
// avoid races with special threads
XThreadEnsureUnlock threadGuard(dbb->dbb_thread_mutex, FB_FUNCTION);
threadGuard.enter();
sync.lock(SYNC_EXCLUSIVE);
// stop special threads if and only if we release last regular attachment
bool other = false;
{ // checkout scope
EngineCheckout checkout(tdbb, FB_FUNCTION);
SPTHR_DEBUG(fprintf(stderr, "\nrelease attachment=%p\n", attachment));
for (Jrd::Attachment* att = dbb->dbb_attachments; att; att = att->att_next)
{
SPTHR_DEBUG(fprintf(stderr, "att=%p FromThr=%c ", att, att->att_flags & ATT_from_thread ? '1' : '0'));
if (att == attachment)
{
SPTHR_DEBUG(fprintf(stderr, "self\n"));
continue;
}
if (att->att_flags & ATT_from_thread)
{
SPTHR_DEBUG(fprintf(stderr, "found special att=%p\n", att));
continue;
}
// Found attachment that is not current (to be released) and is not special
other = true;
SPTHR_DEBUG(fprintf(stderr, "other\n"));
break;
}
// Notify special threads
threadGuard.leave();
// Sync with special threads
if (!other)
{
sync.unlock();
// crypt thread
if (dbb->dbb_crypto_manager)
dbb->dbb_crypto_manager->terminateCryptThread(tdbb, true);
}
} // EngineCheckout scope
// restore database lock if needed
if (!other)
sync.lock(SYNC_EXCLUSIVE);
// remove the attachment block from the dbb linked list
for (Jrd::Attachment** ptr = &dbb->dbb_attachments; *ptr; ptr = &(*ptr)->att_next)
{
if (*ptr == attachment)
{
*ptr = attachment->att_next;
break;
}
}
SCL_release_all(attachment->att_security_classes);
delete attachment->att_user;
{
jrd_tra* next = NULL;
for (jrd_tra* tran = attachment->att_transactions; tran; tran = next)
{
next = tran->tra_next;
jrd_tra::destroy(attachment, tran);
}
}
tdbb->setAttachment(NULL);
Jrd::Attachment::destroy(attachment);
}
static void rollback(thread_db* tdbb, jrd_tra* transaction, const bool retaining_flag)
{
/**************************************
*
* r o l l b a c k
*
**************************************
*
* Functional description
* Abort a transaction.
*
**************************************/
if (transaction->tra_in_use)
Arg::Gds(isc_transaction_in_use).raise();
ThreadStatusGuard tempStatus(tdbb);
const Database* const dbb = tdbb->getDatabase();
const Jrd::Attachment* const attachment = tdbb->getAttachment();
if (!(attachment->att_flags & ATT_no_db_triggers))
{
try
{
ThreadStatusGuard tempStatus2(tdbb);
// run ON TRANSACTION ROLLBACK triggers
EXE_execute_db_triggers(tdbb, transaction, TRIGGER_TRANS_ROLLBACK);
}
catch (const Exception&)
{
if (dbb->dbb_flags & DBB_bugcheck)
throw;
}
}
tdbb->setTransaction(transaction);
TRA_rollback(tdbb, transaction, retaining_flag, false);
}
static void setEngineReleaseDelay(Database* dbb)
{
if (!dbb->dbb_plugin_config)
return;
unsigned maxLinger = 0;
{ // scope
MutexLockGuard listGuardForLinger(databases_mutex, FB_FUNCTION);
for (Database* d = databases; d; d = d->dbb_next)
{
if (!d->dbb_attachments && (d->dbb_linger_end > maxLinger))
maxLinger = d->dbb_linger_end;
}
}
++maxLinger; // avoid rounding errors
time_t t = time(NULL);
FbLocalStatus s;
dbb->dbb_plugin_config->setReleaseDelay(&s, maxLinger > t ? (maxLinger - t) * 1000 * 1000 : 0);
check(&s);
}
bool JRD_shutdown_database(Database* dbb, const unsigned flags)
{
/*************************************************
*
* J R D _ s h u t d o w n _ d a t a b a s e
*
*************************************************
*
* Functional description
* Shutdown physical database environment.
*
**************************************/
ThreadContextHolder tdbb(dbb, NULL);
RefMutexUnlock finiGuard;
{ // scope
fb_assert((flags & SHUT_DBB_OVERWRITE_CHECK) || (!databases_mutex->locked()));
MutexLockGuard listGuard1(databases_mutex, FB_FUNCTION);
Database** d_ptr;
for (d_ptr = &databases; *d_ptr; d_ptr = &(*d_ptr)->dbb_next)
{
if (*d_ptr == dbb)
{
finiGuard.linkWith(dbb->dbb_init_fini);
{ // scope
MutexUnlockGuard listUnlock(databases_mutex, FB_FUNCTION);
// after unlocking databases_mutex we lose control over dbb
// as long as dbb_init_fini is not locked and its activity is not checked
finiGuard.enter();
if (finiGuard->doesExist())
break;
// database to shutdown does not exist
// looks like somebody else took care to destroy it
return false;
}
}
}
// Check - may be database already missing in linked list
if (!finiGuard)
return false;
}
{
SyncLockGuard dsGuard(&dbb->dbb_sync, SYNC_EXCLUSIVE, FB_FUNCTION);
if (dbb->dbb_attachments)
return false;
}
// Database linger
if ((flags & SHUT_DBB_LINGER) &&
(!(engineShutdown || (dbb->dbb_ast_flags & DBB_shutdown))) &&
(dbb->dbb_linger_seconds > 0) &&
(dbb->dbb_config->getServerMode() != MODE_CLASSIC) &&
(dbb->dbb_flags & DBB_shared))
{
if (!dbb->dbb_linger_timer)
dbb->dbb_linger_timer = FB_NEW Database::Linger(dbb);
dbb->dbb_linger_end = time(NULL) + dbb->dbb_linger_seconds;
dbb->dbb_linger_timer->set(dbb->dbb_linger_seconds);
setEngineReleaseDelay(dbb);
return false;
}
// Reset provider unload delay if needed
dbb->dbb_linger_end = 0;
setEngineReleaseDelay(dbb);
// Deactivate dbb_init_fini lock
// Since that moment dbb becomes not reusable
dbb->dbb_init_fini->destroy();
fb_assert(!dbb->locked());
try
{
#ifdef SUPERSERVER_V2
TRA_header_write(tdbb, dbb, 0); // Update transaction info on header page.
#endif
if (flags & SHUT_DBB_RELEASE_POOLS)
TRA_update_counters(tdbb, dbb);
}
catch (const Exception&)
{
// Swallow exception raised from the physical I/O layer
// (e.g. due to database file being inaccessible).
// User attachment is already destroyed, so there's no chance
// this dbb can be cleaned up after raising an exception.
}
// Disable AST delivery as we're about to release all locks
{ // scope
WriteLockGuard astGuard(dbb->dbb_ast_lock, FB_FUNCTION);
dbb->dbb_flags |= DBB_no_ast;
}
// Shutdown file and/or remote connection
VIO_fini(tdbb);
CCH_shutdown(tdbb);
if (dbb->dbb_tip_cache)
dbb->dbb_tip_cache->finalizeTpc(tdbb);
if (dbb->dbb_backup_manager)
dbb->dbb_backup_manager->shutdown(tdbb);
if (dbb->dbb_crypto_manager)
dbb->dbb_crypto_manager->shutdown(tdbb);
if (dbb->dbb_repl_lock)
LCK_release(tdbb, dbb->dbb_repl_lock);
if (dbb->dbb_shadow_lock)
LCK_release(tdbb, dbb->dbb_shadow_lock);
if (dbb->dbb_retaining_lock)
LCK_release(tdbb, dbb->dbb_retaining_lock);
if (dbb->dbb_sweep_lock)
LCK_release(tdbb, dbb->dbb_sweep_lock);
if (dbb->dbb_lock)
LCK_release(tdbb, dbb->dbb_lock);
delete dbb->dbb_crypto_manager;
dbb->dbb_crypto_manager = NULL;
LCK_fini(tdbb, LCK_OWNER_database);
CCH_fini(tdbb);
{ // scope
MutexLockGuard listGuard2(databases_mutex, FB_FUNCTION);
Database** d_ptr;
for (d_ptr = &databases; *d_ptr; d_ptr = &(*d_ptr)->dbb_next)
{
if (*d_ptr == dbb)
{
fb_assert(!dbb->dbb_attachments);
*d_ptr = dbb->dbb_next;
dbb->dbb_next = NULL;
break;
}
}
}
if (flags & SHUT_DBB_RELEASE_POOLS)
{
tdbb->setDatabase(NULL);
Database::destroy(dbb);
}
return true;
}
void JRD_enum_attachments(PathNameList* dbList, ULONG& atts, ULONG& dbs, ULONG& svcs)
{
/**************************************
*
* J R D _ e n u m _ a t t a c h m e n t s
*
**************************************
*
* Functional description
* Count the number of active databases and
* attachments.
*
**************************************/
atts = dbs = svcs = 0;
try
{
PathNameList dbFiles(*getDefaultMemoryPool());
MutexLockGuard guard(databases_mutex, FB_FUNCTION);
// Zip through the list of databases and count the number of local
// connections. If buf is not NULL then copy all the database names
// that will fit into it.
for (Database* dbb = databases; dbb; dbb = dbb->dbb_next)
{
SyncLockGuard dbbGuard(&dbb->dbb_sync, SYNC_SHARED, "JRD_enum_attachments");
if (!(dbb->dbb_flags & DBB_bugcheck))
{
bool found = false; // look for user attachments only
for (const Jrd::Attachment* attach = dbb->dbb_attachments; attach;
attach = attach->att_next)
{
if (!(attach->att_flags & ATT_security_db))
{
atts++;
found = true;
}
}
if (found && !dbFiles.exist(dbb->dbb_filename))
dbFiles.add(dbb->dbb_filename);
}
}
dbs = (ULONG) dbFiles.getCount();
svcs = Service::totalCount();
if (dbList)
{
*dbList = dbFiles;
}
}
catch (const Exception&)
{
// Here we ignore possible errors from databases_mutex.
// They were always silently ignored, and for this function
// we really have no way to notify world about mutex problem.
// AP. 2008.
}
}
void JTransaction::freeEngineData(CheckStatusWrapper* user_status)
{
/**************************************
*
* f r e e E n g i n e D a t a
*
**************************************
*
* Functional description
* Release or rollback transaction depending upon prepared it or not.
*
**************************************/
try
{
EngineContextHolder tdbb(user_status, this, FB_FUNCTION);
check_database(tdbb, true);
try
{
if (transaction->tra_flags & TRA_prepared)
{
TraceTransactionEnd trace(transaction, false, false);
EDS::Transaction::jrdTransactionEnd(tdbb, transaction, false, false, false);
TRA_release_transaction(tdbb, transaction, &trace);
}
else
TRA_rollback(tdbb, transaction, false, true);
transaction = NULL;
}
catch (const Exception& ex)
{
transliterateException(tdbb, ex, user_status, "JTransaction::freeEngineData");
return;
}
}
catch (const Exception& ex)
{
transaction = NULL;
ex.stuffException(user_status);
return;
}
successful_completion(user_status);
}
static void purge_transactions(thread_db* tdbb, Jrd::Attachment* attachment, const bool force_flag)
{
/**************************************
*
* p u r g e _ t r a n s a c t i o n s
*
**************************************
*
* Functional description
* commit or rollback all transactions
* from an attachment
*
**************************************/
jrd_tra* const trans_dbk = attachment->att_dbkey_trans;
if (force_flag)
{
for (auto applier : attachment->att_repl_appliers)
applier->cleanupTransactions(tdbb);
}
unsigned int count = 0;
jrd_tra* next;
for (jrd_tra* transaction = attachment->att_transactions; transaction; transaction = next)
{
next = transaction->tra_next;
if (transaction != trans_dbk)
{
if (transaction->tra_flags & TRA_prepared)
{
TraceTransactionEnd trace(transaction, false, false); // need ability to indicate prepared (in limbo) transaction
EDS::Transaction::jrdTransactionEnd(tdbb, transaction, false, false, true);
TRA_release_transaction(tdbb, transaction, &trace);
}
else if (force_flag)
TRA_rollback(tdbb, transaction, false, true);
else
++count;
}
}
if (count)
{
ERR_post(Arg::Gds(isc_open_trans) << Arg::Num(count));
}
// If there's a side transaction for db-key scope, get rid of it
if (trans_dbk)
{
attachment->att_dbkey_trans = NULL;
TRA_commit(tdbb, trans_dbk, false);
}
}
static void purge_attachment(thread_db* tdbb, StableAttachmentPart* sAtt, unsigned flags)
{
/**************************************
*
* p u r g e _ a t t a c h m e n t
*
**************************************
*
* Functional description
* Zap an attachment, shutting down the database
* if it is the last one.
*
**************************************/
SET_TDBB(tdbb);
StableAttachmentPart::Sync* const attSync = sAtt->getSync();
fb_assert(attSync->locked());
Jrd::Attachment* attachment = sAtt->getHandle();
if (attachment && attachment->att_purge_tid == Thread::getId())
{
fb_assert(false); // recursive call - impossible ?
return;
}
while (attachment && attachment->att_purge_tid)
{
attachment->att_use_count--;
{ // scope
AttSyncUnlockGuard cout(*attSync, FB_FUNCTION);
// !!!!!!!!!!!!!!!!! - event? semaphore? condvar? (when ATT_purge_started / sAtt->getHandle() changes)
fb_assert(!attSync->locked());
Thread::yield();
Thread::sleep(1);
}
attachment = sAtt->getHandle();
if (attachment)
attachment->att_use_count++;
}
if (!attachment)
return;
fb_assert(attachment->att_flags & ATT_shutdown);
attachment->att_purge_tid = Thread::getId();
fb_assert(attachment->att_use_count > 0);
attachment = sAtt->getHandle();
while (attachment && attachment->att_use_count > 1)
{
attachment->att_use_count--;
{ // scope
AttSyncUnlockGuard cout(*attSync, FB_FUNCTION);
// !!!!!!!!!!!!!!!!! - event? semaphore? condvar? (when --att_use_count)
fb_assert(!attSync->locked());
Thread::yield();
Thread::sleep(1);
}
attachment = sAtt->getHandle();
if (attachment)
attachment->att_use_count++;
}
fb_assert(attSync->locked());
if (!attachment)
return;
Database* const dbb = attachment->att_database;
const bool forcedPurge = (flags & PURGE_FORCE);
const bool nocheckPurge = (flags & (PURGE_FORCE | PURGE_NOCHECK));
tdbb->tdbb_flags |= TDBB_detaching;
if (!(dbb->dbb_flags & DBB_bugcheck))
{
try
{
const TrigVector* const trig_disconnect =
attachment->att_triggers[DB_TRIGGER_DISCONNECT];
if (!forcedPurge &&
!(attachment->att_flags & ATT_no_db_triggers) &&
trig_disconnect && !trig_disconnect->isEmpty())
{
ThreadStatusGuard temp_status(tdbb);
jrd_tra* transaction = NULL;
const ULONG save_flags = attachment->att_flags;
try
{
// Start a transaction to execute ON DISCONNECT triggers.
// Ensure this transaction can't trigger auto-sweep.
attachment->att_flags |= ATT_no_cleanup;
transaction = TRA_start(tdbb, 0, NULL);
attachment->att_flags = save_flags;
// run ON DISCONNECT triggers
EXE_execute_db_triggers(tdbb, transaction, TRIGGER_DISCONNECT);
// and commit the transaction
TRA_commit(tdbb, transaction, false);
}
catch (const Exception& ex)
{
attachment->att_flags = save_flags;
string s;
s.printf("Database: %s\n\tError at disconnect:", attachment->att_filename.c_str());
iscLogException(s.c_str(), ex);
if (dbb->dbb_flags & DBB_bugcheck)
throw;
try
{
if (transaction)
TRA_rollback(tdbb, transaction, false, false);
}
catch (const Exception&)
{
if (dbb->dbb_flags & DBB_bugcheck)
throw;
}
}
}
}
catch (const Exception&)
{
if (!nocheckPurge)
{
attachment->att_purge_tid = 0;
throw;
}
}
}
try
{
// allow to free resources used by dynamic statements
EDS::Manager::jrdAttachmentEnd(tdbb, attachment, forcedPurge);
if (!(dbb->dbb_flags & DBB_bugcheck))
{
// Check for any pending transactions
purge_transactions(tdbb, attachment, nocheckPurge);
}
}
catch (const Exception&)
{
if (!nocheckPurge)
{
attachment->att_purge_tid = 0;
throw;
}
}
// stop crypt thread using this attachment
dbb->dbb_crypto_manager->stopThreadUsing(tdbb, attachment);
// Notify Trace API manager about disconnect
if (attachment->att_trace_manager->needs(ITraceFactory::TRACE_EVENT_DETACH))
{
TraceConnectionImpl conn(attachment);
attachment->att_trace_manager->event_detach(&conn, false);
}
fb_assert(attSync->locked());
StableAttachmentPart::Sync* attAsync = sAtt->getSync(true, true);
EnsureUnlock<StableAttachmentPart::Sync, NotRefCounted> asyncGuard(*attAsync, FB_FUNCTION);
{ // scope - ensure correct order of taking both async and main mutexes
AttSyncUnlockGuard cout(*attSync, FB_FUNCTION);
fb_assert(!attSync->locked());
asyncGuard.enter();
}
if (!sAtt->getHandle())
return;
unsigned shutdownFlags = SHUT_DBB_RELEASE_POOLS;
if (flags & PURGE_LINGER)
shutdownFlags |= SHUT_DBB_LINGER;
if (attachment->att_flags & ATT_overwrite_check)
shutdownFlags |= SHUT_DBB_OVERWRITE_CHECK;
// Unlink attachment from database
release_attachment(tdbb, attachment);
asyncGuard.leave();
AttSyncUnlockGuard cout(*attSync, FB_FUNCTION);
MutexUnlockGuard coutBlocking(*sAtt->getBlockingMutex(), FB_FUNCTION);
// Try to close database if there are no attachments
JRD_shutdown_database(dbb, shutdownFlags);
}
static void run_commit_triggers(thread_db* tdbb, jrd_tra* transaction)
{
/**************************************
*
* r u n _ c o m m i t _ t r i g g e r s
*
**************************************
*
* Functional description
* Run ON TRANSACTION COMMIT triggers of a transaction.
*
**************************************/
SET_TDBB(tdbb);
if (transaction->tra_flags & TRA_system)
return;
// start a savepoint to rollback changes of all triggers
AutoSavePoint savePoint(tdbb, transaction);
// run ON TRANSACTION COMMIT triggers
EXE_execute_db_triggers(tdbb, transaction, TRIGGER_TRANS_COMMIT);
savePoint.release();
}
// verify_request_synchronization
//
// @brief Finds the sub-requests at the given level and replaces it with the
// original passed request (note the pointer by reference). If that specific
// sub-request is not found, throw the dreaded "request synchronization error".
// Notice that at this time, the calling function's "request" pointer has been
// set to null, so remember that if you write a debugging routine.
// This function replaced a chunk of code repeated four times.
//
// @param request The incoming, parent request to be replaced.
// @param level The level of the sub-request we need to find.
static Request* verify_request_synchronization(Statement* statement, USHORT level)
{
if (level)
{
if (level >= statement->requests.getCount() || !statement->requests[level])
ERR_post(Arg::Gds(isc_req_sync));
}
return statement->requests[level];
}
/**
verifyDatabaseName
@brief Verify database name for open/create
against given in conf file list of available directories
and security database name
@param name
@param status
**/
static VdnResult verifyDatabaseName(const PathName& name, FbStatusVector* status, bool is_alias)
{
// Check for securityX.fdb
static GlobalPtr<PathName> securityNameBuffer, expandedSecurityNameBuffer;
static GlobalPtr<Mutex> mutex;
MutexLockGuard guard(mutex, FB_FUNCTION);
if (!securityNameBuffer->hasData())
{
const RefPtr<const Config> defConf(Config::getDefaultConfig());
securityNameBuffer->assign(defConf->getSecurityDatabase());
expandedSecurityNameBuffer->assign(securityNameBuffer);
ISC_expand_filename(expandedSecurityNameBuffer, false);
}
if (name == securityNameBuffer || name == expandedSecurityNameBuffer)
return VDN_OK;
// Check for .conf
if (!JRD_verify_database_access(name))
{
if (!is_alias) {
ERR_build_status(status, Arg::Gds(isc_conf_access_denied) << Arg::Str("database") <<
Arg::Str(name));
}
return VDN_FAIL;
}
return VDN_OK;
}
/**
getUserInfo
@brief Fills UserId structure with resulting values.
Takes into an account mapping of users and groups.
@param user
@param options
@param aliasName
@param dbName
@param config
@param creating
@param iAtt
@param cryptCb
**/
static void getUserInfo(UserId& user, const DatabaseOptions& options, const char* aliasName,
const RefPtr<const Config>* config, bool creating, Mapping& mapping, bool icuReset)
{
bool wheel = false;
int id = -1, group = -1; // CVC: This var contained trash
string name, trusted_role, auth_method;
if (fb_utils::bootBuild())
{
auth_method = "bootBuild";
wheel = true;
}
else
{
auth_method = "User name in DPB";
if (options.dpb_trusted_login.hasData())
{
name = options.dpb_trusted_login;
fb_utils::dpbItemUpper(name);
}
else if (options.dpb_user_name.hasData())
{
name = options.dpb_user_name;
fb_utils::dpbItemUpper(name);
}
else if (options.dpb_auth_block.hasData())
{
mapping.needAuthMethod(auth_method);
mapping.needAuthBlock(user.usr_auth_block);
if (mapping.mapUser(name, trusted_role) & Mapping::MAP_DOWN)
user.setFlag(USR_mapdown);
if (creating && config) // when config is NULL we are in error handler
{
if (!checkCreateDatabaseGrant(name, trusted_role, options.dpb_role_name, (*config)->getSecurityDatabase()))
(Arg::Gds(isc_no_priv) << "CREATE" << "DATABASE" << aliasName).raise();
}
}
else
{
auth_method = "OS user name";
wheel = ISC_get_user(&name, &id, &group);
ISC_systemToUtf8(name);
fb_utils::dpbItemUpper(name);
if (wheel || id == 0)
{
auth_method = "OS user name / wheel";
wheel = true;
}
}
// if the name from the user database is defined as SYSDBA,
// we define that user id as having system privileges
if (name == DBA_USER_NAME)
{
wheel = true;
}
}
// In case we became WHEEL on an OS that didn't require name SYSDBA,
// (Like Unix) force the effective Database User name to be SYSDBA
if (wheel)
{
name = DBA_USER_NAME;
if (icuReset)
user.setFlag(USR_sysdba);
}
if (name.length() > USERNAME_LENGTH)
{
status_exception::raise(Arg::Gds(isc_long_login) << Arg::Num(name.length())
<< Arg::Num(USERNAME_LENGTH));
}
user.setUserName(name);
user.usr_project_name = "";
user.usr_org_name = "";
user.usr_auth_method = auth_method;
user.usr_user_id = id;
user.usr_group_id = group;
if (trusted_role.hasData())
{
user.setTrustedRole(trusted_role);
}
if (options.dpb_role_name.hasData())
{
user.setSqlRole(options.dpb_role_name.c_str());
}
}
static void unwindAttach(thread_db* tdbb, const Exception& ex, FbStatusVector* userStatus, bool internalFlag)
{
transliterateException(tdbb, ex, userStatus, NULL);
try
{
const auto dbb = tdbb->getDatabase();
if (dbb)
{
fb_assert(!dbb->locked());
ThreadStatusGuard temp_status(tdbb);
const auto attachment = tdbb->getAttachment();
if (attachment)
{
// A number of holders to make Attachment::destroy() happy
// StablePart will be released in JAttachment::release
RefPtr<StableAttachmentPart> sAtt(attachment->getStable());
// Will release addRef() addedin create_attachment()
RefPtr<JAttachment> jAtt(REF_NO_INCR, sAtt->getInterface());
// This unlocking/locking order guarantees stable release of attachment
sAtt->manualUnlock(attachment->att_flags);
ULONG flags = 0; // att_flags may already not exist here!
sAtt->manualLock(flags);
if (sAtt->getHandle())
{
attachment->att_flags |= flags;
release_attachment(tdbb, attachment);
}
else
{
sAtt->manualUnlock(flags);
}
}
JRD_shutdown_database(dbb, SHUT_DBB_RELEASE_POOLS |
(internalFlag ? SHUT_DBB_OVERWRITE_CHECK : 0));
}
}
catch (const Exception&)
{
// no-op
}
return;
}
namespace
{
bool shutdownAttachments(AttachmentsRefHolder* arg, ISC_STATUS signal)
{
AutoPtr<AttachmentsRefHolder> queue(arg);
AttachmentsRefHolder& attachments = *arg;
bool success = true;
if (signal)
{
// Set terminate flag for all attachments
for (AttachmentsRefHolder::Iterator iter(attachments); *iter; ++iter)
{
StableAttachmentPart* const sAtt = *iter;
AttSyncLockGuard guard(*(sAtt->getSync(true)), FB_FUNCTION);
Attachment* attachment = sAtt->getHandle();
if (attachment)
attachment->signalShutdown(signal);
}
}
// Purge all attachments
for (AttachmentsRefHolder::Iterator iter(attachments); *iter; ++iter)
{
StableAttachmentPart* const sAtt = *iter;
MutexLockGuard guardBlocking(*(sAtt->getBlockingMutex()), FB_FUNCTION);
AttSyncLockGuard guard(*(sAtt->getSync()), FB_FUNCTION);
Attachment* attachment = sAtt->getHandle();
if (attachment)
{
ThreadContextHolder tdbb;
tdbb->setAttachment(attachment);
tdbb->setDatabase(attachment->att_database);
try
{
// purge attachment, rollback any open transactions
attachment->att_use_count++;
purge_attachment(tdbb, sAtt, PURGE_FORCE);
}
catch (const Exception& ex)
{
iscLogException("error while shutting down attachment", ex);
success = false;
}
attachment = sAtt->getHandle();
if (attachment)
attachment->att_use_count--;
}
}
return success;
}
THREAD_ENTRY_DECLARE attachmentShutdownThread(THREAD_ENTRY_PARAM arg)
{
#ifdef WIN_NT
ThreadModuleRef thdRef(attachmentShutdownThread, &engineShutdown);
#endif
try
{
MutexLockGuard guard(shutdownMutex, FB_FUNCTION);
if (engineShutdown)
{
// Shutdown was done, all attachmnets are gone
return 0;
}
shutdownAttachments(static_cast<AttachmentsRefHolder*>(arg), isc_att_shut_db_down);
}
catch (const Exception& ex)
{
iscLogException("attachmentShutdownThread", ex);
}
return 0;
}
} // anonymous namespace
static void waitForShutdown(Semaphore& shutdown_semaphore)
{
const int pid = getpid();
unsigned int timeout = 10000; // initial value, 10 sec
bool done = false;
for (int i = 0; i < 5; i++)
{
gds__log("PID %d: engine shutdown is in progress with %s database(s) attached",
pid, databases == NULL ? "no" : "some");
timeout *= 2;
if (shutdown_semaphore.tryEnter(timeout))
{
done = true;
break;
}
}
if (!done)
{
if (databases == NULL)
{
gds__log("PID %d: wait for engine shutdown failed, terminating", pid);
if (Config::getBugcheckAbort())
abort();
// return immediately
_exit(5);
}
shutdown_semaphore.enter();
}
}
static THREAD_ENTRY_DECLARE shutdown_thread(THREAD_ENTRY_PARAM arg)
{
/**************************************
*
* s h u t d o w n _ t h r e a d
*
**************************************
*
* Functional description
* Shutdown the engine.
*
**************************************/
Semaphore* const semaphore = static_cast<Semaphore*>(arg);
bool success = true;
MemoryPool& pool = *getDefaultMemoryPool();
AttachmentsRefHolder* const attachments = FB_NEW_POOL(pool) AttachmentsRefHolder(pool);
try
{
{ // scope
MutexLockGuard guard(databases_mutex, FB_FUNCTION);
for (Database* dbb = databases; dbb; dbb = dbb->dbb_next)
{
if (!(dbb->dbb_flags & DBB_bugcheck))
{
Sync dbbGuard(&dbb->dbb_sync, FB_FUNCTION);
dbbGuard.lock(SYNC_EXCLUSIVE);
for (Attachment* att = dbb->dbb_attachments; att; att = att->att_next)
attachments->add(att->getStable());
}
}
// No need in databases_mutex any more
}
// Shutdown existing attachments
success = success && shutdownAttachments(attachments, isc_att_shut_engine);
HalfStaticArray<Database*, 32> dbArray(pool);
{ // scope
MutexLockGuard guard(databases_mutex, FB_FUNCTION);
for (Database* dbb = databases; dbb; dbb = dbb->dbb_next)
dbArray.push(dbb);
// No need in databases_mutex any more
}
for (unsigned n = 0; n < dbArray.getCount(); ++n)
JRD_shutdown_database(dbArray[n], SHUT_DBB_RELEASE_POOLS);
// Extra shutdown operations
Service::shutdownServices();
TRA_shutdown_sweep();
}
catch (const Exception& ex)
{
success = false;
iscLogException("Error at shutdown_thread", ex);
}
if (success && semaphore)
semaphore->release();
return 0;
}
/// TimeoutTimer
#ifdef USE_ITIMER
void TimeoutTimer::handler()
{
m_expired = true;
m_started = 0;
}
int TimeoutTimer::release()
{
if (--refCounter == 0)
{
delete this;
return 0;
}
return 1;
}
unsigned int TimeoutTimer::timeToExpire() const
{
if (!m_started || m_expired)
return 0;
const SINT64 t = fb_utils::query_performance_counter() * 1000 / fb_utils::query_performance_frequency();
const SINT64 r = m_started + m_value - t;
return r > 0 ? r : 0;
}
bool TimeoutTimer::getExpireTimestamp(const ISC_TIMESTAMP_TZ start, ISC_TIMESTAMP_TZ& exp) const
{
if (!m_started || m_expired)
return false;
SINT64 ticks = TimeStamp::timeStampToTicks(start.utc_timestamp);
ticks += m_value * ISC_TIME_SECONDS_PRECISION / 1000;
exp.utc_timestamp = TimeStamp::ticksToTimeStamp(ticks);
exp.time_zone = start.time_zone;
return true;
}
void TimeoutTimer::start()
{
FbLocalStatus s;
ITimerControl* timerCtrl = Firebird::TimerInterfacePtr();
m_expired = false;
// todo: timerCtrl->restart to avoid 2 times acquire timerCtrl mutex
if (m_started)
{
timerCtrl->stop(&s, this);
m_started = 0;
}
if (m_value != 0)
{
timerCtrl->start(&s, this, m_value * 1000);
check(&s); // ?? todo
m_started = fb_utils::query_performance_counter() * 1000 / fb_utils::query_performance_frequency();
}
fb_assert(m_value && m_started || !m_value && !m_started);
}
void TimeoutTimer::stop()
{
if (m_started)
{
m_started = 0;
FbLocalStatus s;
ITimerControl* timerCtrl = Firebird::TimerInterfacePtr();
timerCtrl->stop(&s, this);
}
}
#else
bool TimeoutTimer::expired() const
{
if (!m_start)
return false;
const SINT64 t = currTime();
return t >= m_start + m_value;
}
unsigned int TimeoutTimer::timeToExpire() const
{
if (!m_start)
return 0;
const SINT64 t = currTime();
const SINT64 r = m_start + m_value - t;
return r > 0 ? r : 0;
}
bool TimeoutTimer::getExpireClock(SINT64& clock) const
{
if (!m_start)
return false;
clock = m_start + m_value;
return true;
}
void TimeoutTimer::start()
{
m_start = 0;
if (m_value != 0)
m_start = currTime();
}
void TimeoutTimer::stop()
{
m_start = 0;
}
#endif // USE_ITIMER
// begin thread_db methods
void thread_db::setDatabase(Database* val)
{
if (database != val)
{
database = val;
dbbStat = val ? &val->dbb_stats : RuntimeStatistics::getDummy();
}
}
void thread_db::setAttachment(Attachment* val)
{
attachment = val;
attStat = val ? &val->att_stats : RuntimeStatistics::getDummy();
}
void thread_db::setTransaction(jrd_tra* val)
{
transaction = val;
traStat = val ? &val->tra_stats : RuntimeStatistics::getDummy();
}
void thread_db::setRequest(Request* val)
{
request = val;
reqStat = val ? &val->req_stats : RuntimeStatistics::getDummy();
}
SSHORT thread_db::getCharSet() const
{
USHORT charSetId;
if (request && (charSetId = request->getStatement()->charSetId) != CS_dynamic)
return charSetId;
return attachment->att_charset;
}
ISC_STATUS thread_db::getCancelState(ISC_STATUS* secondary)
{
// Test for asynchronous shutdown/cancellation requests.
// But do that only if we're neither in the verb cleanup state
// nor currently detaching, as these actions should never be interrupted.
// Also don't break wait in LM if it is not safe.
if (tdbb_flags & (TDBB_verb_cleanup | TDBB_dfw_cleanup | TDBB_detaching | TDBB_wait_cancel_disable))
return FB_SUCCESS;
if (attachment)
{
if (attachment->att_purge_tid == Thread::getId())
return FB_SUCCESS;
if (attachment->att_flags & ATT_shutdown)
{
if (database->dbb_ast_flags & DBB_shutdown)
return isc_shutdown;
if (secondary)
*secondary = attachment->getStable() ? attachment->getStable()->getShutError() : 0;
return isc_att_shutdown;
}
// If a cancel has been raised, defer its acknowledgement
// when executing in the context of an internal request or
// the system transaction.
if ((attachment->att_flags & ATT_cancel_raise) &&
!(attachment->att_flags & ATT_cancel_disable))
{
if ((!request ||
!(request->getStatement()->flags &
// temporary change to fix shutdown
(/*Statement::FLAG_INTERNAL | */Statement::FLAG_SYS_TRIGGER))) &&
(!transaction || !(transaction->tra_flags & TRA_system)))
{
return isc_cancelled;
}
}
}
if (tdbb_reqTimer && tdbb_reqTimer->expired())
{
if (secondary)
*secondary = tdbb_reqTimer->getErrCode();
return isc_cancelled;
}
// Check the thread state for already posted system errors. If any still persists,
// then someone tries to ignore our attempts to interrupt him. Let's insist.
if (tdbb_flags & TDBB_sys_error)
return isc_cancelled;
return FB_SUCCESS;
}
void thread_db::checkCancelState()
{
ISC_STATUS secondary = 0;
const ISC_STATUS error = getCancelState(&secondary);
if (error)
{
Arg::Gds status(error);
if (error == isc_shutdown)
status << Arg::Str(attachment->att_filename);
if (secondary)
status << Arg::Gds(secondary);
if (attachment)
attachment->att_flags &= ~ATT_cancel_raise;
tdbb_flags |= TDBB_sys_error;
status.copyTo(tdbb_status_vector);
CCH_unwind(this, true);
}
}
void thread_db::reschedule()
{
// Somebody has kindly offered to relinquish
// control so that somebody else may run
checkCancelState();
StableAttachmentPart::Sync* sync = this->getAttachment()->getStable()->getSync();
if (sync->hasContention())
{
FB_UINT64 cnt = sync->getLockCounter();
{ // scope
EngineCheckout cout(this, FB_FUNCTION);
Thread::yield();
while (sync->hasContention() && (sync->getLockCounter() == cnt))
Thread::sleep(1);
}
checkCancelState();
}
Monitoring::checkState(this);
if (tdbb_quantum <= 0)
tdbb_quantum = (tdbb_flags & TDBB_sweeper) ? SWEEP_QUANTUM : QUANTUM;
}
ULONG thread_db::adjustWait(ULONG wait) const
{
if ((wait == 0) || (tdbb_flags & TDBB_wait_cancel_disable) || !tdbb_reqTimer)
return wait;
// This limit corresponds to the lock manager restriction (wait time is signed short)
static const ULONG MAX_WAIT_TIME = MAX_SSHORT; // seconds
const unsigned int timeout = tdbb_reqTimer->timeToExpire(); // milliseconds
const ULONG adjustedTimeout =
(timeout < MAX_WAIT_TIME * 1000) ? (timeout + 999) / 1000 : MAX_WAIT_TIME;
return MIN(wait, adjustedTimeout);
}
// end thread_db methods
void JRD_autocommit_ddl(thread_db* tdbb, jrd_tra* transaction)
{
// Ignore autocommit for:
// 1) cancelled requests (already detached from the transaction)
// 2) requests created by EXECUTE STATEMENT or coming from external engines
if (!transaction || transaction->tra_callback_count)
return;
// Perform an auto commit for autocommit transactions.
// This is slightly tricky. If the commit retain works, all is well.
// If TRA_commit() fails, we perform a rollback_retain(). This will backout
// the effects of the transaction, mark it dead and start a new transaction.
if (transaction->tra_flags & TRA_perform_autocommit)
{
transaction->tra_flags &= ~TRA_perform_autocommit;
try
{
TRA_commit(tdbb, transaction, true);
}
catch (const Exception&)
{
try
{
ThreadStatusGuard temp_status(tdbb);
TRA_rollback(tdbb, transaction, true, false);
}
catch (const Exception&)
{
// no-op
}
throw;
}
}
}
void JRD_receive(thread_db* tdbb, Request* request, USHORT msg_type, ULONG msg_length, void* msg)
{
/**************************************
*
* J R D _ r e c e i v e
*
**************************************
*
* Functional description
* Get a record from the host program.
*
**************************************/
EXE_receive(tdbb, request, msg_type, msg_length, msg, true);
check_autocommit(tdbb, request);
if (request->req_flags & req_warning)
{
request->req_flags &= ~req_warning;
ERR_punt();
}
}
void JRD_send(thread_db* tdbb, Request* request, USHORT msg_type, ULONG msg_length, const void* msg)
{
/**************************************
*
* J R D _ s e n d
*
**************************************
*
* Functional description
* Get a record from the host program.
*
**************************************/
EXE_send(tdbb, request, msg_type, msg_length, msg);
check_autocommit(tdbb, request);
if (request->req_flags & req_warning)
{
request->req_flags &= ~req_warning;
ERR_punt();
}
}
void JRD_start(Jrd::thread_db* tdbb, Request* request, jrd_tra* transaction)
{
/**************************************
*
* J R D _ s t a r t
*
**************************************
*
* Functional description
* Get a record from the host program.
*
**************************************/
EXE_unwind(tdbb, request);
EXE_start(tdbb, request, transaction);
check_autocommit(tdbb, request);
if (request->req_flags & req_warning)
{
request->req_flags &= ~req_warning;
ERR_punt();
}
}
void JRD_commit_transaction(thread_db* tdbb, jrd_tra* transaction)
{
/**************************************
*
* J R D _ c o m m i t _ t r a n s a c t i o n
*
**************************************
*
* Functional description
* Commit a transaction and keep the environment valid.
*
**************************************/
commit(tdbb, transaction, false);
}
void JRD_commit_retaining(thread_db* tdbb, jrd_tra* transaction)
{
/**************************************
*
* J R D _ c o m m i t _ r e t a i n i n g
*
**************************************
*
* Functional description
* Commit a transaction.
*
**************************************/
commit(tdbb, transaction, true);
}
void JRD_rollback_transaction(thread_db* tdbb, jrd_tra* transaction)
{
/**************************************
*
* J R D _ r o l l b a c k _ t r a n s a c t i o n
*
**************************************
*
* Functional description
* Abort a transaction.
*
**************************************/
rollback(tdbb, transaction, false);
}
void JRD_rollback_retaining(thread_db* tdbb, jrd_tra* transaction)
{
/**************************************
*
* J R D _ r o l l b a c k _ r e t a i n i n g
*
**************************************
*
* Functional description
* Abort a transaction but keep the environment valid
*
**************************************/
rollback(tdbb, transaction, true);
}
void JRD_start_and_send(thread_db* tdbb, Request* request, jrd_tra* transaction,
USHORT msg_type, ULONG msg_length, const void* msg)
{
/**************************************
*
* J R D _ s t a r t _ a n d _ s e n d
*
**************************************
*
* Functional description
* Get a record from the host program.
*
**************************************/
EXE_unwind(tdbb, request);
EXE_start(tdbb, request, transaction);
EXE_send(tdbb, request, msg_type, msg_length, msg);
check_autocommit(tdbb, request);
if (request->req_flags & req_warning)
{
request->req_flags &= ~req_warning;
ERR_punt();
}
}
void JRD_run_trans_start_triggers(thread_db* tdbb, jrd_tra* transaction)
{
/**************************************
*
* Run TRIGGER_TRANS_START, rollback transaction on failure.
* Handle rollback error, re-throw trigger error
*
**************************************/
try
{
EXE_execute_db_triggers(tdbb, transaction, TRIGGER_TRANS_START);
}
catch (const Exception&)
{
try
{
TRA_rollback(tdbb, transaction, false, false);
}
catch (const Exception& ex2)
{
if (tdbb->getDatabase()->dbb_flags & DBB_bugcheck)
throw;
iscLogException("Error rolling back new transaction", ex2);
}
throw;
}
}
static void start_transaction(thread_db* tdbb, bool transliterate, jrd_tra** tra_handle,
Jrd::Attachment* attachment, unsigned int tpb_length, const UCHAR* tpb)
{
/**************************************
*
* s t a r t _ m u l t i p l e
*
**************************************
*
* Functional description
* Start a transaction.
*
**************************************/
fb_assert(attachment == tdbb->getAttachment());
try
{
if (*tra_handle)
status_exception::raise(Arg::Gds(isc_bad_trans_handle));
try
{
if (tpb_length > 0 && !tpb)
status_exception::raise(Arg::Gds(isc_bad_tpb_form));
jrd_tra* transaction = TRA_start(tdbb, tpb_length, tpb);
// run ON TRANSACTION START triggers
JRD_run_trans_start_triggers(tdbb, transaction);
*tra_handle = transaction;
}
catch (const Exception& ex)
{
if (transliterate)
{
FbLocalStatus tempStatus;
transliterateException(tdbb, ex, &tempStatus, "startTransaction");
status_exception::raise(&tempStatus);
}
throw;
}
}
catch (const Exception&)
{
*tra_handle = NULL;
throw;
}
}
void JRD_start_transaction(thread_db* tdbb, jrd_tra** transaction,
Jrd::Attachment* attachment, unsigned int tpb_length, const UCHAR* tpb)
{
/**************************************
*
* J R D _ s t a r t _ t r a n s a c t i o n
*
**************************************
*
* Functional description
* Start a transaction.
*
**************************************/
start_transaction(tdbb, false, transaction, attachment, tpb_length, tpb);
}
void JRD_unwind_request(thread_db* tdbb, Request* request)
{
/**************************************
*
* J R D _ u n w i n d _ r e q u e s t
*
**************************************
*
* Functional description
* Unwind a running request. This is potentially nasty since it can
* be called asynchronously.
*
**************************************/
// Unwind request. This just tweaks some bits.
EXE_unwind(tdbb, request);
}
namespace
{
class DatabaseDirList : public DirectoryList
{
private:
const PathName getConfigString() const
{
return PathName(Config::getDatabaseAccess());
}
public:
explicit DatabaseDirList(MemoryPool& p)
: DirectoryList(p)
{
initialize();
}
};
InitInstance<DatabaseDirList> iDatabaseDirectoryList;
}
bool JRD_verify_database_access(const PathName& name)
{
/**************************************
*
* J R D _ v e r i f y _ d a t a b a s e _ a c c e s s
*
**************************************
*
* Functional description
* Verify 'name' against DatabaseAccess entry of firebird.conf.
*
**************************************/
return iDatabaseDirectoryList().isPathInList(name);
}
void JRD_shutdown_attachment(Attachment* attachment)
{
/**************************************
*
* J R D _ s h u t d o w n _ a t t a c h m e n t
*
**************************************
*
* Functional description
* Schedule the attachment marked as shutdown for disconnection.
*
**************************************/
fb_assert(attachment);
try
{
fb_assert(attachment->att_flags & ATT_shutdown);
MemoryPool& pool = *getDefaultMemoryPool();
AttachmentsRefHolder* queue = FB_NEW_POOL(pool) AttachmentsRefHolder(pool);
fb_assert(attachment->getStable());
attachment->getStable()->addRef();
queue->add(attachment->getStable());
Thread::start(attachmentShutdownThread, queue, THREAD_high);
}
catch (const Exception&)
{} // no-op
}
void JRD_shutdown_attachments(Database* dbb)
{
/**************************************
*
* J R D _ s h u t d o w n _ a t t a c h m e n t s
*
**************************************
*
* Functional description
* Schedule the attachments not marked as shutdown for disconnection.
*
**************************************/
fb_assert(dbb);
try
{
MemoryPool& pool = *getDefaultMemoryPool();
AutoPtr<AttachmentsRefHolder> queue(FB_NEW_POOL(pool) AttachmentsRefHolder(pool));
// Collect all user attachments to shutdown. Lock dbb_sync for safety.
// Note, attachments will be marked for shutdown later, in shutdownAttachments()
{ // scope
Sync guard(&dbb->dbb_sync, "JRD_shutdown_attachments");
if (!dbb->dbb_sync.ourExclusiveLock())
guard.lock(SYNC_SHARED);
for (Jrd::Attachment* attachment = dbb->dbb_attachments;
attachment;
attachment = attachment->att_next)
{
if (!(attachment->att_flags & ATT_shutdown) &&
!(attachment->att_flags & ATT_shutdown_manager))
{
fb_assert(attachment->getStable());
attachment->getStable()->addRef();
queue->add(attachment->getStable());
}
}
}
if (queue.hasData())
Thread::start(attachmentShutdownThread, queue.release(), THREAD_high);
}
catch (const Exception&)
{} // no-op
}
void JRD_cancel_operation(thread_db* /*tdbb*/, Jrd::Attachment* attachment, int option)
{
/**************************************
*
* J R D _ c a n c e l _ o p e r a t i o n
*
**************************************
*
* Functional description
* Try to cancel an operation.
*
**************************************/
switch (option)
{
case fb_cancel_disable:
attachment->att_flags |= ATT_cancel_disable;
attachment->att_flags &= ~ATT_cancel_raise;
break;
case fb_cancel_enable:
if (attachment->att_flags & ATT_cancel_disable)
{
// avoid leaving ATT_cancel_raise set when cleaning ATT_cancel_disable
// to avoid unexpected CANCEL (though it should not be set, but...)
attachment->att_flags &= ~(ATT_cancel_disable | ATT_cancel_raise);
}
break;
case fb_cancel_raise:
if (!(attachment->att_flags & ATT_cancel_disable))
attachment->signalCancel();
break;
case fb_cancel_abort:
if (!(attachment->att_flags & ATT_shutdown))
attachment->signalShutdown(isc_att_shut_killed);
break;
default:
fb_assert(false);
}
}
bool TrigVector::hasActive() const
{
for (const_iterator iter = begin(); iter != end(); ++iter)
{
if (iter->isActive())
return true;
}
return false;
}
void TrigVector::decompile(thread_db* tdbb)
{
for (iterator iter = begin(); iter != end(); ++iter)
iter->release(tdbb);
}
void TrigVector::release()
{
release(JRD_get_thread_data());
}
void TrigVector::release(thread_db* tdbb)
{
if (--useCount == 0)
{
decompile(tdbb);
delete this;
}
}
View Git Blame Copy Permalink