MCL/sf/os/persistentdata: comparison persistentstorage/sql/SRC/Server/SqlSrvDbSysSettings.cpp

equal deleted inserted replaced

-:28839de615b4
+:26645d81f48d
 #include "SqlSrvStatementUtil.h"//Global SQL execution functions
 #include "SqlSrvCollation.h"	//TSqlCollate
 #include "SqlSrvStrings.h"		//System table names
 #include "SqlSrvUtil.h"			//Global functions
 #include "SqlSrvFileData.h"		//TSqlSrvFileData
+#include "OstTraceDefinitions.h"
+#ifdef OST_TRACE_COMPILER_IN_USE
+#include "SqlSrvDbSysSettingsTraces.h"
+#endif
+#include "SqlTraceDef.h"
 extern TBool IsStatementSupported(const TDesC& aStatementIn, const TDesC& aDbName, TDes& aStatementOut);
 ///////////////////////////////////////////////////////////////////////////////////////////////////////////////
 /////////////////////////////        Local const data   ///////////////////////////////////////////////////////
 //Finalzes the statement handle (aHandle argument). Used in stack cleanup operations.
 //Panic SqlDb 4 In _DEBUG mode if aHandle argument is NULL.
 static void FinalizeStatementHandle(void* aHandle)
 	{
-	__SQLASSERT(aHandle != NULL, ESqlPanicBadArgument);
+	__ASSERT_DEBUG(aHandle != NULL, __SQLPANIC2(ESqlPanicBadArgument));
 	sqlite3_stmt* stmtHandle = static_cast <sqlite3_stmt*> (aHandle);
 	(void)sqlite3_finalize(stmtHandle);
 	}
 //Transaction rollback. Used in stack cleanup operations.
 //Panic SqlDb 4 In _DEBUG mode if aDbHandle argument is NULL.
 static void RollbackTransaction(void* aDbHandle)
 	{
-	__SQLASSERT(aDbHandle != NULL, ESqlPanicBadArgument);
+	__ASSERT_DEBUG(aDbHandle != NULL, __SQLPANIC2(ESqlPanicBadArgument));
 	(void)::DbExecStmt8(reinterpret_cast <sqlite3*> (aDbHandle), KRollbackTransactionSql);
 	}
 ///////////////////////////////////////////////////////////////////////////////////////////////////////////////
 /////////////////////////////      TSqlDbSysSettings   ////////////////////////////////////////////////////////
 @panic SqlDb 4 In _DEBUG mode if aDbHandle argument is NULL.
 */
 TSqlDbSysSettings::TSqlDbSysSettings(sqlite3* aDbHandle) :
 	iDbHandle(aDbHandle)
 	{
-	__SQLASSERT(iDbHandle != NULL, ESqlPanicBadArgument);
+	__ASSERT_DEBUG(iDbHandle != NULL, __SQLPANIC(ESqlPanicBadArgument));
 	}
 /**
 Creates the database security policy table and stores the security policy in the table.
 errors categorised as ESqlDbError, and other system-wide error codes.
 @panic SqlDb 2 In _DEBUG mode if iDbHandle is NULL (uninitialized TSqlDbSysSettings object).
 */
 void TSqlDbSysSettings::StoreSecurityPolicyL(const CSqlSecurityPolicy& aSecurityPolicyCon)
 	{
-	__SQLASSERT(iDbHandle != NULL, ESqlPanicInvalidObj);
+	__ASSERT_DEBUG(iDbHandle != NULL, __SQLPANIC(ESqlPanicInvalidObj));
 	__SQLLEAVE_IF_ERROR(::DbExecStmt8(iDbHandle, KBeginTransactionSql()));
 	CleanupStack::PushL(TCleanupItem(&RollbackTransaction, iDbHandle));
 	__SQLLEAVE_IF_ERROR(::DbExecStmt8(iDbHandle, KCreateSecuritySql()));
 	StoreSecurityPoliciesL(aSecurityPolicyCon);
 	__SQLLEAVE_IF_ERROR(::DbExecStmt8(iDbHandle, KCommitTransactionSql()));
 @panic SqlDb 2 In _DEBUG mode if iDbHandle is NULL (uninitialized TSqlDbSysSettings object).
 @panic SqlDb 4 In _DEBUG mode if aCompactionMode parameter value is invalid.
 */
 void TSqlDbSysSettings::StoreSettingsL(const TDesC& aDbName, const TDesC& aCollationDllName, TInt aDbConfigFileVersion, TSqlCompactionMode aCompactionMode)
 	{
-	__SQLASSERT(aCompactionMode == ESqlCompactionManual || aCompactionMode == ESqlCompactionBackground || aCompactionMode == ESqlCompactionAuto, ESqlPanicBadArgument);
+	__ASSERT_DEBUG(aCompactionMode == ESqlCompactionManual || aCompactionMode == ESqlCompactionBackground || aCompactionMode == ESqlCompactionAuto, __SQLPANIC(ESqlPanicBadArgument));
-	__SQLASSERT(iDbHandle != NULL, ESqlPanicInvalidObj);
+	__ASSERT_DEBUG(iDbHandle != NULL, __SQLPANIC(ESqlPanicInvalidObj));
 	HBufC* buf = HBufC::NewLC(Max((TInt)sizeof(KDropSettingsSql),
 							  Max((TInt)sizeof(KCreateSettingsSql), (TInt)sizeof(KInsertSettingsSql))) +
 							  aDbName.Length() + aCollationDllName.Length() + 10);
 	TPtr sql = buf->Des();
 	//Begin transaction
 errors categorised as ESqlDbError, and other system-wide error codes.
 @panic SqlDb 2 In _DEBUG mode if iDbHandle is NULL (uninitialized TSqlDbSysSettings object).
 */
 void TSqlDbSysSettings::LoadSecurityPolicyL(CSqlSecurityPolicy& aSecurityPolicyCon)
 	{
-	__SQLASSERT(iDbHandle != NULL, ESqlPanicInvalidObj);
+	__ASSERT_DEBUG(iDbHandle != NULL, __SQLPANIC(ESqlPanicInvalidObj));
 	//Even if the version of the system settings is bigger than the current one (KSqlSystemVersion constant),
 	//I think that all future modifications of the system tables shall not affect the already existing
 	//fields. So it is correct to think that all information available in version 1 should be available
 	//(and accessible) in all future versions of the system settings.
 	//Note: no attempt shall be made here to modify the system tables structure! There may be more than one
 @panic SqlDb 2 In _DEBUG mode if iDbHandle is NULL (uninitialized TSqlDbSysSettings object).
 @panic SqlDb 7 In _DEBUG mode if the stored compaction mode is invalid.
 */
 void TSqlDbSysSettings::LoadSettingsL(const TDesC& aDbName, TDes& aCollationDllName, TInt& aDbConfigFileVersion, TSqlCompactionMode& aCompactionMode)
 	{
-	__SQLASSERT(iDbHandle != NULL, ESqlPanicInvalidObj);
+	__ASSERT_DEBUG(iDbHandle != NULL, __SQLPANIC(ESqlPanicInvalidObj));
 	aCollationDllName.Zero();
 	aDbConfigFileVersion = KSqlNullDbConfigFileVersion;
 	if(aCompactionMode == ESqlCompactionNotSet)
 		{
 			{
 			//Recreate the settings table using the last version number format (this is what the old code did during reindexing)
 			StoreSettingsL(aDbName, aCollationDllName, aDbConfigFileVersion, aCompactionMode); // store empty collation dll name, then reindexing will occur
 			}
 		}
-	__SQLASSERT(aCompactionMode == ESqlCompactionManual || aCompactionMode == ESqlCompactionBackground || aCompactionMode == ESqlCompactionAuto, ESqlPanicInternalError);
+	__ASSERT_DEBUG(aCompactionMode == ESqlCompactionManual || aCompactionMode == ESqlCompactionBackground || aCompactionMode == ESqlCompactionAuto, __SQLPANIC(ESqlPanicInternalError));
 	}
 /**
 Retrieves the database system settings from the settings table.
 @panic SqlDb 2 In _DEBUG mode if iDbHandle is NULL (uninitialized TSqlDbSysSettings object).
 */
 void TSqlDbSysSettings::GetSettingsL(const TDesC& aDbName, TDes& aCollationDllName, TInt& aDbConfigFileVersion,
 									 TInt& aSettingsVersion, TSqlCompactionMode& aCompactionMode)
 	{
-	__SQLASSERT(iDbHandle != NULL, ESqlPanicInvalidObj);
+	__ASSERT_DEBUG(iDbHandle != NULL, __SQLPANIC(ESqlPanicInvalidObj));
 	HBufC* buf = HBufC::NewLC(sizeof(KGetSettingsSql) + aDbName.Length());
 	TPtr sql = buf->Des();
 	//Prepare statement handle
 __SQLLEAVE(KErrGeneral);
 }
 		const void* ptr = sqlite3_column_text16(stmtHandle, KCollationDllNameColIdx);
 //Null column value - this might be an indication of an "out of memory" problem, if the column text
 //is in UTF8 format. (sqlite3_column_text16() may allocate memory for UTF8->UTF16 conversion)
-		__SQLLEAVE_IF_NULL(ptr);
+		__SQLLEAVE_IF_NULL(const_cast<void*>(ptr));
 TPtrC16 src(reinterpret_cast <const TUint16*> (ptr));
 if(src.Length() > aCollationDllName.MaxLength())
 {
 __SQLLEAVE(KErrOverflow);
 }
 @panic SqlDb 2 In _DEBUG mode if iDbHandle is NULL (uninitialized TSqlDbSysSettings object).
 */
 void TSqlDbSysSettings::ReindexDatabaseL(const TDesC& aDbName, const TDesC& aCurrentCollationDllName)
 	{
-	__SQLASSERT(iDbHandle != NULL, ESqlPanicInvalidObj);
+	__ASSERT_DEBUG(iDbHandle != NULL, __SQLPANIC(ESqlPanicInvalidObj));
 	//Allocate memory for the SQL statements
 	HBufC* buf = HBufC::NewLC(Max((TInt)sizeof(KUpdateCollationSettingsSql), (TInt)sizeof(KReindexSql)) +
 							  aDbName.Length() + aCurrentCollationDllName.Length());
 	TPtr sql = buf->Des();
 @panic SqlDb 2 In _DEBUG mode if iDbHandle is NULL (uninitialized TSqlDbSysSettings object)
 */
 void TSqlDbSysSettings::ConfigureDatabaseL(TInt aStoredDbConfigFileVersion, const TSqlSrvFileData& aFileData,
 										   const TDesC& aDbName)
 	{
-	__SQLASSERT(iDbHandle != NULL, ESqlPanicInvalidObj);
+	SQL_TRACE_INTERNALS(OstTrace1(TRACE_INTERNALS, TSQLDBSYSSETTINGS_CONFIGUREDATABASEL_ENTRY, "Entry;0x%X;TSqlDbSysSettings::ConfigureDatabaseL", (TUint)this));
+	__ASSERT_DEBUG(iDbHandle != NULL, __SQLPANIC(ESqlPanicInvalidObj));
 	if(!aFileData.IsSecureFileNameFmt())
 		{
 		//As a first implementation, config files will only be supported for
 		//shared, secure databases - not for private, secure databases or public databases
+		SQL_TRACE_INTERNALS(OstTrace1(TRACE_INTERNALS, TSQLDBSYSSETTINGS_CONFIGUREDATABASEL_EXIT1, "Exit;0x%X;TSqlDbSysSettings::ConfigureDatabaseL;Not a secure db", (TUint)this));
 		return;
 		}
 	//Determine whether there is a configuration file
 	//for this database that has not yet been processed
 				if(KErrNone == lex.Val(fileVersion))
 					{
 					if(fileVersion > aStoredDbConfigFileVersion)
 						{
 						//The latest version of the configuration file has not yet been processed, so do it now
-						__SQLLOG_STRING(_L("SQLLOG: TSqlDbSysSettings::ConfigureDatabaseL() - Processing config file %S"), configFileName);
+						SQL_TRACE_INTERNALS(OstTraceExt2(TRACE_INTERNALS, TSQLDBSYSSETTINGS_CONFIGUREDATABASEL1, "0x%X;TSqlDbSysSettings::ConfigureDatabaseL;Config file '%S'", (TUint)this, __SQLPRNSTR(configFileName)));
 						ExecuteConfigurationUpdateL(aFileData, configFileName, fileVersion, aDbName);
-						__SQLLOG_STRING(_L("SQLLOG: TSqlDbSysSettings::ConfigureDatabaseL() - SUCCESS! Config file %S was processed"), configFileName);
+						SQL_TRACE_INTERNALS(OstTraceExt2(TRACE_INTERNALS, TSQLDBSYSSETTINGS_CONFIGUREDATABASEL2, "0x%X;TSqlDbSysSettings::ConfigureDatabaseL;Config file '%S' was processed, no errors", (TUint)this, __SQLPRNSTR(configFileName)));
 						}
 					else
 						{
-						__SQLLOG_STRING(_L("SQLLOG: TSqlDbSysSettings::ConfigureDatabaseL() - Not processing config file %S as this or a later version has already been processed"), configFileName);
+						SQL_TRACE_INTERNALS(OstTraceExt2(TRACE_INTERNALS, TSQLDBSYSSETTINGS_CONFIGUREDATABASEL3, "0x%X;TSqlDbSysSettings::ConfigureDatabaseL;Config file '%S' as this or a later version has already been processed", (TUint)this, __SQLPRNSTR(configFileName)));
 						}
 					}
 				else
 					{
 					//Invalid config file name extension - it cannot be converted to an integer
 				__SQLLEAVE(KErrCorrupt);
 				}
 			}
 		else
 			{
-			__SQLLOG_STRING(_L("SQLLOG: TSqlDbSysSettings::ConfigureDatabaseL() - No config file found for database %S"), dbFileNameAndExt);
+			SQL_TRACE_INTERNALS(OstTraceExt2(TRACE_INTERNALS, TSQLDBSYSSETTINGS_CONFIGUREDATABASEL4, "0x%X;TSqlDbSysSettings::ConfigureDatabaseL;No config file found for database '%S'", (TUint)this, __SQLPRNSTR(dbFileNameAndExt)));
 			}
 		}
+	SQL_TRACE_INTERNALS(OstTrace1(TRACE_INTERNALS, TSQLDBSYSSETTINGS_CONFIGUREDATABASEL_EXIT2, "Exit;0x%X;TSqlDbSysSettings::ConfigureDatabaseL", (TUint)this));
 	}
 /**
 Executes the supported operations specified in the given database
 configuration file and updates the settings table to store the
 void TSqlDbSysSettings::ExecuteConfigurationUpdateL(const TSqlSrvFileData& aFileData,
 													const TDesC& aMatchingConfigFile,
 													TInt aDbConfigFileVersion,
 													const TDesC& aDbName)
 	{
-	__SQLASSERT(iDbHandle != NULL, ESqlPanicInvalidObj);
+	__ASSERT_DEBUG(iDbHandle != NULL, __SQLPANIC(ESqlPanicInvalidObj));
 	//Execute the specified database config file operations that are supported
 #ifdef SYSLIBS_TEST
 	TDriveUnit drive = EDriveC;
 #else
 @panic SqlDb 2 In _DEBUG mode if iDbHandle is NULL (uninitialized TSqlDbSysSettings object).
 */
 void TSqlDbSysSettings::DoExecuteDbConfigFileOpsL(RFs& aFs, const TDesC& aConfigFilePath, const TDesC& aDbName)
 	{
-	__SQLASSERT(iDbHandle != NULL, ESqlPanicInvalidObj);
+	__ASSERT_DEBUG(iDbHandle != NULL, __SQLPANIC(ESqlPanicInvalidObj));
 	//Open the config file and read it into a buffer
 	RFile64 file;
 	__SQLLEAVE_IF_ERROR(file.Open(aFs, aConfigFilePath, EFileRead));
 	CleanupClosePushL(file);
 	TInt64 size = 0;
 	__SQLLEAVE_IF_ERROR(file.Size(size));
 	if(size == 0)
 		{
 		//Config file is empty so just return
-		__SQLLOG_STRING(_L("SQLLOG: TSqlDbSysSettings::DoExecuteDbConfigFileOpsL() - Config file %S is empty"), aConfigFilePath);
+		SQL_TRACE_INTERNALS(OstTraceExt1(TRACE_INTERNALS, TSQLDBSYSSETTINGS_DOEXECUTEDBCONFIGFILEOPSL, "0;TSqlDbSysSettings::DoExecuteDbConfigFileOpsL();Config file %S is empty", __SQLPRNSTR(aConfigFilePath)));
 		CleanupStack::PopAndDestroy(); // file
 		return;
 		}
 	HBufC8* buffer = HBufC8::NewLC(size);
 	TPtr8 bufPtr = buffer->Des();
 @leave KErrNoMemory, if an out of memory condition occurs
 */
 void TSqlDbSysSettings::ProcessStatementL(const TDesC& aStmt, const TDesC& aDbName)
 	{
-	__SQLLOG_STRING(_L("SQLLOG: TSqlDbSysSettings::ProcessStatementL() - Processing statement '%S'"), aStmt);
+	SQL_TRACE_INTERNALS(OstTraceExt2(TRACE_INTERNALS, TSQLDBSYSSETTINGS_PROCESSSTATEMENTL_ENTRY, "Entry;0x%X;TSqlDbSysSettings::ProcessStatementL;Processing statement '%S'", (TUint)this, __SQLPRNSTR(aStmt)));
 	//If the statement only contained whitespace then just return
 	if(aStmt.Length() == 0)
 		{
-		__SQLLOG_STRING(_L("SQLLOG: TSqlDbSysSettings::ProcessStatementL() - Statement '%S' only contains whitespace - statement will be ignored"), aStmt);
+		SQL_TRACE_INTERNALS(OstTrace1(TRACE_INTERNALS, TSQLDBSYSSETTINGS_PROCESSSTATEMENTL_EXIT1, "Exit;0x%X;TSqlDbSysSettings::ProcessStatementL;The statement ignored because contains only whitespace", (TUint)this));
 		return;
 		}
 	//Check that the statement does not contain an unsupported comment style
 	if(KErrNotFound != aStmt.Find(_L("//")))
 		{
 		//The statement contains '//' which is an unsupported comment style, but rather
 		//than leave here and cause the full file to fail, we just ignore this statement
-		__SQLLOG_STRING(_L("SQLLOG: TSqlDbSysSettings::ProcessStatementL() - Statement '%S' contains invalid comment style - statement will be ignored"), aStmt);
+		SQL_TRACE_INTERNALS(OstTrace1(TRACE_INTERNALS, TSQLDBSYSSETTINGS_PROCESSSTATEMENTL_EXIT2, "Exit;0x%X;TSqlDbSysSettings::ProcessStatementL;The statement ignored because contains invalid comment style", (TUint)this));
 		return;
 		}
 	HBufC* stmtBuf = HBufC::NewLC(aStmt.Length() + 1 + aDbName.Length() + 1);
 	TPtr stmtPtr = stmtBuf->Des();
 	if(::IsStatementSupported(aStmt, aDbName, stmtPtr))
 		{
 		TInt err = ::DbExecStmt16(iDbHandle, stmtPtr);
 		if(KErrNone == err)
 			{
-			__SQLLOG_STRING(_L("SQLLOG: TSqlDbSysSettings::ProcessStatementL() - Successfully executed statement '%S'"), aStmt);
+			SQL_TRACE_INTERNALS(OstTrace1(TRACE_INTERNALS, TSQLDBSYSSETTINGS_PROCESSSTATEMENTL1, "0x%X;TSqlDbSysSettings::ProcessStatementL;Successfully executed statement", (TUint)this));
 			}
 		else
 			{
-			__SQLLOG_ERR(_L("SQLLOG: TSqlDbSysSettings::ProcessStatementL() - Failed to execute the statement, err=%d"), err);
+			SQL_TRACE_INTERNALS(OstTraceExt2(TRACE_INTERNALS, TSQLDBSYSSETTINGS_PROCESSSTATEMENTL2, "0x%X;TSqlDbSysSettings::ProcessStatementL;Failed to execute the statement;err=%d", (TUint)this, err));
 			if(err == KErrNoMemory)
 				{
 				__SQLLEAVE(err);
 				}
 			}
 		}
 	else
 		{
-		__SQLLOG_STRING(_L("SQLLOG: TSqlDbSysSettings::ProcessStatementL() - Non-supported statement, will be ignored - '%S'"), aStmt);
+		SQL_TRACE_INTERNALS(OstTrace1(TRACE_INTERNALS, TSQLDBSYSSETTINGS_PROCESSSTATEMENTL3, "0x%X;TSqlDbSysSettings::ProcessStatementL;Non-supported statement, will be ignored", (TUint)this));
 		}
 	CleanupStack::PopAndDestroy(); // stmtBuf
+	SQL_TRACE_INTERNALS(OstTrace1(TRACE_INTERNALS, TSQLDBSYSSETTINGS_PROCESSSTATEMENTL_EXIT3, "Exit;0x%X;TSqlDbSysSettings::ProcessStatementL", (TUint)this));
 	}
 /**
 Stores the security policies into the security policies table.
 @panic SqlDb 4 In _DEBUG mode if aHandle argument is NULL.
 */
 void TSqlDbSysSettings::StoreSecurityPolicyL(sqlite3_stmt* aStmtHandle, TInt aObjType, const TDesC& aObjName,
 											 TInt aPolicyType, const TSecurityPolicy& aPolicy)
 	{
-	__SQLASSERT(aStmtHandle != NULL, ESqlPanicBadArgument);
+	__ASSERT_DEBUG(aStmtHandle != NULL, __SQLPANIC(ESqlPanicBadArgument));
 	__SQLLEAVE_IF_ERROR(::StmtReset(aStmtHandle));
 	__SQLLEAVE_IF_ERROR(BindSecurityPolicyPrm(aStmtHandle, aObjType, aObjName, aPolicyType, aPolicy));
 	__SQLLEAVE_IF_ERROR(::StmtExec(aStmtHandle));
 	}
 	   KErrNoMemory, Out of memory.
 */
 TSecurityPolicy TSqlDbSysSettings::ReadCurrSecurityPolicyL(sqlite3_stmt* aStmtHandle, TInt& aObjType,
 														   TPtrC& aObjName, TInt& aPolicyType)
 	{
-	__SQLASSERT(aStmtHandle != NULL, ESqlPanicBadArgument);
+	__ASSERT_DEBUG(aStmtHandle != NULL, __SQLPANIC(ESqlPanicBadArgument));
 	aObjType = sqlite3_column_int(aStmtHandle, KObjTypeColIdx);
 //The "ObjectName" column type might be different than SQLITE_TEXT - malformed database.
 if(sqlite3_column_type(aStmtHandle, KObjNameColIdx) != SQLITE_TEXT)
 {
 __SQLLEAVE(KErrGeneral);
 }
 const void* text = sqlite3_column_text16(aStmtHandle, KObjNameColIdx);
 //Null column value - this might be an indication of an "out of memory" problem, if the column text
 //is in UTF8 format. (sqlite3_column_text16() may allocate memory for UTF8->UTF16 conversion)
-__SQLLEAVE_IF_NULL(text);
+__SQLLEAVE_IF_NULL(const_cast<void*>(text));
 	TInt len = (TUint)sqlite3_column_bytes16(aStmtHandle, KObjNameColIdx) / sizeof(TUint16);
 	aObjName.Set(reinterpret_cast <const TUint16*> (text), len);
 	aPolicyType = sqlite3_column_int(aStmtHandle, KObjPolicyTypeColIdx);
 	len = sqlite3_column_bytes(aStmtHandle, KObjPolicyDataColIdx);
 	if(len != sizeof(TSecurityPolicy))

branch	RCL_3
changeset 23	26645d81f48d
parent 15	fcc16690f446
child 24	cc28652e0254