gem5/src/mem/ruby/profiler/AccessTraceForAddress.hh

/*
 * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
 * 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 copyright holders 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
 * OWNER 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.
 */

/*
 * $Id$
 *
 * Description:
 *
 */

#ifndef ACCESSTRACEFORADDRESS_H
#define ACCESSTRACEFORADDRESS_H

#include "mem/ruby/common/Global.hh"
#include "mem/ruby/common/Address.hh"
#include "mem/protocol/CacheRequestType.hh"
#include "mem/protocol/AccessModeType.hh"
#include "mem/ruby/system/NodeID.hh"
#include "mem/ruby/common/Set.hh"
class Histogram;

class AccessTraceForAddress {
public:
  // Constructors
  AccessTraceForAddress();
  explicit AccessTraceForAddress(const Address& addr);

  // Destructor
  ~AccessTraceForAddress();

  // Public Methods

  void update(CacheRequestType type, AccessModeType access_mode, NodeID cpu, bool sharing_miss);
  int getTotal() const;
  int getSharing() const { return m_sharing; }
  int getTouchedBy() const { return m_touched_by.count(); }
  const Address& getAddress() const { return m_addr; }
  void addSample(int value);

  void print(ostream& out) const;
private:
  // Private Methods

  // Private copy constructor and assignment operator
  // AccessTraceForAddress(const AccessTraceForAddress& obj);
  // AccessTraceForAddress& operator=(const AccessTraceForAddress& obj);

  // Data Members (m_ prefix)

  Address m_addr;
  uint64 m_loads;
  uint64 m_stores;
  uint64 m_atomics;
  uint64 m_total;
  uint64 m_user;
  uint64 m_sharing;
  Set m_touched_by;
  Histogram* m_histogram_ptr;
};

bool node_less_then_eq(const AccessTraceForAddress* n1, const AccessTraceForAddress* n2);

// Output operator declaration
ostream& operator<<(ostream& out, const AccessTraceForAddress& obj);

// ******************* Definitions *******************

// Output operator definition
extern inline
ostream& operator<<(ostream& out, const AccessTraceForAddress& obj)
{
  obj.print(out);
  out << flush;
  return out;
}

#endif //ACCESSTRACEFORADDRESS_H