// Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).

// All rights reserved.

// This component and the accompanying materials are made available

// under the terms of "Eclipse Public License v1.0"

// which accompanies this distribution, and is available

// at the URL "http://www.eclipse.org/legal/epl-v10.html".

//

// Initial Contributors:

// Nokia Corporation - initial contribution.

//

// Contributors:

//

// Description:

// inet.cpp - inet protocol base

//

#include <in_pkt.h>

#include <ext_hdr.h>

#include <comms-infras/nifif.h>

#include <comms-infras/nifif_internal.h>

#include "inet.h"

#include "networkinfo.h"

#include "inet6log.h"

//

//  CProtocolInet6Base

//

//

CProtocolInet6Base::CProtocolInet6Base()

	{

	// Nothing here -- rely on CBase zero fill!

	}

void CProtocolInet6Base::InitL(TDesC& /*aTag*/)

	{

#ifdef _LOG

	// Fetch the protocol name for logging purposes

	TServerProtocolDesc info;

	Identify(&info);

	iName = info.iName;

#endif

	}

void CProtocolInet6Base::BindL(CProtocolBase* /*aProtocol*/, TUint /*aId*/)

	{

	Panic(EInet6Panic_NotSupported);

	}

void CProtocolInet6Base::Unbind(CProtocolBase* /*aProtocol*/, TUint /*aId*/)

	{

	}

void CProtocolInet6Base::StartL()

	{

	}

//

//	*NOTE*

//		In the INET6 stack the Error upcall is passed up from the drivers

//		but, it does not require any actions by default (doing something

//		here is only useful for protocols modules that want to know about

//		changes in the interfaces and possibly doing there own

//		reconfiguring after this (for example, 6to4).

//

//		In INET6 the interface manager takes care of notifying individual

//		flows about the interface changes that affect them. -- msa

//

//	This here is required, because the base CProtocolBase::Error()

//	calls Panic. A similar consideration applies to the StartSending(),

//	but as the CProtocolBase::StartSending() is already a NOP, nothing

//	needs to be done here.

//

void CProtocolInet6Base::Error(TInt /*anError*/, CProtocolBase* /*aSourceProtocol*/)

	{

	}

CProtocolInet6Base::~CProtocolInet6Base()

	{

	// All SAP's should have been detached from this by now!

	ASSERT(iSapCount == 0);

	}

//

// SAP counting

//

void CProtocolInet6Base::IncSAPs()

	{

	iSapCount++;

	}

void CProtocolInet6Base::DecSAPs()

	{

	ASSERT(iSapCount > 0);

	iSapCount--;

	}

//

// SAP database routines

//

void CProtocolInet6Base::BindProvider(CProviderInet6Base* aSAP)

	{

#ifdef _LOG

	TBuf<50> local; aSAP->iFlow.FlowContext()->LocalAddr().OutputWithScope(local);

	TBuf<50> remote; aSAP->iFlow.FlowContext()->RemoteAddr().OutputWithScope(remote);

	Log::Printf(_L("\t%S SAP[%u] BindProvider({%S,%d} <--> {%S,%d})"),

				&ProtocolName(), (TInt)aSAP,

				&local, aSAP->iFlow.FlowContext()->LocalPort(), &remote, aSAP->iFlow.FlowContext()->RemotePort());

#endif

	TUint key = ProviderHashKey(aSAP->iFlow.FlowContext()->LocalPort());

	aSAP->iNextSAP = iSAP[key];

	iSAP[key] = aSAP;

	}

void CProtocolInet6Base::QueueBindProvider(CProviderInet6Base* aSAP)

	{

#ifdef _LOG

	TBuf<50> local; aSAP->iFlow.FlowContext()->LocalAddr().OutputWithScope(local);

	TBuf<50> remote; aSAP->iFlow.FlowContext()->RemoteAddr().OutputWithScope(remote);

	Log::Printf(_L("\t%S SAP[%u] QueueBindProvider(): {%S,%d} <--> {%S,%d}"),

			&ProtocolName(), (TInt)this,

			&local, aSAP->iFlow.FlowContext()->LocalPort(), &remote, aSAP->iFlow.FlowContext()->RemotePort());

#endif

	TUint key = ProviderHashKey(aSAP->iFlow.FlowContext()->LocalPort());

	CProviderInet6Base **sap = &iSAP[key];

	while (*sap != NULL)

		sap = &(*sap)->iNextSAP;

	*sap = aSAP;

	}

void CProtocolInet6Base::UnbindProvider(CProviderInet6Base* aSAP)

	{

	CProviderInet6Base **sapPtr;

	TUint key;

	if (aSAP->iFlow.FlowContext() == NULL)

		return;

	key = ProviderHashKey(aSAP->iFlow.FlowContext()->LocalPort());

	for (sapPtr = &iSAP[key]; *sapPtr != NULL; sapPtr = &((*sapPtr)->iNextSAP))

		if (*sapPtr == aSAP)

			{

#ifdef _LOG

			TBuf<50> local; aSAP->iFlow.FlowContext()->LocalAddr().OutputWithScope(local);

			TBuf<50> remote; aSAP->iFlow.FlowContext()->RemoteAddr().OutputWithScope(remote);

			Log::Printf(_L("\t%S SAP[%u] UnbindProvider({%S,%d} <--> {%S,%d})"),

					&ProtocolName(), (TInt)aSAP,

					&local, aSAP->iFlow.FlowContext()->LocalPort(), &remote, aSAP->iFlow.FlowContext()->RemotePort());

#endif

			*sapPtr = (*sapPtr)->iNextSAP;

			aSAP->iNextSAP = NULL;

			return;

			}

	}

CProviderInet6Base* CProtocolInet6Base::LocateProvider(TUint aPort)

	{

	CProviderInet6Base *sap;

	TUint key = ProviderHashKey(aPort);

	for (sap = iSAP[key]; sap != NULL; sap = sap->iNextSAP)

		if (sap->iFlow.FlowContext()->LocalPort() == aPort)

			return sap;

	return NULL;

	}

void CProviderInet6Base::InitL()

	{

	TInt err = iFlow.Open(iProtocol->NetworkService());

	if (err != KErrNone)

 		User::Leave(err);

	iFlow.SetNotify(this);

	iLastError.iStatus  = KErrNone;

	iLastError.iErrType = 0;

	iLastError.iErrCode = 0;

	iErrorMask          = 0;

	}

void CProviderInet6Base::Start()

	{

#if 0

  // XXX - Setting socket write buffer to 1024 seems to seriously

  // hamper TCP performance over loopback. Default is 4096 and 2048

  // also works ok. Have to look at this later. -ML

  TVersion v = RNif::Version();

  TUint32 ver = (v.iMajor << 24) | (v.iMinor << 16) | v.iBuild;

  if (ver >= 0x01000044)

	Nif::SetSocketState(ENifBuffers1024, this);

#endif

	}

//

//  CProviderInet6Base

//

//

CProviderInet6Base::CProviderInet6Base(CProtocolInet6Base* aProtocol) : iProtocol(aProtocol)

	{

	LOG(Log::Printf(_L("\t%S SAP[%u] New"), &ProtocolName(), (TInt)this));

	iNextSAP = NULL;

	iProtocol->Open();

	iProtocol->IncSAPs();

	if (iIsUser == 0)

		{

		iProtocol->NetworkService()->IncUsers();

		iIsUser = 1;

		}

	}

CProviderInet6Base::~CProviderInet6Base()

	{

	((CProtocolInet6Base*)iProtocol)->UnbindProvider(this);

	CFlowContext *flow = iFlow.FlowContext();

	if (flow) 

		{

		TPckgBuf< TInt > opt(0);  // Currently there is no use for the option parameter

		flow->SetOption(KSOLProvider, KSoFlowClosing, opt);

		}

	iFlow.Close();

	if (iIsUser == 1)

		{

		iProtocol->NetworkService()->DecUsers();

		iIsUser = 0;

		}

	iProtocol->DecSAPs();

	LOG(Log::Printf(_L("\t%S SAP[%u] Deleted"), &ProtocolName(), (TInt)this));

	iProtocol->Close();

	}

void CProviderInet6Base::ActiveOpen()

	{

	Panic(EInet6Panic_NotSupported);

	}

TInt CProviderInet6Base::PassiveOpen(TUint /*aQueSize*/)

	{

	Panic(EInet6Panic_NotSupported);

	return 0;

	}

void CProviderInet6Base::ActiveOpen(const TDesC8& /*aConnectionData*/)

	{

	Panic(EInet6Panic_NotSupported);

	}

TInt CProviderInet6Base::PassiveOpen(TUint /*aQueSize*/,const TDesC8& /*aConnectionData*/)

	{

	Panic(EInet6Panic_NotSupported);

	return 0;

	}

void CProviderInet6Base::Shutdown(TCloseType /*option*/,const TDesC8& /*aDisconnectionData*/)

	{

	Panic(EInet6Panic_NotSupported);

	}

// *NOTE*

//	Why are level KSoInetIfCtrl and KSoInetRtCtrl handled at this

//	level? Why not just let iProtocol->SetOption() handle them (as

//	would be logical)? The reason is KSoInetEnum*/KSoInetNext*, which

//	need a SAP specific context, and that is *NOT* provided by the

//	iProtocol->SetOption interface. However, only these options are

//	handled here, rest of the KSoInetRtCtrl/KSoInetIfCtrl are passed

//	to the protocol -- msa

//

TInt CProviderInet6Base::SetOption(TUint aLevel, TUint aName, const TDesC8& aOption)

	{

	if (aLevel == KSolInetIp)

		{

		// Prefetch the option parameter (error return is ignored,

		// if the option is not implemented at this level).

		TInt val;

		const TInt ret = GetOptionInt(aOption, val);

		switch (aName)

			{

		case KSoHeaderIncluded:

		case KSoRawMode:

			// *note* Need to arrange KErrNotSupported for TCP! -- msa

			// Implementation of setting HeaderIncluded and RawMode options

			if (ret != KErrNone)

				return ret;

			// [The raw/headerincluded logic here is unnecessarily convoluted.

			// In EPOC they could be handled independently, as there is no

			// special priviledges required for setting the raw mode either.

			// But, because it is specified to work in this way, sigh ...

			// -- msa]

			//

			// Only allow setting of iHeaderIncluded when iRawMode is set

			// Clearing is always allowed.

			// When iRawMode==0, then *ALWAYS* iHeaderIncluded == 0

			if (aName == KSoRawMode)

				{

				if (val)

					iRawMode = 1;

				else

					{

					iRawMode = 0;

					iHeaderIncluded = 0;

					}

				}

			else if (val == 0)

				iHeaderIncluded = 0;

			else if (iRawMode)

				{

				iHeaderIncluded = 1;

				}

			else

				return KErrNotSupported; // attempted to set KSoHeaderIncluded without Raw mode

#ifdef _LOG

			Log::Printf(_L("SetOpt\t%S SAP[%u] RawMode=%d HeaderInclude=%d"),

				&ProtocolName(), (TInt)this, iRawMode, iHeaderIncluded);

#endif

			return KErrNone;

		case KSoUserSocket:

			if (ret != KErrNone)

				return ret;

#ifdef _LOG

			Log::Printf(_L("SetOpt\t%S SAP[%u] KSoUserSocket %d -> %d"),

				&ProtocolName(), (TInt)this, iIsUser, val);

#endif

			if ((TUint)val == iIsUser)

				return KErrNone;	// No change in state

			else if (val == 0)

				{

				iProtocol->NetworkService()->DecUsers();

				iIsUser = 0;

				return KErrNone;

				}

			else if (val == 1)

				{

				iProtocol->NetworkService()->IncUsers();

				iIsUser = 1;

				return KErrNone;

				}

			else

				return KErrArgument;

		default:

			// For now, give generic LOG here, but should really log at each implementation -- msa

			LOG(Log::Printf(_L("SetOpt\t%S SAP[%u] level=KSolInetIp name=%d"), &ProtocolName(), (TInt)this, aName));

			break;

			}

		}

	else if (aLevel == KSolInetIfCtrl)

		{

		if (aName == STATIC_CAST(TUint, KSoInetEnumInterfaces))	// See *NOTE* above!

			{

			iInterfaceIndex = 0;

			LOG(Log::Printf(_L("SetOpt\t%S SAP[%u] KSoInetEnumInterfaces"), &ProtocolName(), (TInt)this));

			return KErrNone;

			}

		}

	else if (aLevel == KSolInetRtCtrl)

		{

		if (aName == STATIC_CAST(TUint, KSoInetEnumRoutes))	// See *NOTE* above!

			{

			iRouteIndex = 0;

			LOG(Log::Printf(_L("SetOpt\t%S SAP[%u] KSoInetEnumRoutes"), &ProtocolName(), (TInt)this));

			return KErrNone;

			}

		}

	else if (aLevel == KNifOptLevel)

		{

		return KErrNotSupported;

		}

	if (iFlow.FlowContext())

		{

		const TInt ret = iFlow.FlowContext()->SetOption(aLevel, aName, aOption);

		if (ret != KErrNotSupported)

			return ret;

		}

	return iProtocol->Interfacer()->SetOption(aLevel, aName, aOption, *this);

	}

TInt CProviderInet6Base::GetOption(TUint aLevel, TUint aName, TDes8& aOption) const

	{

	LOG(Log::Printf(_L("GetOpt\t%S SAP[%u] level=%x, name=%x, len=%d"), &iProtocol->ProtocolName(), (TInt)this, aLevel, aName, aOption.Length());)

	if (aLevel == KSolInetIp)

		switch (aName)

		{

		case KSoInetLastError:

			if (STATIC_CAST(TUint, aOption.MaxLength()) >= sizeof(iLastError))

				{

				aOption.SetLength(sizeof(TSoInetLastErr));

				aOption.Copy((TUint8*)&iLastError, sizeof(iLastError));

				return KErrNone;

				}

			return KErrTooBig;

		case KSoHeaderIncluded:

			return SetOptionInt(aOption, iHeaderIncluded);

		case KSoRawMode:

			return SetOptionInt(aOption, iRawMode);

		case KSoUserSocket:

			return SetOptionInt(aOption, iIsUser != 0);

		default:

			break;

		}

	else if (aLevel == KSolInetIfCtrl && aName == STATIC_CAST(TUint, KSoInetNextInterface))	// See *NOTE* above!

		{

		TSoInetInterfaceInfo& opt = *(TSoInetInterfaceInfo*)aOption.Ptr();

		if (STATIC_CAST(TUint, aOption.MaxLength()) < sizeof(TSoInetInterfaceInfo))

			return KErrTooBig;

		(void) new (&opt) TSoInetInterfaceInfo;	// Make sure descriptors are correct.

		aOption.SetLength(sizeof(TSoInetInterfaceInfo));

		((CProviderInet6Base *)this)->iInterfaceIndex = iProtocol->Interfacer()->InterfaceInfo(iInterfaceIndex, opt);

		if (iInterfaceIndex > 0)

			return KErrNone;

		else

			return KErrNotFound;

		}

	else if (aLevel == KSolInetRtCtrl && aName == STATIC_CAST(TUint, KSoInetNextRoute))	// See *NOTE* above!

		{

		TSoInetRouteInfo& opt = *(TSoInetRouteInfo*)aOption.Ptr();

		if (STATIC_CAST(TUint, aOption.MaxLength()) < sizeof(TSoInetRouteInfo))

			return KErrTooBig;

		aOption.SetLength(sizeof(TSoInetRouteInfo));

		(void) new (&opt) TSoInetRouteInfo; // Make sure descriptors are correct.

		((CProviderInet6Base *)this)->iRouteIndex = iProtocol->Interfacer()->RouteInfo(iRouteIndex, opt);

		if (iRouteIndex > 0)

			return KErrNone;

		else

			return KErrNotFound;

		}

	else if (aLevel == KNifOptLevel)

		{

		return KErrNotSupported;

		}

	//

	// if none of the above "supported", falls here...

	//

	CFlowContext *flow = iFlow.FlowContext();

	if (flow)

		{

		const TInt ret = flow->GetOption(aLevel, aName, aOption);

		if (ret != KErrNotSupported)

			return ret;

		}

	return iProtocol->Interfacer()->GetOption(aLevel, aName, aOption, *((CProviderInet6Base *)this));

	}

void CProviderInet6Base::Ioctl(TUint aLevel, TUint aName, TDes8* /*anOption*/)

	{

	LOG(Log::Printf(_L("Ioctl\t%S SAP[%u] %x, %x)"), &ProtocolName(), (TInt)this, aLevel, aName));

	if (aLevel == KSolInetIp && aName == KIoctlInetLastError)

		{

		TPckg<TSoInetLastErr> lastError(iLastError);

		iSocket->IoctlComplete(&lastError);

		}

	else

		Error(KErrNotSupported, MSocketNotify::EErrorIoctl);

	}

void CProviderInet6Base::CancelIoctl(TUint aLevel, TUint aName)

	{

#ifdef _LOG

	Log::Printf(_L("CancelIoctl\t%S SAP[%u] %x, %x)"), &ProtocolName(), (TInt)this, aLevel, aName);

#else

	(void)aLevel;	// silence compiler warning

	(void)aName;	// silence compiler warning

#endif

	// Error call removed. Fixes defect IP/76. -MikaL

	//Error(KErrNotSupported);

	}

void CProviderInet6Base::Process(RMBufChain& /*aPacket*/, CProtocolBase* /*aSourceProtocol*/)

	{

	Panic(EInet6Panic_NotSupported);

	}

//

// Error report routine.

//

// Soft errors are not immediately reported to the socket server.

// A soft error is indicated by a zero aOperationMask.

//

// The socket error can be cleared by calling this routing with

// aError == KErrNone.

//

void CProviderInet6Base::Error(TInt aError, TUint aOperationMask)

	{

	if (aError <= KErrNone && !FatalState())

		{

		iLastError.iStatus = aError;

		if (aError == KErrNone)

			iErrorMask = aOperationMask;