CWSafeList.c

/*******************************************************************************************
 * Copyright (c) 2006-7 Laboratorio di Sistemi di Elaborazione e Bioingegneria Informatica *
 *                      Universita' Campus BioMedico - Italy                               *
 *                                                                                         *
 * This program is free software; you can redistribute it and/or modify it under the terms *
 * of the GNU General Public License as published by the Free Software Foundation; either  *
 * version 2 of the License, or (at your option) any later version.                        *
 *                                                                                         *
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY         *
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A 	       *
 * PARTICULAR PURPOSE. See the GNU General Public License for more details.                *
 *                                                                                         *
 * You should have received a copy of the GNU General Public License along with this       *
 * program; if not, write to the:                                                          *
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,                    *
 * MA  02111-1307, USA.                                                                    *
 *                                                                                         *
 * In addition, as a special exception, the copyright holders give permission to link the  *
 * code of portions of this program with the OpenSSL library under certain conditions as   *
 * described in each individual source file, and distribute linked combinations including  * 
 * the two. You must obey the GNU General Public License in all respects for all of the    *
 * code used other than OpenSSL.  If you modify file(s) with this exception, you may       *
 * extend this exception to your version of the file(s), but you are not obligated to do   *
 * so.  If you do not wish to do so, delete this exception statement from your version.    *
 * If you delete this exception statement from all source files in the program, then also  *
 * delete it here.                                                                         *
 * 
 * --------------------------------------------------------------------------------------- *
 * Project:  Capwap                                                                        *
 *                                                                                         *
 * Author :  Ludovico Rossi (ludo@bluepixysw.com)                                          *  
 *           Del Moro Andrea (andrea_delmoro@libero.it)                                    *
 *           Giovannini Federica (giovannini.federica@gmail.com)                           *
 *           Massimo Vellucci (m.vellucci@unicampus.it)                                    *
 *           Mauro Bisson (mauro.bis@gmail.com)                                            *
 *******************************************************************************************/

#include "CWCommon.h"

#ifdef DMALLOC
#include "../dmalloc-5.5.0/dmalloc.h"
#endif

CWBool CWCreateSafeList(CWSafeList* pSafeList)
{
	CWPrivateSafeList* pNewList;

	if (pSafeList == NULL)
		return CW_FALSE;

	CW_CREATE_OBJECT_ERR(pNewList, CWPrivateSafeList, return CW_FALSE;);

	//
	pNewList->pThreadMutex = NULL;
	pNewList->pThreadCond = NULL;

	//
	pNewList->nCount = 0;
	pNewList->pFirstElement = NULL;
	pNewList->pLastElement = NULL;
	
	//
	(*pSafeList) = (CWSafeList)pNewList;
	return CW_TRUE;
}

void CWDestroySafeList(CWSafeList safeList)
{
	CWPrivateSafeList* pList = (CWPrivateSafeList*)safeList;

	if (pList == NULL)
		return;

	//
	CW_FREE_OBJECT(pList);
}

void CWSetMutexSafeList(CWSafeList safeList, CWThreadMutex* pThreadMutex)
{
	CWPrivateSafeList* pList = (CWPrivateSafeList*)safeList;

	if (pList == NULL)
		return;

	pList->pThreadMutex = pThreadMutex;
}

void CWSetConditionSafeList(CWSafeList safeList, CWThreadCondition* pThreadCond)
{
	CWPrivateSafeList* pList = (CWPrivateSafeList*)safeList;

	if (pList == NULL)
		return;

	pList->pThreadCond = pThreadCond;
}

CWBool CWLockSafeList(CWSafeList safeList)
{
	CWPrivateSafeList* pList = (CWPrivateSafeList*)safeList;

	if ((pList == NULL) || (pList->pThreadMutex == NULL))
		return CW_FALSE;

	//
	return CWThreadMutexLock(pList->pThreadMutex);
}

void CWUnlockSafeList(CWSafeList safeList)
{
	CWPrivateSafeList* pList = (CWPrivateSafeList*)safeList;

	if ((pList == NULL) || (pList->pThreadMutex == NULL))
		return;

	//
	CWThreadMutexUnlock(pList->pThreadMutex);
}

CWBool CWWaitElementFromSafeList(CWSafeList safeList)
{
	CWPrivateSafeList* pList = (CWPrivateSafeList*)safeList;

	if ((pList == NULL) || (pList->pThreadMutex == NULL) || (pList->pThreadCond == NULL))
		return CW_FALSE;

	return CWWaitThreadCondition(pList->pThreadCond, pList->pThreadMutex);
}

CWBool CWSignalElementSafeList(CWSafeList safeList)
{
	CWPrivateSafeList* pList = (CWPrivateSafeList*)safeList;

	if ((pList == NULL) || (pList->pThreadCond == NULL))
		return CW_FALSE;

	CWSignalThreadCondition(pList->pThreadCond);
	return CW_TRUE;
}

unsigned long CWGetCountElementFromSafeList(CWSafeList safeList)
{
	CWPrivateSafeList* pList = (CWPrivateSafeList*)safeList;

	if (pList == NULL)
		return 0;
	return pList->nCount;
	
}

// No thread-safe
CWBool CWAddElementToSafeListHead(CWSafeList safeList, void* pData, int nSize)
{
	CWPrivateSafeList* pList = (CWPrivateSafeList*)safeList;
	CWPrivateSafeElement* pNewElement;

	if ((pList == NULL) || (pData == NULL))
		return CW_FALSE;

	CW_CREATE_OBJECT_ERR(pNewElement, CWPrivateSafeElement, return CW_FALSE;);
	pNewElement->pData = pData;
	pNewElement->nSize = nSize;
	pNewElement->pNext = pList->pFirstElement;
	pNewElement->pPrev = NULL;
	if (pList->pFirstElement != NULL)
		pList->pFirstElement->pPrev = pNewElement;

	pList->pFirstElement = pNewElement;
	if (pList->pLastElement == NULL)
		pList->pLastElement = pNewElement;

	pList->nCount++;
	CWSignalElementSafeList(safeList);
	return CW_TRUE;
}

// No thread-safe
void* CWGetHeadElementFromSafeList(CWSafeList safeList, int* pSize)
{
	CWPrivateSafeElement* pElement;
	CWPrivateSafeList* pList = (CWPrivateSafeList*)safeList;

	if ((pList == NULL) || (pList->pFirstElement == NULL))
		return NULL;

	pElement = pList->pFirstElement;

	if (pSize != NULL)
		*pSize = pElement->nSize;

	return pElement->pData;
}

// No thread-safe
void* CWRemoveHeadElementFromSafeList(CWSafeList safeList, int* pSize)
{
	CWPrivateSafeList* pList = (CWPrivateSafeList*)safeList;
	CWPrivateSafeElement* pElement;
	void* pData;

	if ((pList == NULL) || (pList->pFirstElement == NULL))
		return NULL;

	pElement = pList->pFirstElement;
	pList->pFirstElement = pList->pFirstElement->pNext;
	if (pList->pFirstElement == NULL)
		pList->pLastElement = NULL;
	else
		pList->pFirstElement->pPrev = NULL;
	
	pData = pElement->pData;
	if (pSize != NULL)
		*pSize = pElement->nSize;

	CW_FREE_OBJECT(pElement);

	pList->nCount--;
	return pData;
}

// No thread-safe
void* CWRemoveHeadElementFromSafeListwithDataFlag(CWSafeList safeList, int* pSize, CWBool * dataFlag)
{
	CWPrivateSafeList* pList = (CWPrivateSafeList*)safeList;
	CWPrivateSafeElement* pElement;
	void* pData=NULL;

	if ((pList == NULL) || (pList->pFirstElement == NULL))
		return NULL;

	pElement = pList->pFirstElement;
	pList->pFirstElement = pList->pFirstElement->pNext;
	if (pList->pFirstElement == NULL)
		pList->pLastElement = NULL;
	else
		pList->pFirstElement->pPrev = NULL;
	
	pData = pElement->pData;
	*dataFlag = pElement->dataFlag;
	
	if (pSize != NULL)
		*pSize = pElement->nSize;

	CW_FREE_OBJECT(pElement);

	pList->nCount--;
	return pData;
}

// No thread-safe
CWBool CWAddElementToSafeListTail(CWSafeList safeList, void* pData, int nSize)
{
	CWPrivateSafeList* pList = (CWPrivateSafeList*)safeList;
	CWPrivateSafeElement* pNewElement;

	if ((pList == NULL) || (pData == NULL))
		return CW_FALSE;

	CW_CREATE_OBJECT_ERR(pNewElement, CWPrivateSafeElement, return CW_FALSE;);
	pNewElement->pData = pData;
	pNewElement->nSize = nSize;
	pNewElement->pNext = NULL;
	pNewElement->pPrev = pList->pLastElement;
	if (pList->pLastElement != NULL)
		pList->pLastElement->pNext = pNewElement;
	
	pList->pLastElement = pNewElement;
	if (pList->pFirstElement == NULL)
		pList->pFirstElement = pNewElement;

	pList->nCount++;
	CWSignalElementSafeList(safeList);
	return CW_TRUE;
}

CWBool CWAddElementToSafeListTailwitDataFlag(CWSafeList safeList, void* pData, int nSize,CWBool dataFlag)
{
	CWPrivateSafeList* pList = (CWPrivateSafeList*)safeList;
	CWPrivateSafeElement* pNewElement;

	if ((pList == NULL) || (pData == NULL))
		return CW_FALSE;

	CW_CREATE_OBJECT_ERR(pNewElement, CWPrivateSafeElement, return CW_FALSE;);
	pNewElement->pData = pData;
	pNewElement->nSize = nSize;
	pNewElement->dataFlag = dataFlag;
	pNewElement->pNext = NULL;
	pNewElement->pPrev = pList->pLastElement;
	if (pList->pLastElement != NULL)
		pList->pLastElement->pNext = pNewElement;
	
	pList->pLastElement = pNewElement;
	if (pList->pFirstElement == NULL)
		pList->pFirstElement = pNewElement;

	pList->nCount++;
	CWSignalElementSafeList(safeList);
	return CW_TRUE;
}

// No thread-safe
void* CWRemoveTailElementFromSafeList(CWSafeList safeList, int* pSize)
{
	CWPrivateSafeList* pList = (CWPrivateSafeList*)safeList;
	CWPrivateSafeElement* pElement;
	void* pData;

	if ((pList == NULL) || (pList->pLastElement == NULL))
		return NULL;

	pElement = pList->pLastElement;
	pList->pLastElement = pList->pLastElement->pPrev;
	if (pList->pLastElement == NULL)
		pList->pFirstElement = NULL;
	else
		pList->pLastElement->pNext = NULL;
	
	pData = pElement->pData;
	if (pSize != NULL)
		*pSize = pElement->nSize;

	CW_FREE_OBJECT(pElement);

	pList->nCount--;
	return pData;
}

// No thread-safe
void CWCleanSafeList(CWSafeList safeList, void (*deleteFunc)(void *))
{
	void* pData;

	CW_REPEAT_FOREVER
	{
		pData = CWRemoveHeadElementFromSafeList(safeList, NULL);
		if (pData == NULL)
			break;

		if (deleteFunc != NULL)
			deleteFunc(pData);
	}
}