src/base/fifo_buffer.hh

   1 /*
   2  * Copyright (c) 2002-2005 The Regents of The University of Michigan
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are
   7  * met: redistributions of source code must retain the above copyright
   8  * notice, this list of conditions and the following disclaimer;
   9  * redistributions in binary form must reproduce the above copyright
  10  * notice, this list of conditions and the following disclaimer in the
  11  * documentation and/or other materials provided with the distribution;
  12  * neither the name of the copyright holders nor the names of its
  13  * contributors may be used to endorse or promote products derived from
  14  * this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  20  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  *
  28  * Authors: Steve Raasch
  29  *          Nathan Binkert
  30  */
  31
  32 #ifndef __FIFO_BUFFER_HH__
  33 #define __FIFO_BUFFER_HH__
  34
  35 #include "base/res_list.hh"
  36
  37
  38 //
  39 //  The FifoBuffer requires only that the objects to be used have a default
  40 //  constructor and a dump() method
  41 //
  42 template<class T>
  43 class FifoBuffer
  44 {
  45   public:
  46     typedef typename res_list<T>::iterator iterator;
  47
  48   private:
  49     res_list<T> *buffer;
  50
  51     unsigned size;
  52
  53   public:
  54     FifoBuffer(unsigned sz)
  55     {
  56         buffer = new res_list<T>(sz, true, 0);
  57         size = sz;
  58     }
  59
  60     void add(T &item)
  61     {
  62         assert(buffer->num_free() > 0);
  63         buffer->add_head(item);
  64     }
  65
  66     iterator head() { return buffer->head(); }
  67     iterator tail() { return buffer->tail(); }
  68
  69     unsigned count() {return buffer->count();}
  70     unsigned free_slots() {return buffer->num_free();}
  71
  72     T *peek() { return (count() > 0) ? tail().data_ptr() : 0; }
  73
  74     T remove()
  75     {
  76         assert(buffer->count() > 0);
  77         T rval = *buffer->tail();
  78         buffer->remove_tail();
  79         return rval;
  80     }
  81
  82     void dump();
  83
  84     ~FifoBuffer() { delete buffer; }
  85 };
  86
  87
  88 #endif
  89