// Copyright (c) 2009-2011, The University of British Columbia
// 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 British Columbia 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 COPYRIGHT HOLDER 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.

#ifndef memory_h_INCLUDED
#define memory_h_INCLUDED

#include "../abstract_hardware_model.h"

#ifdef __GNUC__
#if __GNUC__ >= 4 && __GNUC_MINOR__ >= 3
   #include <unordered_map>
   #define mem_map std::unordered_map
   #define MEM_MAP_RESIZE(hash_size) m_data.rehash(hash_size)
#else
   #include <ext/hash_map>
   namespace std {
      using namespace __gnu_cxx;
   }
   #define mem_map std::hash_map
   #define MEM_MAP_RESIZE(hash_size) m_data.resize(hash_size)
#endif
#else
   #include <map>
   #define mem_map std::map
   #define MEM_MAP_RESIZE(hash_size) 
#endif

#include <assert.h>
#include <string.h>
#include <stdio.h>
#include <string>
#include <map>
#include <stdlib.h>

typedef address_type mem_addr_t;

#define MEM_BLOCK_SIZE (4*1024)

template<unsigned BSIZE> class mem_storage {
public:
   mem_storage( const mem_storage &another )
   {
      m_data = (unsigned char*)calloc(1,BSIZE);
      memcpy(m_data,another.m_data,BSIZE);
   }
   mem_storage()
   {
      m_data = (unsigned char*)calloc(1,BSIZE);
   }
   ~mem_storage()
   {
      free(m_data);
   }

   void write( unsigned offset, size_t length, const unsigned char *data )
   {
      assert( offset + length <= BSIZE );
      memcpy(m_data+offset,data,length);
   }

   void read( unsigned offset, size_t length, unsigned char *data ) const
   {
      assert( offset + length <= BSIZE );
      memcpy(data,m_data+offset,length);
   }

   void print( const char *format, FILE *fout ) const
   {
      unsigned int *i_data = (unsigned int*)m_data;
      for (int d = 0; d < (BSIZE / sizeof(unsigned int)); d++) {
         if (d % 8 == 0) {
            fprintf(fout, "\n");
         }
         fprintf(fout, format, i_data[d]);
         fprintf(fout, " ");
      }
      fprintf(fout, "\n");
      fflush(fout);
   }

private:
   unsigned m_nbytes;
   unsigned char *m_data;
};

class ptx_thread_info;
class ptx_instruction;

class memory_space
{
public:
   virtual ~memory_space() {}
   virtual void write( mem_addr_t addr, size_t length, const void *data, ptx_thread_info *thd, const ptx_instruction *pI ) = 0;
   virtual void read( mem_addr_t addr, size_t length, void *data ) const = 0;
   virtual void print( const char *format, FILE *fout ) const = 0;
   virtual void set_watch( addr_t addr, unsigned watchpoint ) = 0;
};

template<unsigned BSIZE> class memory_space_impl : public memory_space {
public:
   memory_space_impl( std::string name, unsigned hash_size );

   virtual void write( mem_addr_t addr, size_t length, const void *data, ptx_thread_info *thd, const ptx_instruction *pI );
   virtual void read( mem_addr_t addr, size_t length, void *data ) const;
   virtual void print( const char *format, FILE *fout ) const;
   virtual void set_watch( addr_t addr, unsigned watchpoint ); 

private:
   void read_single_block( mem_addr_t blk_idx, mem_addr_t addr, size_t length, void *data) const; 
   std::string m_name;
   unsigned m_log2_block_size;
   typedef mem_map<mem_addr_t,mem_storage<BSIZE> > map_t;
   map_t m_data;
   std::map<unsigned,mem_addr_t> m_watchpoints;
};

#endif