CAQueue.cpp

Go to the documentation of this file.

/*
Copyright (c) 2000, The JAP-Team 
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, 
are permitted provided that the following conditions are met:

  - Redistributions of source code must retain the above copyright notice, 
    this list of conditions and the following disclaimer.

  - Redistributions in binary form must reproduce the above copyright notice, 
    this list of conditions and the following disclaimer in the documentation and/or 
    other materials provided with the distribution.

  - Neither the name of the University of Technology Dresden, Germany nor the names of its contributors 
    may be used to endorse or promote products derived from this software without specific 
    prior written permission. 

  
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS 
OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY 
AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS
BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, 
OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER 
IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE
*/
#include "StdAfx.h"
#ifndef ONLY_LOCAL_PROXY
#include "CAQueue.hpp"
#include "CAMsg.hpp"
#include "CAUtil.hpp"
#include "CAThread.hpp"

CAQueue::~CAQueue()
  {
    clean();
    delete m_pcsQueue;
    m_pcsQueue = NULL;
    delete m_pconvarSize;
    m_pconvarSize = NULL;
  }

SINT32 CAQueue::clean()
  {
    m_pcsQueue->lock();
    while(m_Queue!=NULL)
      {
        delete[] m_Queue->pBuff;
        m_Queue->pBuff = NULL;
        m_lastElem=m_Queue;
        m_Queue=m_Queue->next;
        delete m_lastElem;
      }
/*    while(m_pHeap!=NULL)
      {
        delete[] m_pHeap->pBuff;
        m_lastElem=m_pHeap;
        m_pHeap=m_pHeap->next;
        delete m_lastElem;
      }*/
    m_nQueueSize=0;
    m_lastElem=NULL;
    m_pcsQueue->unlock();
    return E_SUCCESS;
  }
SINT32 CAQueue::add(const void* buff,UINT32 size)
  {
    if(size==0)
      return E_SUCCESS;
    if(buff==NULL)
      return E_UNKNOWN;
    m_pcsQueue->lock();
    //if(m_pHeap==NULL)
    //  incHeap();
#ifdef _DEBUG
//    if(m_nExpectedElementSize>0&&size>(m_nExpectedElementSize<<1))
    /*if(size>1500)
      {
        CAMsg::printMsg(LOG_DEBUG,"CAQueue::add() WARNING: request for add %u bytes in a queue with expected element size of %u bytes !\n",size,m_nExpectedElementSize);
      }*/
#endif
    if(m_Queue==NULL)
      {
        /*m_Queue=m_pHeap;
        m_pHeap=m_pHeap->next;
        if(size>m_nExpectedElementSize)
          {
            delete[] m_Queue->pBuff;
            m_Queue->pBuff=new UINT8[size];
          }*/
        m_Queue=new QUEUE;
        m_Queue->pBuff=new UINT8[size];
        m_Queue->next=NULL;
        m_Queue->index=0;
        m_Queue->size=size;
        memcpy(m_Queue->pBuff,buff,size);
        m_lastElem=m_Queue;
      }
    else
      {
/*        m_lastElem->next=m_pHeap;
        m_lastElem=m_pHeap;
        m_pHeap=m_pHeap->next;
        if(size>m_nExpectedElementSize)
          {
            delete[] m_lastElem->pBuff;
            m_lastElem->pBuff=new UINT8[size];
          }*/
        m_lastElem->next=new QUEUE;
        m_lastElem=m_lastElem->next;
        m_lastElem->pBuff=new UINT8[size];
        m_lastElem->next=NULL;
        m_lastElem->size=size;
        m_lastElem->index=0;
        memcpy(m_lastElem->pBuff,buff,size);
      }
    m_nQueueSize+=size;
#ifdef QUEUE_SIZE_LOG
    if(m_nLogSize!=0 && m_nQueueSize>m_nLogSize)
      {
        CAMsg::printMsg(LOG_DEBUG,"CAQueue::add() WARNING: queue size is now %u bytes which is above the expected maximum size of %u\n !\n",m_nQueueSize,m_nLogSize);
      }
#endif
    m_pcsQueue->unlock();
    m_pconvarSize->lock();
    m_pconvarSize->signal();
    m_pconvarSize->unlock();
    return E_SUCCESS;
  }

SINT32 CAQueue::get(UINT8* pbuff,UINT32* psize)
  {
    if(pbuff==NULL||psize==NULL)
      return E_UNKNOWN;
    if(*psize==0)
      return E_SUCCESS;
    if(m_Queue==NULL)
      {
        *psize=0;
        return E_SUCCESS;
      }
    m_pcsQueue->lock();
    UINT32 space=*psize;
    *psize=0;
    while(space>=m_Queue->size)
      {
        memcpy(pbuff,m_Queue->pBuff+m_Queue->index,m_Queue->size);
        *psize+=m_Queue->size;
        pbuff+=m_Queue->size;
        space-=m_Queue->size;
        m_nQueueSize-=m_Queue->size;
        QUEUE* tmp=m_Queue;
        m_Queue=m_Queue->next;
        //tmp->next=m_pHeap;
        //m_pHeap=tmp;
        delete[] tmp->pBuff;
        tmp->pBuff = NULL;
        delete tmp;
        if(m_Queue==NULL)
          {
            m_pcsQueue->unlock();
            return E_SUCCESS;
          }
      }
    if(space>0)
      {
        memcpy(pbuff,m_Queue->pBuff+m_Queue->index,space);
        *psize+=space;
        m_Queue->size-=space;
        m_Queue->index+=space;
        m_nQueueSize-=space;
        //memmove(m_Queue->pBuff,m_Queue->pBuff+space,m_Queue->size);
      }
    m_pcsQueue->unlock();
    return E_SUCCESS;
  }

SINT32 CAQueue::getOrWait(UINT8* pbuff,UINT32* psize)
  {
    m_pconvarSize->lock();
    while(m_Queue==NULL)
      m_pconvarSize->wait();
    SINT32 ret=get(pbuff,psize);
    m_pconvarSize->unlock();
    return ret;
  }

SINT32 CAQueue::getOrWait(UINT8* pbuff,UINT32* psize,UINT32 msTimeout)
  {
    m_pconvarSize->lock();
    SINT32 ret;
    while(m_Queue==NULL)
      {
        ret=m_pconvarSize->wait(msTimeout);
        if(ret==E_TIMEDOUT)
          {
            m_pconvarSize->unlock();
            return E_TIMEDOUT;
          }
      }   
    ret=get(pbuff,psize);
    m_pconvarSize->unlock();
    return ret;
  }

SINT32 CAQueue::peek(UINT8* pbuff,UINT32* psize)
  {
    if(pbuff==NULL||psize==NULL)
      return E_UNKNOWN;
    if(*psize==0)
      return E_SUCCESS;
    m_pcsQueue->lock();
    UINT32 space=*psize;
    *psize=0;
    if(m_Queue==NULL)
      {
        SINT32 ret=E_SUCCESS;
        if(m_bClosed)
          ret=E_CLOSED;
        m_pcsQueue->unlock();
        return ret;
      }
    QUEUE* tmpQueue=m_Queue;
    while(space>=tmpQueue->size)
      {
        memcpy(pbuff,tmpQueue->pBuff+tmpQueue->index,tmpQueue->size);
        *psize+=tmpQueue->size;
        pbuff+=tmpQueue->size;
        space-=tmpQueue->size;
        tmpQueue=tmpQueue->next;
        if(tmpQueue==NULL)
          {
            m_pcsQueue->unlock();
            return E_SUCCESS;
          }
      }
    memcpy(pbuff,tmpQueue->pBuff+tmpQueue->index,space);
    *psize+=space;
    m_pcsQueue->unlock();
    return E_SUCCESS;
  } 
  
  
SINT32 CAQueue::remove(UINT32* psize)
  {
    if(m_Queue==NULL||psize==NULL)
      return E_UNKNOWN;
    if(*psize==0)
      return E_SUCCESS;
    m_pcsQueue->lock();
    UINT32 space=*psize;
    *psize=0;
    while(space>=m_Queue->size)
      {
        *psize+=m_Queue->size;
        space-=m_Queue->size;
        m_nQueueSize-=m_Queue->size;
        QUEUE* tmp=m_Queue;
        m_Queue=m_Queue->next;
//        tmp->next=m_pHeap;
//        m_pHeap=tmp;
        delete[] tmp->pBuff;
        tmp->pBuff = NULL;
        delete tmp;
        if(m_Queue==NULL)
          {
            m_pcsQueue->unlock();
            return E_SUCCESS;
          }
      }
    if(space>0)
      {
        *psize+=space;
        m_Queue->size-=space;
        m_nQueueSize-=space;
        m_Queue->index+=space;
        //memmove(m_Queue->pBuff,m_Queue->pBuff+space,m_Queue->size);
      }
    m_pcsQueue->unlock();
    return E_SUCCESS;
  }

struct __queue_test
  {
    CAQueue* pQueue;
    UINT8* buff;
    SINT32 len;
  };

THREAD_RETURN producer(void* param)
  {
    struct __queue_test* pTest=(struct __queue_test *)param;
    UINT32 count=0;
    UINT32 aktSize;
    while(pTest->len>10)
        {
          aktSize=rand();
          aktSize%=0xFFFF;
          aktSize%=pTest->len;
          if(pTest->pQueue->add(pTest->buff+count,aktSize)!=E_SUCCESS)
            THREAD_RETURN_ERROR;
          count+=aktSize;
          pTest->len-=aktSize;
          msSleep(rand()%100);
        }
    if(pTest->pQueue->add(pTest->buff+count,pTest->len)!=E_SUCCESS)
      THREAD_RETURN_ERROR;
    THREAD_RETURN_SUCCESS;
  }

THREAD_RETURN consumer(void* param)
  {
    struct __queue_test* pTest=(struct __queue_test *)param;
    UINT32 count=0;
    UINT32 aktSize;
    do
      {
        aktSize=rand();
        aktSize%=0xFFFF;
        if(pTest->pQueue->getOrWait(pTest->buff+count,&aktSize)!=E_SUCCESS)
          THREAD_RETURN_ERROR;
        count+=aktSize;
        pTest->len-=aktSize;
      }while(pTest->len>10);
    THREAD_RETURN_SUCCESS;
  }

SINT32 CAQueue::test()
  {
    CAQueue* pQueue=new CAQueue(1000);
    #define TEST_SIZE 1000000
    UINT8* source=new UINT8[TEST_SIZE];
    UINT8* target=new UINT8[TEST_SIZE];
    getRandom(source,TEST_SIZE);
    UINT32 count=0;
    UINT32 aktSize;
    
    srand((unsigned)time( NULL ));
    
    //Single Thread.....
    //adding
    
    while(TEST_SIZE-count>10000)
        {
          aktSize=rand();
          aktSize%=0xFFFF;
          aktSize%=(TEST_SIZE-count);
          if(pQueue->add(source+count,aktSize)!=E_SUCCESS)
            return E_UNKNOWN;
          count+=aktSize;
          if(pQueue->getSize()!=count)
            return E_UNKNOWN;
        }
    if(pQueue->add(source+count,TEST_SIZE-count)!=E_SUCCESS)
      return E_UNKNOWN;
    if(pQueue->getSize()!=TEST_SIZE)
      return E_UNKNOWN;
    
    //getting
    count=0;
    while(!pQueue->isEmpty())
      {
        aktSize=rand();
        aktSize%=0xFFFF;
        if(pQueue->get(target+count,&aktSize)!=E_SUCCESS)
          return E_UNKNOWN;
        count+=aktSize;
      }
    if(count!=TEST_SIZE)
      return E_UNKNOWN;
    if(memcmp(source,target,TEST_SIZE)!=0)
      return E_UNKNOWN;
    
    //Multiple Threads....
    CAThread* pthreadProducer=new CAThread((UINT8*)"Queue Producer Thread");
    CAThread* pthreadConsumer=new CAThread((UINT8*)"Queue Consumer Thread");
    pthreadProducer->setMainLoop(producer);
    pthreadConsumer->setMainLoop(consumer);
    struct __queue_test t1,t2;
    t1.buff=source;
    t2.buff=target;
    t2.len=t1.len=TEST_SIZE;
    t2.pQueue=t1.pQueue=pQueue;
    pthreadProducer->start(&t1);
    pthreadConsumer->start(&t2);
    pthreadProducer->join();
    pthreadConsumer->join();
    delete pthreadProducer;
    pthreadProducer = NULL;
    delete pthreadConsumer;
    pthreadConsumer = NULL;
    delete pQueue;
    pQueue = NULL;
    if(memcmp(source,target,TEST_SIZE)!=0)
      return E_UNKNOWN;
    
    delete []source;
    source = NULL;
    delete []target;
    target = NULL;
    return E_SUCCESS;
  }
#endif //ONLY_LOCAL_PROXY