1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/persistentdata/persistentstorage/sql/SRC/Common/SqlUtil.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,342 @@
1.4 +// Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +// NTT DOCOMO, INC - Fix for Bug 1915 "SQL server panics when using long column type strings"
1.16 +//
1.17 +// Description:
1.18 +//
1.19 +
1.20 +#ifndef __SQLUTIL_H__
1.21 +#define __SQLUTIL_H__
1.22 +
1.23 +#include <e32std.h> //TInt
1.24 +
1.25 +/**
1.26 +Defines the maximum length of text or binary data that can be transferred
1.27 +from the SQL server to the SQL client in a single IPC call.
1.28 +
1.29 +This constant affects the behaviour of a number of functions, specifically:
1.30 +- RSqlStatement::ColumnBinaryL()
1.31 +- RSqlStatement::ColumnTextL()
1.32 +.
1.33 +It also affects the behaviour of member functions of the classes:
1.34 +- RSqlParamWriteStream
1.35 +- RSqlColumnReadStream
1.36 +
1.37 +@see RSqlStatement::ColumnBinaryL()
1.38 +@see RSqlStatement::ColumnTextL()
1.39 +@see RSqlParamWriteStream
1.40 +@see RSqlColumnReadStream
1.41 +
1.42 +@internalComponent
1.43 +*/
1.44 +#ifdef _DEBUG
1.45 +const TInt KSqlMaxDesLen = 8;
1.46 +#else
1.47 +const TInt KSqlMaxDesLen = 256;
1.48 +#endif
1.49 +
1.50 +/**
1.51 +Used internally for making sure config manipulation buffers
1.52 +are not exceeded
1.53 +@internalComponent
1.54 +*/
1.55 +const TInt KSqlSrvMaxConfigStrLen = 256;
1.56 +
1.57 +/**
1.58 +If some server function retuns a non-negative error, which value is bigger than KSqlClientBufOverflowCode,
1.59 +then it means the server wanted to send a data buffer to the client but the client's
1.60 +buffer is not big enough. The client must increase the buffer size and try to retrieve the data only.
1.61 +@internalComponent
1.62 +*/
1.63 +const TInt KSqlClientBufOverflowCode = 0x1000;
1.64 +
1.65 +/**
1.66 +@internalComponent
1.67 +*/
1.68 +enum TSqlBufFlatType
1.69 + {
1.70 + ESqlColumnNamesBuf,
1.71 + ESqlParamNamesBuf,
1.72 + ESqlColumnValuesBuf,
1.73 + ESqlDeclColumnTypesBuf
1.74 + };
1.75 +
1.76 +/**
1.77 +This structure is used for IPC data transfers
1.78 +@internalComponent
1.79 +*/
1.80 +NONSHARABLE_STRUCT(TSqlIpcData)
1.81 + {
1.82 + inline TSqlIpcData() :
1.83 + iPrm1(0),
1.84 + iPrm2(0)
1.85 + {
1.86 + }
1.87 + TUint32 iPrm1;
1.88 + TUint32 iPrm2;
1.89 + };
1.90 +
1.91 +/**
1.92 +IPC function codes used for communication between SqlDb.dll and SqlSrv.exe.
1.93 +
1.94 +The max function code allowed is 0xFF - see KSqlSrvFunctionMask declaration in the same file.
1.95 +
1.96 +The 32-bit RMessage2 function code format, which is used by the SQL client and server, is:
1.97 +
1.98 +@code
1.99 +Bits: 31................................0
1.100 +Bytes: 0 1 2 3
1.101 + XXXXXXTT HHHHHHHH HHHHHHHH FFFFFFFF
1.102 +
1.103 +Where:
1.104 +- "X" - unused bits;
1.105 +- "T" - handle type: 0 - statement handle, 1 - stream handle, 2 - no handle;
1.106 +- "H" - statement or stream handle, 16 bits;
1.107 +- "F" - function code, 8 bits (see KSqlSrvFunctionMask);
1.108 +@endcode
1.109 +
1.110 +@see RMessage2
1.111 +@see KSqlSrvFunctionMask
1.112 +@see KSqlSrvHandleMask
1.113 +@see KSqlSrvHandleTypeMask
1.114 +@see KSqlSrvHandleShiftBits
1.115 +@see CSqlSrvSession
1.116 +@see CSqlSrvSession::ServiceL()
1.117 +
1.118 +@internalComponent
1.119 +*/
1.120 +enum TSqlSrvFunction
1.121 + {
1.122 + //Test functions
1.123 + ESqlSrvTestBase = 0x00,
1.124 + ESqlSrvResourceMark = ESqlSrvTestBase + 0x01,
1.125 + ESqlSrvResourceCheck = ESqlSrvTestBase + 0x02,
1.126 + ESqlSrvResourceCount = ESqlSrvTestBase + 0x03,
1.127 + ESqlSrvSetDbHeapFailure = ESqlSrvTestBase + 0x04,
1.128 + ESqlSrvSetHeapFailure = ESqlSrvTestBase + 0x05,
1.129 + //Profiling functions
1.130 + ESqlSrvProfilerStart = ESqlSrvTestBase + 0x06,
1.131 + ESqlSrvProfilerStop = ESqlSrvTestBase + 0x07,
1.132 + ESqlSrvProfilerReset = ESqlSrvTestBase + 0x08,
1.133 + ESqlSrvProfilerSetRange = ESqlSrvTestBase + 0x09,//not used
1.134 + ESqlSrvProfilerQuery = ESqlSrvTestBase + 0x0A,
1.135 + //Database functions
1.136 + ESqlSrvDbBase = 0x10,
1.137 + ESqlSrvDbCreate = ESqlSrvDbBase + 0x01,
1.138 + ESqlSrvDbCreateSecure = ESqlSrvDbBase + 0x02,
1.139 + ESqlSrvDbOpen = ESqlSrvDbBase + 0x03,
1.140 + ESqlSrvDbOpenFromHandle = ESqlSrvDbBase + 0x04,
1.141 + ESqlSrvDbClose = ESqlSrvDbBase + 0x05,
1.142 + ESqlSrvDbCopy = ESqlSrvDbBase + 0x06,
1.143 + ESqlSrvDbDelete = ESqlSrvDbBase + 0x07,
1.144 + //All operations with opcode > ESqlSrvDbDelete require valid database object (on the server side)
1.145 + ESqlSrvLastErrorMsg = ESqlSrvDbBase + 0x08,
1.146 + ESqlSrvDbExec8 = ESqlSrvDbBase + 0x09,
1.147 + ESqlSrvDbExec16 = ESqlSrvDbBase + 0x0A,
1.148 + ESqlSrvDbSetIsolationLevel = ESqlSrvDbBase + 0x0C,
1.149 + ESqlSrvDbGetSecurityPolicy = ESqlSrvDbBase + 0x0D,
1.150 + ESqlSrvDbAttach = ESqlSrvDbBase + 0x0E,
1.151 + ESqlSrvDbAttachFromHandle = ESqlSrvDbBase + 0x0F,
1.152 + ESqlSrvDbDetach = ESqlSrvDbBase + 0x10,
1.153 + ESqlSrvDbScalarFullSelect8 = ESqlSrvDbBase + 0x11,
1.154 + ESqlSrvDbScalarFullSelect16 = ESqlSrvDbBase + 0x12,
1.155 + ESqlSrvDbInTransaction = ESqlSrvDbBase + 0x13,
1.156 + ESqlSrvDbSize = ESqlSrvDbBase + 0x14,
1.157 + ESqlSrvDbSize2 = ESqlSrvDbBase + 0x15,
1.158 + ESqlSrvDbBlobSource = ESqlSrvDbBase + 0x16,
1.159 + ESqlSrvDbLastInsertedRowId = ESqlSrvDbBase + 0x17,
1.160 + ESqlSrvDbCompact = ESqlSrvDbBase + 0x18,
1.161 + //Database - reserved drive space management
1.162 + ESqlSrvDbReserveDriveSpace = ESqlSrvDbBase + 0x19,
1.163 + ESqlSrvDbFreeReservedSpace = ESqlSrvDbBase + 0x1A,
1.164 + ESqlSrvDbGetReserveAccess = ESqlSrvDbBase + 0x1B,
1.165 + ESqlSrvDbReleaseReserveAccess=ESqlSrvDbBase + 0x1C,
1.166 + //Statement functions
1.167 + ESqlSrvStmtBase = 0x50,
1.168 + ESqlSrvStmtPrepare8 = ESqlSrvStmtBase + 0x01,
1.169 + ESqlSrvStmtPrepare16 = ESqlSrvStmtBase + 0x02,
1.170 + ESqlSrvStmtClose = ESqlSrvStmtBase + 0x03,
1.171 + ESqlSrvStmtReset = ESqlSrvStmtBase + 0x04,
1.172 + ESqlSrvStmtExec = ESqlSrvStmtBase + 0x05,
1.173 + ESqlSrvStmtAsyncExec = ESqlSrvStmtBase + 0x06,
1.174 + ESqlSrvStmtBindExec = ESqlSrvStmtBase + 0x07,
1.175 + ESqlSrvStmtAsyncBindExec = ESqlSrvStmtBase + 0x09,
1.176 + ESqlSrvStmtNext = ESqlSrvStmtBase + 0x0A,
1.177 + ESqlSrvStmtBindNext = ESqlSrvStmtBase + 0x0B,
1.178 + ESqlSrvStmtColumnNames = ESqlSrvStmtBase + 0x0C,
1.179 + ESqlSrvStmtParamNames = ESqlSrvStmtBase + 0x0D,
1.180 + ESqlSrvStmtColumnSource = ESqlSrvStmtBase + 0x0E,
1.181 + ESqlSrvStmtBinParamSink = ESqlSrvStmtBase + 0x0F,
1.182 + ESqlSrvStmtTxtParamSink16 = ESqlSrvStmtBase + 0x11,
1.183 + ESqlSrvStmtBufFlat = ESqlSrvStmtBase + 0x12,
1.184 + ESqlSrvStmtColumnValue = ESqlSrvStmtBase + 0x13,
1.185 + ESqlSrvStmtDeclColumnTypes = ESqlSrvStmtBase + 0x14,
1.186 + //Stream functions
1.187 + ESqlSrvStreamBase = 0x70,
1.188 + ESqlSrvStreamRead = ESqlSrvStreamBase + 0x01,
1.189 + ESqlSrvStreamWrite = ESqlSrvStreamBase + 0x02,
1.190 + ESqlSrvStreamSize = ESqlSrvStreamBase + 0x03,
1.191 + ESqlSrvStreamSynch = ESqlSrvStreamBase + 0x04,
1.192 + ESqlSrvStreamClose = ESqlSrvStreamBase + 0x05
1.193 + };
1.194 +
1.195 +////////////////////////////////////////////////////////////////////////////////////////////////////////////
1.196 +////////// RMessage2, function code related macros ////////
1.197 +////////////////////////////////////////////////////////////////////////////////////////////////////////////
1.198 +
1.199 +/**
1.200 +SQL server function mask.
1.201 +The SQL server function code must be less than 0x100.
1.202 +(it occupies the lower 8 bits of the 32-bit message code)
1.203 +
1.204 +@see TSqlSrvFunction
1.205 +
1.206 +@internalComponent
1.207 +*/
1.208 +const TUint KSqlSrvFunctionMask = 0x000000FF;
1.209 +
1.210 +/**
1.211 +SQL server (statement or stream) handle mask.
1.212 +The handle occupies 16 bits, right after the function code.
1.213 +
1.214 +@see KSqlSrvHandleTypeMask
1.215 +@see KSqlSrvHandleShiftBits
1.216 +
1.217 +@internalComponent
1.218 +*/
1.219 +const TUint KSqlSrvHandleMask = 0x00FFFF00;
1.220 +
1.221 +/**
1.222 +SQL server (stream or statement) handle - shift bits.
1.223 +
1.224 +@see KSqlSrvFunctionMask
1.225 +@see KSqlSrvHandleMask
1.226 +
1.227 +@internalComponent
1.228 +*/
1.229 +const TInt KSqlSrvHandleShiftBits = 8;
1.230 +
1.231 +/**
1.232 +SQL server handle type bit.
1.233 +
1.234 +@see KSqlSrvHandleMask
1.235 +@see KSqlSrvHandleShiftBits
1.236 +
1.237 +@internalComponent
1.238 +*/
1.239 +const TInt KSqlSrvHandleTypeMask = 0x03000000;
1.240 +
1.241 +/**
1.242 +SQL server - handle type - statement or stream.
1.243 +
1.244 +@internalComponent
1.245 +*/
1.246 +enum TSqlSrvHandleType
1.247 + {
1.248 + ESqlSrvNoHandle = 0x00000000,
1.249 + ESqlSrvStreamHandle = 0x01000000,
1.250 + ESqlSrvStatementHandle = 0x02000000
1.251 + };
1.252 +
1.253 +inline TInt MakeMsgCode(TSqlSrvFunction aFunction, TSqlSrvHandleType aHandleType, TInt aHandle);
1.254 +
1.255 +////////////////////////////////////////////////////////////////////////////////////////////////////////////
1.256 +////////////////////////////////////////////////////////////////////////////////////////////////////////////
1.257 +
1.258 +TInt Sql2OsErrCode(TInt aSqlError, TInt aOsError);
1.259 +
1.260 +////////////////////////////////////////////////////////////////////////////////////////////////////////////
1.261 +////////// Case insensitive string comparisons ////////
1.262 +////////////////////////////////////////////////////////////////////////////////////////////////////////////
1.263 +
1.264 +inline TInt CompareNoCase8(const TDesC8& aLeft, const TDesC8& aRight);
1.265 +inline TInt CompareNoCase16(const TDesC16& aLeft, const TDesC16& aRight);
1.266 +#ifdef _UNICODE
1.267 +#define CompareNoCase CompareNoCase16
1.268 +#else
1.269 +#define CompareNoCase CompareNoCase8
1.270 +#endif//_UNICODE
1.271 +
1.272 +////////////////////////////////////////////////////////////////////////////////////////////////////////////
1.273 +////////// Buffer alignment functions /////////////
1.274 +////////////////////////////////////////////////////////////////////////////////////////////////////////////
1.275 +
1.276 +inline TInt AlignedLen8(TInt aLen);
1.277 +#ifdef _DEBUG
1.278 +inline TBool IsAligned8(TInt aLen);
1.279 +#endif
1.280 +
1.281 +////////////////////////////////////////////////////////////////////////////////////////////////////////////
1.282 +////////// Compaction modes ///////////////////////
1.283 +////////////////////////////////////////////////////////////////////////////////////////////////////////////
1.284 +
1.285 +/**
1.286 +Compaction modes.
1.287 +@internalComponent
1.288 +*/
1.289 +enum TSqlCompactionMode
1.290 + {
1.291 + ESqlCompactionNotSet,
1.292 + ESqlCompactionManual,
1.293 + ESqlCompactionBackground,
1.294 + ESqlCompactionAuto
1.295 + };
1.296 +
1.297 +/**
1.298 +SQLite vacuum modes.
1.299 +@internalComponent
1.300 +*/
1.301 +enum TSqliteVacuumMode
1.302 + {
1.303 + ESqliteVacuumOff = 0,
1.304 + ESqliteVacuumAuto = 1,
1.305 + ESqliteVacuumIncremental = 2
1.306 + };
1.307 +
1.308 +
1.309 +/**
1.310 +Default compaction mode.
1.311 +@internalComponent
1.312 +*/
1.313 +const TSqlCompactionMode KSqlDefaultCompactionMode = ESqlCompactionBackground;
1.314 +
1.315 +/**
1.316 +Exec free page threshold in Kb, after which the background compaction will be activated.
1.317 +@internalComponent
1.318 +*/
1.319 +const TInt KSqlCompactFreePageThresholdKb = 50;
1.320 +
1.321 +/**
1.322 +One compaction step length in milliseconds.
1.323 +@internalComponent
1.324 +*/
1.325 +const TInt KSqlCompactStepLengthMs = 50;
1.326 +
1.327 +/**
1.328 +Interval in milliseconds between the compaction steps.
1.329 +@internalComponent
1.330 +*/
1.331 +const TInt KSqlCompactStepIntervalMs = 50;
1.332 +
1.333 +////////////////////////////////////////////////////////////////////////////////////////////////////////////
1.334 +
1.335 +/**
1.336 +The db config file version that is initially stored in the system settings table.
1.337 +@internalComponent
1.338 +*/
1.339 +const TInt KSqlNullDbConfigFileVersion = 0;
1.340 +
1.341 +////////////////////////////////////////////////////////////////////////////////////////////////////////////
1.342 +
1.343 +#include "SqlUtil.inl"
1.344 +
1.345 +#endif //__SQLUTIL_H__