cosyfifo.h

Go to the documentation of this file.

/*--------------------------------------------------------------------
 *
 * (C) Copyright Koninklijke Philips Electronics NV 2006. 
 * All rights reserved. This software is licensed under the terms of
 * version 2.1 of the GNU Lesser General Public License as published 
 * by the Free Software Foundation. For licensing and warranty
 * information, see the file COPYING in the main directory.
 *
 *------------------------------------------------------------------*/

#ifndef COSYFIFO_H
#define COSYFIFO_H

#include "rte.h"
#include "rtefifo.h"
#include "bqueue.h"
#include "semaphoreapi.h"
#ifdef PREEMPTIVE
#include "mutexapi.h"
#endif

enum FifoMetric
{
        MinSize, MaxSize,
        Size, Data, Room,
        TokensWritten, TokensRead,
        WriteCalls, ReadCalls,
        TokensPerWrite, TokensPerRead,
        TokenSize,
        BytesWritten, BytesRead,
        PendingWriteTokens, PendingReadTokens,
  NeededWriteTokens, NeededReadTokens
};

class cosySelect;

class cosyFifo : public rteFifo
{

public:
  cosyFifo(FifoImpl& f, cosyRte& r);

  void read(void* p, unsigned int nitems);
  void write(const void* p, unsigned int nitems);
  
  unsigned int size() const;
  unsigned int data() const;
  unsigned int room() const;

private:  
  cosyRte* rte;

  unsigned int minSize;   // minimum size
  unsigned int maxSize;   // maximum size

  unsigned int countw;    // number of tokens written
  unsigned int countr;    // number of tokens read
  unsigned int wcount;    // number of write calls
  unsigned int rcount;    // number of read calls

  static unsigned int defaultMinSize;
  static unsigned int defaultMaxSize;
  static unsigned int defaultBytes;

  static const char* getMetricName(FifoMetric m);
  unsigned int getMetricValue(FifoMetric m);

  unsigned int calcSize(unsigned int lo, unsigned int hi, unsigned int s);

  bool grow();

  bqueue q;
  char* wp;
  char* rp;
  
  unsigned int    wn;     // pending write tokens
  unsigned int    rn;     // pending read tokens

  unsigned int  ws; // select tokens
  unsigned int  rs; // select tokens
  
  bool    block;  // writer blocked
  Semaphore   sema; // binary semaphore

  friend class cosySelect;
  cosySelect* sel;

#ifdef PREEMPTIVE
  Mutex mutex;
  void lock();
  void unlock();
#endif

  friend class cosyNetwork;
};

#endif

---