sl@0: // Copyright (c) 2005-2010 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: //
sl@0: 
sl@0: #include <e32base.h>
sl@0: #include "IPCBuf.h"
sl@0: #include "SqlAssert.h"
sl@0: #include "SqlDbSession.h"
sl@0: #include "OstTraceDefinitions.h"
sl@0: #ifdef OST_TRACE_COMPILER_IN_USE
sl@0: #include "IPCBufTraces.h"
sl@0: #endif
sl@0: #include "SqlTraceDef.h"
sl@0: 
sl@0: /**
sl@0: Standard, phase-one HIpcBuf factory method.
sl@0: Created HIpcBuf instance will be used for transfering large text or binary objects from/to SQL server.
sl@0: The created HIpcBuf instance will be placed in the cleanup stack.
sl@0: 
sl@0: @param aSession A reference to RSqlDbSession instance.
sl@0: @param aFunction Prepared function code (with all statement handle bits set)
sl@0: @param aArgs A set of IPC arguments to be sent to the SQL server.
sl@0: 
sl@0: @return A pointer to the created HIpcBuf instance
sl@0: 
sl@0: @leave KErrNoMemory Out of memory.
sl@0: */
sl@0: HIpcBuf* HIpcBuf::NewLC(RSqlDbSession& aSession, TInt aFunction, TIpcArgs& aArgs)
sl@0: 	{
sl@0: 	HIpcBuf* self = new (ELeave) HIpcBuf(aSession);
sl@0: 	self->PushL();
sl@0: 	self->ConstructL(aFunction, aArgs);
sl@0: 	return self;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Standard, phase-one HIpcBuf factory method.
sl@0: Created HIpcBuf instance will be used for transfering large text or binary objects from/to SQL server.
sl@0: 
sl@0: @param aSession A reference to RSqlDbSession instance.
sl@0: @param aFunction Prepared function code (with all statement handle bits set)
sl@0: @param aArgs A set of IPC arguments to be sent to the SQL server.
sl@0: 
sl@0: @return A pointer to the created HIpcBuf instance
sl@0: 
sl@0: @leave KErrNoMemory Out of memory.
sl@0: */
sl@0: HIpcBuf* HIpcBuf::NewL(RSqlDbSession& aSession, TInt aFunction, TIpcArgs& aArgs)
sl@0: 	{
sl@0: 	HIpcBuf* self = NewLC(aSession, aFunction, aArgs);
sl@0: 	CleanupStack::Pop();
sl@0: 	return self;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Standard, phase-two HIpcBuf construction method.
sl@0: 
sl@0: @param aFunction The command code which will be sent to the SQL server
sl@0: @param aArgs A set of IPC arguments to be sent to the SQL server.
sl@0: 
sl@0: @leave KErrNoMemory Out of memory.
sl@0: 
sl@0: Usage of the IPC call arguments:
sl@0: Arg 2: [in/out]  IPC buffer
sl@0: iBuf.iExt: [in]  stream size in bytes
sl@0: */
sl@0: void HIpcBuf::ConstructL(TInt aFunction, TIpcArgs& aArgs)
sl@0: 	{
sl@0: 	TPckg<TIpcStreamBuf> pckg(iBuf);
sl@0: 	aArgs.Set(2, &pckg);
sl@0: 	__SQLLEAVE_IF_ERROR(iHandle = iSession.SendReceive(aFunction, aArgs));
sl@0:     SQL_TRACE_INTERNALS(OstTraceExt2(TRACE_INTERNALS, HIPCBUF_CONSTRUCTL, "0x%X;HIpcBuf::ConstructL;iHandle=%d", (TUint)this, iHandle));
sl@0: 	TUint8* base = iBuf.iData;
sl@0: 	// if reading we already have one buffer-full of data
sl@0: 	TInt avail = Max(0, Min(iBuf.iExt, KIpcBufSize));
sl@0: 	SetBuf(ERead, base, base + avail);
sl@0: 	SetPos(ERead, avail);
sl@0: 	SetBuf(EWrite, base, base);
sl@0: 	SetPos(EWrite, 0);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: @param aSession A reference to a sesion object.
sl@0: */
sl@0: HIpcBuf::HIpcBuf(RSqlDbSession& aSession) :
sl@0: 	iSession(aSession),
sl@0: 	iHandle(0),
sl@0: 	iRPos(0),
sl@0: 	iWPos(0)
sl@0: 	{
sl@0: 	iBuf.iExt = -1;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: */
sl@0: HIpcBuf::~HIpcBuf()
sl@0: 	{
sl@0:     SQL_TRACE_INTERNALS(OstTraceExt2(TRACE_INTERNALS, HIPCBUF_HIPCBUFL2, "0x%X;HIpcBuf::~HIpcBuf;iHandle=%d", (TUint)this, iHandle));
sl@0: 	if(iHandle > 0) //iHandle is valid only when > 0.
sl@0: 		{
sl@0: 		(void)iSession.SendReceive(::MakeMsgCode(ESqlSrvStreamClose, ESqlSrvStreamHandle, iHandle));
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Fill the buffer's read area.
sl@0: */
sl@0: TInt HIpcBuf::UnderflowL(TInt)
sl@0: 	{
sl@0: 	// when handle is null there is no data to read from server
sl@0: 	if(!iHandle)
sl@0: 		{
sl@0: 		return 0;
sl@0: 		}
sl@0: 	__ASSERT_DEBUG(Avail(ERead) == 0, __SQLPANIC(ESqlPanicInternalError));
sl@0: 	TUint8* base=iBuf.iData;
sl@0: 	IpcWriteL(base,Lag(EWrite));
sl@0: 	SetBuf(EWrite,base,base);
sl@0: 
sl@0: 	TInt len=IpcReadL(base,iBuf.ESize);
sl@0: 	SetBuf(ERead,base,base+len);
sl@0: 	return len;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Set up the buffer's write area.
sl@0: */
sl@0: void HIpcBuf::OverflowL()
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(Avail(EWrite) == 0, __SQLPANIC(ESqlPanicInternalError));
sl@0: 	
sl@0: 	TUint8* base = iBuf.iData;
sl@0: 	MovePos(ERead, Lag(ERead));
sl@0: 	SetBuf(ERead, base, base);
sl@0: 
sl@0: 	IpcWriteL(base, Lag(EWrite));
sl@0: 	SetBuf(EWrite, base, base + iBuf.ESize);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Destroys HIpcBuf instance.
sl@0: */
sl@0: void HIpcBuf::DoRelease()
sl@0: 	{
sl@0: 	delete this;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Synchronise this buffer with its file, giving up on outstanding writes in case of failure.
sl@0: */
sl@0: void HIpcBuf::DoSynchL()
sl@0: 	{
sl@0: 	TUint8* base = iBuf.iData;
sl@0: 	MovePos(ERead, Lag(ERead));
sl@0: 	TInt lag = Lag(EWrite);
sl@0: 	SetBuf(ERead | EWrite, base, base);
sl@0: 	iBuf.iExt = -1;
sl@0: 	IpcWriteL(base, lag);
sl@0: 	__SQLLEAVE_IF_ERROR(iSession.SendReceive(::MakeMsgCode(ESqlSrvStreamSynch, ESqlSrvStreamHandle, iHandle)));
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Read direct from ipc if asked to transfer more than a bufferful.
sl@0: */
sl@0: TInt HIpcBuf::DoReadL(TAny* aPtr, TInt aMaxLength)
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(aMaxLength > 0, __SQLPANIC(ESqlPanicInternalError));
sl@0: 	TInt avail = Avail(ERead);
sl@0: 	__ASSERT_DEBUG(avail >= 0 && Avail(EWrite) >= 0, __SQLPANIC(ESqlPanicInternalError));
sl@0: 	if(avail > 0)
sl@0: 		{
sl@0: 		TInt len = Min(aMaxLength, avail);
sl@0: 		TUint8* ptr = Ptr(ERead);
sl@0: 		aPtr = Mem::Copy(aPtr, ptr, len);
sl@0: 		SetPtr(ERead, ptr + len);
sl@0: 		aMaxLength -= len;
sl@0: 		if(aMaxLength == 0)
sl@0: 			return len; // that's it
sl@0: 		}
sl@0: 	__ASSERT_DEBUG(Avail(ERead) == 0, __SQLPANIC(ESqlPanicInternalError));
sl@0: 	if(aMaxLength < iBuf.ESize)
sl@0: 		return avail + TStreamBuf::DoReadL(aPtr, aMaxLength);
sl@0: 
sl@0: 	// when handle is null there is no more data to read from server
sl@0: 	if(!iHandle)
sl@0: 		{
sl@0: 		return 0;
sl@0: 		}
sl@0: 
sl@0: 	TUint8* base = iBuf.iData;
sl@0: 	IpcWriteL(base, Lag(EWrite));
sl@0: 	SetBuf(ERead | EWrite, base, base);
sl@0: 	return avail + IpcReadL(aPtr, aMaxLength);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Write direct to ipc if asked to transfer more than a bufferful.
sl@0: */
sl@0: void HIpcBuf::DoWriteL(const TAny* aPtr,TInt aLength)
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(aLength > 0, __SQLPANIC(ESqlPanicInternalError));
sl@0: 	TInt avail = Avail(EWrite);
sl@0: 	__ASSERT_DEBUG(Avail(ERead) >= 0 && avail >= 0, __SQLPANIC(ESqlPanicInternalError));
sl@0: 	if(avail > 0)
sl@0: 		{
sl@0: 		TInt len = Min(aLength, avail);
sl@0: 		SetPtr(EWrite, Mem::Copy(Ptr(EWrite), aPtr, len));
sl@0: 		aLength -= len;
sl@0: 		if(aLength == 0)
sl@0: 			return; // done
sl@0: 
sl@0: 		aPtr = (TUint8*)aPtr + len;
sl@0: 		}
sl@0: 	__ASSERT_DEBUG(Avail(EWrite) == 0, __SQLPANIC(ESqlPanicInternalError));
sl@0: 	if(aLength < iBuf.ESize)
sl@0: 		TStreamBuf::DoWriteL(aPtr, aLength);
sl@0: 	else
sl@0: 		{
sl@0: 		TUint8* base = iBuf.iData;
sl@0: 		IpcWriteL(base, Lag(EWrite));
sl@0: 		MovePos(ERead, Lag(ERead));
sl@0: 		SetBuf(ERead | EWrite, base, base);
sl@0: 		IpcWriteL(aPtr, aLength);
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Position the mark(s) indicated by aMark at aOffset from aLocation.
sl@0: */
sl@0: TStreamPos HIpcBuf::DoSeekL(TMark aMark, TStreamLocation aLocation, TInt aOffset)
sl@0: 	{
sl@0: 	TUint8* base = iBuf.iData;
sl@0: 	TInt end = EndL();
sl@0: 
sl@0: 	switch(aLocation)
sl@0: 		{
sl@0: 	case EStreamBeginning:
sl@0: 		break;
sl@0: 	case EStreamMark:
sl@0: 		switch(aMark)
sl@0: 			{
sl@0: 		case ERead:
sl@0: 			aOffset += Mark(ERead);
sl@0: 			break;
sl@0: 		case EWrite:
sl@0: 			aOffset += Mark(EWrite);
sl@0: 			break;
sl@0: 		default:
sl@0: 		    __ASSERT_ALWAYS(0, __SQLPANIC(ESqlPanicStreamMarkInvalid));
sl@0: 			break;
sl@0: 			}
sl@0: 		break;
sl@0: 	case EStreamEnd:
sl@0: 		aOffset += end;
sl@0: 		break;
sl@0: 	default:
sl@0: 	    __ASSERT_ALWAYS(0, __SQLPANIC(ESqlPanicStreamLocationInvalid));
sl@0: 		break;
sl@0: 		}
sl@0: 	TInt r = KErrNone;
sl@0: 	if(aOffset < 0)
sl@0: 		{
sl@0: 		aOffset = 0;
sl@0: 		r = KErrEof;
sl@0: 		}
sl@0: 	else if(aOffset > end)
sl@0: 		{
sl@0: 		aOffset = end;
sl@0: 		r = KErrEof;
sl@0: 		}
sl@0: 
sl@0: 	__ASSERT_ALWAYS(!(aMark & ~(ERead | EWrite)), __SQLPANIC(ESqlPanicStreamMarkInvalid));
sl@0: 	if(aMark & ERead)
sl@0: 		{
sl@0: 		TInt lag = aOffset - Pos(ERead);
sl@0: 		if(lag >= base - End(ERead) && lag <= 0)
sl@0: 			SetPtr(ERead, End(ERead) + lag);
sl@0: 		else
sl@0: 			{
sl@0: 			SetPos(ERead, aOffset);
sl@0: 			SetBuf(ERead, base, base);
sl@0: 			}
sl@0: 		}
sl@0: 	if(aMark & EWrite && aOffset != Mark(EWrite))
sl@0: 		{
sl@0: 		IpcWriteL(base, Lag(EWrite));
sl@0: 		SetPos(EWrite, aOffset);
sl@0: 		SetBuf(EWrite, base, base);
sl@0: 		}
sl@0: 	__SQLLEAVE_IF_ERROR(r);
sl@0: 	return TStreamPos(aOffset);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Read from the server at the current read position.
sl@0: Arg 0:            not used
sl@0: Arg 1: [out]      from which position to read
sl@0: Arg 2: [in/out]   IPC buffer
sl@0: Arg 3: [out]      max length of the requested data
sl@0: */
sl@0: TInt HIpcBuf::IpcReadL(TAny* aPtr, TInt aMaxLength)
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(aMaxLength >= 0, __SQLPANIC(ESqlPanicInternalError));
sl@0: 	if(aMaxLength == 0)
sl@0: 		return 0;
sl@0: 
sl@0: 	TPtr8 des((TUint8*)aPtr, aMaxLength);
sl@0: 	TInt pos = Pos(ERead);
sl@0: 		
sl@0: 	TInt len = __SQLLEAVE_IF_ERROR(iSession.SendReceive(::MakeMsgCode(ESqlSrvStreamRead, ESqlSrvStreamHandle, iHandle), TIpcArgs(0, pos, &des, aMaxLength)));
sl@0: 	pos += len;
sl@0: 	if(len < aMaxLength)
sl@0: 		iBuf.iExt = pos; // end-of-file encountered
sl@0: 	SetPos(ERead, pos);
sl@0: 	return len;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Write to the server at the current write position.
sl@0: Arg 0:            not used
sl@0: Arg 1: [out]      from which position to write
sl@0: Arg 2: [in/out]   IPC buffer
sl@0: */
sl@0: void HIpcBuf::IpcWriteL(const TAny* aPtr, TInt aLength)
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(aLength >= 0, __SQLPANIC(ESqlPanicInternalError));
sl@0: 	if(aLength == 0)
sl@0: 		return;
sl@0: 
sl@0: 	TPtrC8 ptr((TUint8*)aPtr, aLength);
sl@0: 	TInt ext = iBuf.iExt;
sl@0: 	iBuf.iExt = -1;
sl@0: 	TInt pos = Pos(EWrite);
sl@0: 	__SQLLEAVE_IF_ERROR(iSession.SendReceive(::MakeMsgCode(ESqlSrvStreamWrite, ESqlSrvStreamHandle, iHandle), TIpcArgs(0, pos, &ptr)));
sl@0: 	pos += aLength;
sl@0: 	if(ext >=0 && pos > ext)
sl@0: 		iBuf.iExt = pos;
sl@0: 	SetPos(EWrite, pos);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Determine the end of the stream
sl@0: */
sl@0: TInt HIpcBuf::EndL()
sl@0: 	{
sl@0: 	TInt ext = iBuf.iExt;
sl@0: 	if(ext < 0)
sl@0: 		{
sl@0: 		iBuf.iExt = ext = __SQLLEAVE_IF_ERROR(iSession.SendReceive(::MakeMsgCode(ESqlSrvStreamSize, ESqlSrvStreamHandle, iHandle)));
sl@0: 		}
sl@0: 	return Max(ext, Mark(EWrite));
sl@0: 	}
sl@0: